Send a Message to Open Channel imopenlines.crm.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:
imopenlinesWho can execute the method: a user with read access to the CRM item linked to the chat
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 |
Description |
|
CRM_ENTITY_TYPE* |
Type of the CRM entity:
|
|
CRM_ENTITY* |
Identifier of the CRM entity linked to the chat. You can obtain a list of entities of a specific CRM entity type using the method crm.item.list |
|
USER_ID* |
Message sender identifier — the user or bot that must be a chat participant and have access to the CRM item. The user identifier can be obtained using the user.get or user.search method. The list of chatbots can be obtained using the imbot.bot.list method |
|
CHAT_ID* |
Identifier of the open channel chat linked to the CRM entity. You can obtain the chat ID using the method imopenlines.crm.chat.get or imopenlines.dialog.get |
|
MESSAGE* |
The text of the message that will be displayed in the chat |
Code Examples
How to Use Examples in Documentation
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
// 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
try {
const response = await $b24.actions.v2.call.make<number>({
method: 'imopenlines.crm.message.add',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1195,
USER_ID: 27,
CHAT_ID: 1341,
MESSAGE: 'Message text',
},
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('Created message ID:', result)
}
} 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 sendCrmMessage() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.crm.message.add',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1195,
USER_ID: 27,
CHAT_ID: 1341,
MESSAGE: 'Message text',
},
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('Created message ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', sendCrmMessage)
</script>
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'];
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imopenlines.crm.message.add", b24.Params{
"CRM_ENTITY_TYPE": "lead",
"CRM_ENTITY": 1195,
"USER_ID": 27,
"CHAT_ID": 1341,
"MESSAGE": "Message text",
})
if err != nil {
return fmt.Errorf("imopenlines.crm.message.add: %w", err)
}
var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)
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+03:00",
"date_finish": "2024-10-11T10:00:00+03:00",
"operating_reset_at":1762349466,
"operating": 0
}
}
Returned Result
|
Name |
Description |
|
result |
Identifier of the created message in the chat |
|
time |
Information about the request execution time |
Error Handling
HTTP code: 400
{
"error": "CHAT_NOT_IN_CRM",
"error_description": "Chat does not belong to the CRM entity being checked"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 does not belong to the CRM entity being checked |
Chat is not linked to the CRM |
|
|
You cannot send messages to the specified chat |
The user does not have access to the chat |
|
|
Access denied! User dont have access to this entity |
User does not have access to the CRM object |
|
|
Argument |
Invalid required parameter |
|
|
Argument |
Invalid required parameter |
|
|
Argument |
Invalid required parameter |
|
|
Argument |
Invalid required parameter |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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 |