Send a Message to Open Channel imopenlines.crm.message.add
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:
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imopenlines.crm.message.add(
crm_entity_type="lead",
crm_entity=1195,
user_id=27,
chat_id=1341,
message="Message text",
).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}")
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 status: 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 Data
|
Name |
Description |
|
result |
Identifier of the created message in the chat |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400, 403
{
"error": "CHAT_NOT_IN_CRM",
"error_description": "Chat does not belong to the CRM entity being checked"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
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 don't 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 |
|
|
Argument |
Invalid required parameter |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |