Send Messages to Bitrix24 imconnector.send.messages

Scope: imopenlines

Who can execute the method: any user

The method imconnector.send.messages accepts messages from an external system and forwards them to an open line in Bitrix24 via a custom connector.

The method parameters utilize values from the external system: user ID, chat ID, chat link, and its name in the application that registered the connector.

Upon execution, the method returns the chat ID and the open line dialog ID created in Bitrix24.

The method works only in the context of an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CONNECTOR* `string`	The string code of the connector specified in the `ID` parameter when calling imconnector.register
LINE* `integer`	The ID of the open line. The ID can be obtained using the methods imopenlines.config.get and imopenlines.config.list.get
MESSAGES* `array`	An array of messages. Each element of the array is a single message in the object format with three required blocks: `user`, `message`, `chat`. The structure of the object is described in detail below

MESSAGES Parameter

Name `type`	Description
user `object`	User data from the external system. The structure of the object is described in detail below
message `object`	Message data from the external system. The structure of the object is described in detail below
chat `object`	Chat data from the external system. The structure of the object is described in detail below

User Object

Name `type`	Description
id* `string`	User ID in the external system. The value is generated on the side of the external system
last_name `string`	User's last name
name `string`	User's first name
picture `object`	User's avatar. Pass as an object with the `url` field, for example, `{"url":"https://example.com/u42.png"}`. The link must be public
url `string`	Link to the user's profile in the external system
gender `string`	User's gender. Supported values are `male` and `female`
email `string`	User's email
phone `string`	User's phone
skip_phone_validate `string`	Disables phone validation before saving in CRM. Acceptable value is `Y`. If validation should be performed, do not pass this parameter

The name and last_name fields can contain letters, spaces, hyphens, and apostrophes. Numbers and other special characters are not allowed. The maximum length for name and last_name is 25 characters. The language and case can be any.

The skip_phone_validate parameter is recommended to be used only in rare cases when the number fails the built-in validation. This is a workaround to bypass the phone validator's limitations. In a typical scenario, pass the phone without this parameter.

Message Object

Name `type`	Description
id `string`	Message ID in the external system. The value is generated on the side of the external system
date `integer`	Message time in Unix Timestamp in seconds
text `string`	Message text. You must pass either the `text` or `files` element. For acceptable formatting, refer to the article Formatting
files `array`	An array of files. Each file is passed as an array of the form `array('url' => 'File link', 'name' => 'File name')`. The `url` link must be accessible from Bitrix24. The format of the transmitted file is not restricted. In chat, the attachment can be displayed as an image for types: `jpe`, `jpg`, `jpeg`, `png`, `webp`, `gif`, `bmp`
disable_crm `string`	Disables the CRM tracker for the message. Acceptable value is `Y`. If the CRM tracker should work, do not pass this parameter
user_id `integer`	The ID of the manager in Bitrix24. If `user_id` is passed, the message will be sent on behalf of this manager

Chat Object

Name `type`	Description
id* `string`	Chat or channel ID in the external system. It is recommended to pass the same value as in `DATA.ID` of the method imconnector.connector.data.set
name `string`	Chat or channel name. It is recommended to use the value from `DATA.NAME`
url `string`	Link to the chat or channel in the external system. It is recommended to use the value from `DATA.URL`

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "CONNECTOR": "myconnector",
            "LINE": 107,
            "MESSAGES": [
              {
                "user": {
                  "id": "ext-user-42",
                  "last_name": "Smith",
                  "name": "John",
                  "picture": {"url": "https://example.com/u42.png"},
                  "url": "https://example.com/users/42",
                  "gender": "male",
                  "email": "john@example.com",
                  "phone": "+19990000000",
                  "skip_phone_validate": "Y"
                },
                "message": {
                  "id": "ext-msg-1001",
                  "date": 1773265993,
                  "text": "Good afternoon",
                  "files": [
                    {"url": "https://example.com/files/spec.pdf", "name": "spec.pdf"}
                  ],
                  "disable_crm": "Y"
                },
                "chat": {
                  "id": "channel-123",
                  "name": "Support Channel",
                  "url": "https://example.com/chats/123"
                }
              }
            ],
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/imconnector.send.messages

const payload = {
          CONNECTOR: 'myconnector',
          LINE: 107,
          MESSAGES: [
            {
              user: {
                id: 'ext-user-42',
                last_name: 'Smith',
                name: 'John',
                picture: { url: 'https://example.com/u42.png' },
                url: 'https://example.com/users/42',
                gender: 'male',
                email: 'john@example.com',
                phone: '+19990000000',
                skip_phone_validate: 'Y',
              },
              message: {
                id: 'ext-msg-1001',
                date: 1773265993,
                text: 'Good afternoon',
                files: [{ url: 'https://example.com/files/spec.pdf', name: 'spec.pdf' }],
                disable_crm: 'Y',
              },
              chat: {
                id: 'channel-123',
                name: 'Support Channel',
                url: 'https://example.com/chats/123',
              },
            },
          ],
        };
        
        const response = await $b24.callMethod('imconnector.send.messages', payload);
        console.log(response.getData());

$result = $b24Service->core->call(
            'imconnector.send.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => [
                            'id' => 'ext-user-42',
                            'last_name' => 'Smith',
                            'name' => 'John',
                            'picture' => ['url' => 'https://example.com/u42.png'],
                            'url' => 'https://example.com/users/42',
                            'gender' => 'male',
                            'email' => 'john@example.com',
                            'phone' => '+19990000000',
                            'skip_phone_validate' => 'Y',
                        ],
                        'message' => [
                            'id' => 'ext-msg-1001',
                            'date' => 1773265993,
                            'text' => 'Good afternoon',
                            'files' => [
                                ['url' => 'https://example.com/files/spec.pdf', 'name' => 'spec.pdf'],
                            ],
                            'disable_crm' => 'Y',
                        ],
                        'chat' => [
                            'id' => 'channel-123',
                            'name' => 'Support Channel',
                            'url' => 'https://example.com/chats/123',
                        ],
                    ],
                ],
            ]
        );

BX24.callMethod(
          'imconnector.send.messages',
          {
            CONNECTOR: 'myconnector',
            LINE: 107,
            MESSAGES: [
              {
                user: {
                  id: 'ext-user-42',
                  last_name: 'Smith',
                  name: 'John',
                  picture: { url: 'https://example.com/u42.png' },
                  url: 'https://example.com/users/42',
                  gender: 'male',
                  email: 'john@example.com',
                  phone: '+19990000000',
                  skip_phone_validate: 'Y',
                },
                message: {
                  id: 'ext-msg-1001',
                  date: 1773265993,
                  text: 'Good afternoon',
                  files: [{ url: 'https://example.com/files/spec.pdf', name: 'spec.pdf' }],
                  disable_crm: 'Y',
                },
                chat: {
                  id: 'channel-123',
                  name: 'Support Channel',
                  url: 'https://example.com/chats/123',
                },
              },
            ],
          },
          function(result) {
            console.log(result.data());
          }
        );

$result = CRest::call(
            'imconnector.send.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => [
                            'id' => 'ext-user-42',
                            'last_name' => 'Smith',
                            'name' => 'John',
                            'picture' => ['url' => 'https://example.com/u42.png'],
                            'url' => 'https://example.com/users/42',
                            'gender' => 'male',
                            'email' => 'john@example.com',
                            'phone' => '+19990000000',
                            'skip_phone_validate' => 'Y',
                        ],
                        'message' => [
                            'id' => 'ext-msg-1001',
                            'date' => 1773265993,
                            'text' => 'Good afternoon',
                            'files' => [
                                ['url' => 'https://example.com/files/spec.pdf', 'name' => 'spec.pdf'],
                            ],
                            'disable_crm' => 'Y',
                        ],
                        'chat' => [
                            'id' => 'channel-123',
                            'name' => 'Support Channel',
                            'url' => 'https://example.com/chats/123',
                        ],
                    ],
                ],
            ]
        );

Response Handling

HTTP Status: 200

{
            "result": {
                "SUCCESS": true,
                "DATA": {
                    "RESULT": [
                        {
                            "user": "585",
                            "message": {
                                "id": "ext-msg-1001",
                                "date": {},
                                "text": "Good afternoon",
                                "files": []
                            },
                            "chat": {
                                "id": "channel-123",
                                "name": "Support Channel",
                                "description": "Link to the original post: https://example.com/chats/123"
                            },
                            "extra": {
                                "skip_phone_validate": "Y",
                                "disable_tracker": "Y"
                            },
                            "SUCCESS": true,
                            "session": {
                                "ID": "323",
                                "CHAT_ID": "1767"
                            }
                        }
                    ]
                }
            },
            "time": {
                "start": 1773265993,
                "finish": 1773265994.487149,
                "duration": 1.4871490001678467,
                "processing": 1,
                "date_start": "2026-03-11T13:53:13+01:00",
                "date_finish": "2026-03-11T13:53:14+01:00",
                "operating_reset_at": 1773266593,
                "operating": 1.1916680335998535
            }
        }

Returned Data

Name `type`	Description
SUCCESS `boolean`	Returns `true` if the message was sent successfully
DATA `object`	Data containing information about the sent messages. The structure of the object is described in detail below
time `time`	Information about the request execution time

DATA Object

Name
type

Description

RESULT
array

An array of results for each element of MESSAGES.

The structure of the element is described in detail below

RESULT[] Object

Name `type`	Description
user `string`	Internal user ID in Bitrix24
message `object`	Message data after processing (detailed description)
chat `object`	Chat data after processing (detailed description)
extra `object`	Additional flags for message processing (detailed description)
SUCCESS `boolean`	Indicates successful processing of the current array element
ERRORS `array`	An array of error texts for the current element, returned when `SUCCESS = false`
session `object`	Information about the open line session, returned if available (detailed description)

Message Object

Name `type`	Description
id `string`	External message ID
date `object`	Date of the message after processing
text `string`	Message text
files `array`	An array of message files

Chat Object

Name `type`	Description
id `string`	Chat or channel ID
name `string`	Chat or channel name
description `string`	Description of the chat, such as a link to the original post

Extra Object

Name `type`	Description
skip_phone_validate `string`	Indicates phone validation is disabled, returned when the value is `Y`
disable_tracker `string`	Indicates the CRM tracker is disabled, returned when the value is `Y`

Session Object

Name `type`	Description
ID `string`	Open line session ID
CHAT_ID `string`	Chat ID in Bitrix24

Error Handling

HTTP Status: 400, 403

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'MESSAGES' is null or empty"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	Method called not in the context of an application OAuth
`400`	`ERROR_ARGUMENT`	Argument 'CONNECTOR' is null or empty	`CONNECTOR` not provided
`400`	`ERROR_ARGUMENT`	Argument 'LINE' is null or empty	`LINE` not provided
`400`	`ERROR_ARGUMENT`	Argument 'MESSAGES' is null or empty	`MESSAGES` not provided
`400`	`ERROR_ARGUMENT`	The value of an argument 'MESSAGES' must be of type array	`MESSAGES` not passed as an array
`400`	`ERROR_ARGUMENT`	The MESSAGES parameter must be an array of messages (arrays)	Elements of `MESSAGES` not passed as arrays
`400`	`ERROR_ARGUMENT`	The incorrect structure of a message inside MESSAGES parameter	The `MESSAGES` element is missing `user`, `message`, or `chat`
`400`	`NOT_ACTIVE_LINE`	The line with this ID is inactive or does not exist	An inactive `LINE` was passed
`400`	`IMCONNECTOR_NO_CORRECT_PROVIDER`	Failed to find a suitable provider for the connector	Unable to initialize the provider for the connector
`400`	`IMCONNECTOR_NOT_SPECIFIED_CORRECT_COMMAND`	No valid command specified	Unable to determine the command for processing incoming data

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Unregister a Connector

Modify Sent Messages

Send Messages to Bitrix24 imconnector.send.messages

Method ParametersMethod Parameters

MESSAGES ParameterMESSAGES Parameter

User ObjectUser Object

Message ObjectMessage Object

Chat ObjectChat Object

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

DATA ObjectDATA Object

RESULT[] ObjectRESULT[] Object

Message ObjectMessage Object

Chat ObjectChat Object

Extra ObjectExtra Object

Session ObjectSession Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Method Parameters

MESSAGES Parameter

User Object

Message Object

Chat Object

Code Examples

Response Handling

Returned Data

DATA Object

RESULT[] Object

Message Object

Chat Object

Extra Object

Session Object

Error Handling

Possible Error Codes

Statuses and System Error Codes

Continue Learning