Send Messages to Bitrix24 imconnector.send.messages

Choose a tool for developing with an AI agent:

use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

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 represents 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 it 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 fields name and last_name 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 you pass `user_id`, 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)

JS (TS)

JS (UMD)

Python

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": "Ivanov",
                  "name": "Ivan",
                  "picture": {"url": "https://example.com/u42.png"},
                  "url": "https://example.com/users/42",
                  "gender": "male",
                  "email": "ivan@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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type SendMessagesResult = {
          SUCCESS: boolean
          DATA: {
            RESULT: Array<{
              user: string
              message: {
                id: string
                date: object
                text: string
                files: unknown[]
              }
              chat: {
                id: string
                name: string
                description: string
              }
              extra: {
                skip_phone_validate?: string
                disable_tracker?: string
              }
              SUCCESS: boolean
              ERRORS?: string[]
              session?: {
                ID: string
                CHAT_ID: string
              }
            }>
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<SendMessagesResult>({
            method: 'imconnector.send.messages',
            params: {
              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: '+499990000000',
                    skip_phone_validate: 'Y',
                  },
                  message: {
                    id: 'ext-msg-1001',
                    date: 1773265993,
                    text: 'Hello',
                    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',
                  },
                },
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Success:', result.SUCCESS, 'Sessions:', result.DATA.RESULT.map(r => r.session?.CHAT_ID))
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function sendMessages() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'imconnector.send.messages',
                params: {
                  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: '+499990000000',
                        skip_phone_validate: 'Y',
                      },
                      message: {
                        id: 'ext-msg-1001',
                        date: 1773265993,
                        text: 'Hello',
                        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',
                      },
                    },
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Success:', result.SUCCESS, 'Sessions:', result.DATA.RESULT.map(r => r.session?.CHAT_ID))
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', sendMessages)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.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": "+499990000000",
                            "skip_phone_validate": "Y",
                        },
                        "message": {
                            "id": "ext-msg-1001",
                            "date": 1773265993,
                            "text": "Hello",
                            "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
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")

$result = $b24Service->core->call(
            'imconnector.send.messages',
            [
                'CONNECTOR' => 'myconnector',
                'LINE' => 107,
                'MESSAGES' => [
                    [
                        'user' => [
                            'id' => 'ext-user-42',
                            'last_name' => 'Ivanov',
                            'name' => 'Ivan',
                            'picture' => ['url' => 'https://example.com/u42.png'],
                            'url' => 'https://example.com/users/42',
                            'gender' => 'male',
                            'email' => 'ivan@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: 'Ivanov',
                  name: 'Ivan',
                  picture: { url: 'https://example.com/u42.png' },
                  url: 'https://example.com/users/42',
                  gender: 'male',
                  email: 'ivan@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' => 'Ivanov',
                            'name' => 'Ivan',
                            'picture' => ['url' => 'https://example.com/u42.png'],
                            'url' => 'https://example.com/users/42',
                            'gender' => 'male',
                            'email' => 'ivan@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',
                        ],
                    ],
                ],
            ]
        );

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imconnector.send.messages", b24.Params{
        	"CONNECTOR": "myconnector",
        	"LINE":      107,
        	"MESSAGES": []b24.Params{
        		{
        			"user": b24.Params{
        				"id":        "ext-user-42",
        				"last_name": "Ivanov",
        				"name":      "Ivan",
        				"picture": b24.Params{
        					"url": "https://example.com/u42.png",
        				},
        				"url":                 "https://example.com/users/42",
        				"gender":              "male",
        				"email":               "klaus@example.com",
        				"phone":               "+499990000000",
        				"skip_phone_validate": "Y",
        			},
        			"message": b24.Params{
        				"id":   "ext-msg-1001",
        				"date": 1773265993,
        				"text": "Good afternoon",
        				"files": []b24.Params{
        					{
        						"url":  "https://example.com/files/spec.pdf",
        						"name": "spec.pdf",
        					},
        				},
        				"disable_crm": "Y",
        			},
        			"chat": b24.Params{
        				"id":   "channel-123",
        				"name": "Support Channel",
        				"url":  "https://example.com/chats/123",
        			},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("imconnector.send.messages: %w", err)
        }
        
        var item struct {
        	Success bool `json:"SUCCESS"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.Success)

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+02:00",
                "date_finish": "2026-03-11T13:53:14+02: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`	Message date 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, e.g., 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status	Code	Description	Value
`403`	`WRONG_AUTH_TYPE`	Current authorization type is denied for this method Application context required	The method was called outside the application context 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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Was the article helpful?

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

Was the article helpful?

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