Send Message imbot.message.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: imbot

Who can execute the method: an authorized user of the application that registered the chat bot. The method only works with bots of this application.

DEPRECATED

The development of this method has been halted. Please use imbot.v2.Chat.Message.send.

The method imbot.message.add sends a message from the chat bot.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
BOT_ID `integer`	The identifier of the chat bot. You can obtain the bot ID using the method imbot.bot.list. If the parameter is not provided, the method searches for the first bot registered by the current application.
DIALOG_ID `string`	The identifier of the object that will receive the message: user or chat. Supported formats: `USER_ID` — the identifier of the user, which can be obtained via user.get or user.search `chatXXX`, where `XXX` is the chat identifier, which can be obtained via imbot.chat.get This parameter is required if both `FROM_USER_ID` and `TO_USER_ID` are not provided.
FROM_USER_ID `integer`	The identifier of the sender for sending in a private dialog. You can obtain the user ID using user.get and user.search. Used only with `TO_USER_ID`. If both parameters are provided and greater than `0`, the `DIALOG_ID` field is ignored, and `SYSTEM` is forcibly set to `Y`.
TO_USER_ID `integer`	The identifier of the recipient for sending in a private dialog. You can obtain the user ID using user.get and user.search. Used only with `FROM_USER_ID`.
MESSAGE* `string`	The text of the message. The method automatically trims spaces and line breaks from the edges of the message text.
ATTACH `object` `string`	An attachment containing content blocks: images, links, files. You can pass: a JSON string an object with the root key `BLOCKS` an array of blocks without wrapping For more details, refer to the section Attachments.
KEYBOARD `object` `string`	Buttons under the message that the user can interact with. For more details, refer to the article Working with Keyboards.
MENU `object` `string`	Additional items in the chat's context menu. For more details, refer to the article Context Menu.
SYSTEM `string`	Indicator of a system message. Allowed values: `Y` — system message `N` — regular message, default value In `FROM_USER_ID` + `TO_USER_ID` mode, the value is forcibly set to `Y`.
URL_PREVIEW `string`	Controls the display of links: when enabled, the link is shown as a "rich link" with a card. Allowed values: `Y` — enabled, default `N` — disabled
SKIP_CONNECTOR `string`	Skip sending the message to external connectors of open channels. Allowed values: `Y` — skip `N` — do not skip (default)
CLIENT_ID `string`	This parameter is required only for webhooks. Pass the same CLIENT_ID that was specified when registering the chat bot.

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","MESSAGE":"Message text","SYSTEM":"N","URL_PREVIEW":"Y","CLIENT_ID":"**put_your_client_id_here**"}' /
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.message.add

curl -X POST /
          -H "Content-Type: application/json" /
          -H "Accept: application/json" /
          -d '{"BOT_ID":39,"DIALOG_ID":"chat123","MESSAGE":"Message text","auth":"**put_access_token_here**"}' /
          https://**put_your_bitrix24_address**/rest/imbot.message.add

try {
          const response = await $b24.callMethod('imbot.message.add', {
            BOT_ID: 39,
            DIALOG_ID: 'chat123',
            MESSAGE: 'Message text',
            URL_PREVIEW: 'Y',
          });
        
          const { result } = response.getData();
          console.log('Created message ID:', result);
        } catch (error) {
          console.error('Error sending message:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.message.add',
                    [
                        'BOT_ID' => 39,
                        'DIALOG_ID' => 'chat123',
                        'MESSAGE' => 'Message text',
                        'URL_PREVIEW' => 'Y',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Created message ID: ' . $result->data();
            }
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error sending message: ' . $exception->getMessage();
        }

BX24.callMethod(
            'imbot.message.add',
            {
                BOT_ID: 39,
                DIALOG_ID: 'chat123',
                MESSAGE: 'Message text',
                URL_PREVIEW: 'Y',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.message.add',
            [
                'BOT_ID' => 39,
                'DIALOG_ID' => 'chat123',
                'MESSAGE' => 'Message text',
                'URL_PREVIEW' => 'Y',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Created message ID: ' . $result['result'];
        }

Response Handling

HTTP Code: 200

{
            "result": 19880117,
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00",
                "operating_reset_at": 1762349466,
                "operating": 0
            }
        }

Returned Data

Name `Type`	Description
result `integer`	The identifier of the created message.
time `time`	Information about the execution time of the request.

Error Handling

HTTP Status: 400

{
            "error": "MESSAGE_EMPTY",
            "error_description": "Message can't be 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

Code	Description	Value
`BOT_ID_ERROR`	Bot not found	The bot is not found or the application does not have an available bot for auto-completion of `BOT_ID`.
`APP_ID_ERROR`	Bot was installed by another REST application	The provided `BOT_ID` belongs to another application.
`DIALOG_ID_EMPTY`	Dialog ID can't be empty	A valid `DIALOG_ID` was not provided if the pair `FROM_USER_ID` and `TO_USER_ID` is not used.
`MESSAGE_EMPTY`	Message can't be empty	No message text was provided.
`ATTACH_OVERSIZE`	You have exceeded the maximum allowable size of attach	The allowable size of `ATTACH` has been exceeded — 30 KB.
`ATTACH_ERROR`	Incorrect attach params	Invalid structure of `ATTACH`.
`KEYBOARD_ERROR`	Incorrect keyboard params	Invalid structure of `KEYBOARD`.
`KEYBOARD_OVERSIZE`	You have exceeded the maximum allowable size of keyboard	The allowable size of `KEYBOARD` has been exceeded — 30 KB.
`MENU_ERROR`	Incorrect menu params	Invalid structure of `MENU`.
`MENU_OVERSIZE`	You have exceeded the maximum allowable size of menu	The allowable size of `MENU` has been exceeded — 30 KB.
`WRONG_REQUEST`	Message isn't added	Internal error while adding the message.

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Overview of Methods

Edit Sent Message

Send Message imbot.message.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning