Send an Automatic Message in the imopenlines.bot.session.message.send Dialog

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: imopenlines, imbot

Who can execute the method: any user

The method imopenlines.bot.session.message.send sends an automatic message from the application chatbot to the open line dialog.

Method Parameters

Required parameters are marked with *

Name
type

Description

CHAT_ID*
integer

The identifier of the chat to which the method sends the message.

The chat identifier can be obtained using the methods imopenlines.dialog.get or imopenlines.crm.chat.get

NAME
string

The code for the auto-response type.

Allowed values:

  • WELCOME — sends an automatic greeting from the Open Line settings; the MESSAGE parameter is ignored in this mode
  • DEFAULT — sends the text from the MESSAGE parameter

MESSAGE
string

The message text for the NAME=DEFAULT mode. By default, an empty string is used.

If NAME=DEFAULT is passed with an empty MESSAGE, no new message will be added to the chat

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"NAME":"DEFAULT","MESSAGE":"Hello! How can I assist you?"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.bot.session.message.send
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"CHAT_ID":112,"NAME":"DEFAULT","MESSAGE":"Hello! How can I assist you?","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/imopenlines.bot.session.message.send
        
try {
          const response = await $b24.callMethod('imopenlines.bot.session.message.send', {
            CHAT_ID: 112,
            NAME: 'DEFAULT',
            MESSAGE: 'Hello! How can I assist you?',
          });
        
          const { result } = response.getData();
          console.log('Auto message sent:', result);
        } catch (error) {
          console.error('Error sending auto message:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.bot.session.message.send',
                    [
                        'CHAT_ID' => 112,
                        'NAME' => 'DEFAULT',
                        'MESSAGE' => 'Hello! How can I assist you?',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Auto message sent: ' . var_export($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error sending auto message: ' . $exception->getMessage();
        }
        
BX24.callMethod(
            'imopenlines.bot.session.message.send',
            {
                CHAT_ID: 112,
                NAME: 'DEFAULT',
                MESSAGE: 'Hello! How can I assist you?',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.bot.session.message.send',
            [
                'CHAT_ID' => 112,
                'NAME' => 'DEFAULT',
                'MESSAGE' => 'Hello! How can I assist you?',
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            echo 'Auto message sent: ' . var_export($result['result'], true);
        }

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1728626400.456,
                "finish": 1728626400.539,
                "duration": 0.083,
                "processing": 0.031,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00",
                "operating": 0
            }
        }

Returned Data

Name
type

Description

result
boolean

Flag indicating the successful call of the method. The method does not return an indication of the actual creation of the message in the chat

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400, 403

{
            "error": "CHAT_ID_EMPTY",
            "error_description": "Chat ID 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

Status

Code

Description

Value

400

CHAT_ID_EMPTY

Chat ID can't be empty

CHAT_ID not provided or value <= 0 provided

403

WRONG_AUTH_TYPE

Access for this method not allowed by session authorization

Method called with session authorization for which it is prohibited

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

Previous
Overview of Methods
Next
Switch the Dialogue to an Available Operator