Send a message to the open channel imopenlines.crm.message.add

Scope: imopenlines

Who can execute the method: any user

The method imopenlines.crm.message.add sends a message on behalf of an employee or bot in a chat linked to a CRM entity.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
CRM_ENTITY_TYPE* `string`	Type of the CRM object: lead — lead deal — deal company — company contact — contact
CRM_ENTITY* `integer`	Identifier of the CRM entity linked to the chat. A list of entities of a specific CRM object type can be obtained using the method crm.item.list
USER_ID* `integer`	Identifier of the message sender — user or bot, who must be a participant in the chat. The user ID can be obtained using the method user.get or user.search. A list of chat bots can be obtained using the method imbot.bot.list
CHAT_ID* `integer`	Identifier of the open channel chat linked to the CRM entity. The chat ID can be obtained using the method imopenlines.crm.chat.get or imopenlines.dialog.get
MESSAGE* `string`	The text of the message that will be displayed in the chat

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 '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1195,"USER_ID":27,"CHAT_ID":1341,"MESSAGE":"Message text"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.message.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1195,"USER_ID":27,"CHAT_ID":1341,"MESSAGE":"Message text","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/imopenlines.crm.message.add

try {
          const response = await $b24.callMethod(
            'imopenlines.crm.message.add',
            {
              CRM_ENTITY_TYPE: 'lead',
              CRM_ENTITY: 1195,
              USER_ID: 27,
              CHAT_ID: 1341,
              MESSAGE: 'Message text',
            }
          );
        
          const { result } = response.getData();
          console.log('Created message:', result);
        } catch (error) {
          console.error('Error sending message:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'imopenlines.crm.message.add',
                    [
                        'CRM_ENTITY_TYPE' => 'lead',
                        'CRM_ENTITY' => 1195,
                        'USER_ID' => 27,
                        'CHAT_ID' => 1341,
                        'MESSAGE' => 'Message text',
                    ]
                );
        
            $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(
            'imopenlines.crm.message.add',
            {
                CRM_ENTITY_TYPE: 'lead',
                CRM_ENTITY: 1195,
                USER_ID: 27,
                CHAT_ID: 1341,
                MESSAGE: 'Message text',
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imopenlines.crm.message.add',
            [
                'CRM_ENTITY_TYPE' => 'lead',
                'CRM_ENTITY' => 1195,
                'USER_ID' => 27,
                'CHAT_ID' => 1341,
                'MESSAGE' => 'Message text',
            ]
        );
        
        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 Result

Name `Type`	Description
result `integer`	Identifier of the created message in the chat
time `time`	Information about the execution time of the request

Error Handling

HTTP Code: 400

{
            "error": "CHAT_NOT_IN_CRM",
            "error_description": "Chat does not belong to the CRM entity being checked"
        }

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 Errors

Code	Description	Value
`CHAT_NOT_IN_CRM`	Chat does not belong to the CRM entity being checked	Chat is not linked to the CRM
`CANCELED`	You cannot send messages to the specified chat	User does not have access to the chat
`ACCESS_DENIED`	Access denied! User doesn't have access to this entity	User does not have access to the CRM object
`ERROR_ARGUMENT`	Argument `CRM_ENTITY_TYPE` is null or empty	Incorrect required parameter `CRM_ENTITY_TYPE`
`ERROR_ARGUMENT`	Argument `CRM_ENTITY` is null or empty	Incorrect required parameter `CRM_ENTITY`
`ERROR_ARGUMENT`	Argument `USER_ID` is null or empty	Incorrect required parameter `USER_ID`
`ERROR_ARGUMENT`	Argument `MESSAGE` is null or empty	Incorrect required parameter `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 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

Save Message as Quick Answer imopenlines.message.quick.save

Overview of methods

Save a message as a quick reply

Send a message to the open channel imopenlines.crm.message.add

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned ResultReturned Result

Error HandlingError Handling

Possible ErrorsPossible Errors

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning