imopenlines.crm.message.add
Отправить сообщение в открытую линию
Описание
Метод imopenlines.crm.message.add отправляет сообщение от имени сотрудника или бота в чат, который привязан к элементу CRM.
Параметры
CRM_ENTITY_TYPE
string
обязательный
Тип объекта CRM:
- lead — лид
- deal — сделка
- company — компания
- contact — контакт
CRM_ENTITY
integer
обязательный
Идентификатор элемента CRM, к которому привязан чат.
Список элементов определенного типа объекта CRM можно получить с помощью метода crm.item.list
USER_ID
integer
обязательный
Идентификатор отправителя сообщения — пользователя или бота, который должен быть участником чата и иметь доступ к элементу CRM.
Идентификатор пользователя можно получить с помощью метода user.get или user.search.
Список чат-ботов можно получить с помощью метода imbot.bot.list
CHAT_ID
integer
обязательный
Идентификатор чата открытой линии, который связан с элементом CRM.
Идентификатор чата можно получить с помощью метода imopenlines.crm.chat.get или imopenlines.dialog.get
MESSAGE
string
обязательный
Текст сообщения, который будет отображен в чате
Примеры запроса
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":"Текст сообщения"}' \
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":"Текст сообщения","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",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'imopenlines.crm.message.add',
[
'CRM_ENTITY_TYPE' => 'lead',
'CRM_ENTITY' => 1195,
'USER_ID' => 27,
'CHAT_ID' => 1341,
'MESSAGE' => 'Текст сообщения',
]
);
$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: 'Текст сообщения',
},
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' => 'Текст сообщения',
]
);
if (!empty($result['error'])) {
echo 'Error: ' . $result['error_description'];
} else {
echo 'Created message ID: ' . $result['result'];
}
// client и ctx уже созданы — см. раздел «SDK для Go»
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": "Текст сообщения",
})
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("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
Ответ
HTTP-статус: 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
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "CHAT_NOT_IN_CRM",
"error_description": "Chat does not belong to the CRM entity being checked"
}
| Код | Описание | Значение |
|---|---|---|
400 |
CHAT_NOT_IN_CRM |
Chat does not belong to the CRM entity being checked |
403 |
ACCESS_DENIED |
Access denied! You dont have access to this action |
403 |
ACCESS_DENIED |
Access denied! User dont have access to this entity |
400 |
ERROR_ARGUMENT |
Argument 'CRM_ENTITY_TYPE' is null or empty |
400 |
ERROR_ARGUMENT |
Argument 'CRM_ENTITY' is null or empty |
400 |
ERROR_ARGUMENT |
The value of an argument 'CRM_ENTITY' has an invalid type |
400 |
ERROR_ARGUMENT |
Argument 'USER_ID' is null or empty |
400 |
ERROR_ARGUMENT |
The value of an argument 'USER_ID' has an invalid type |
400 |
ERROR_ARGUMENT |
Argument 'CHAT_ID' is null or empty |
400 |
ERROR_ARGUMENT |
The value of an argument 'CHAT_ID' has an invalid type |
400 |
ERROR_ARGUMENT |
Argument 'MESSAGE' is null or empty |
400 |
MESSAGE_ADD_ERROR |
Message isn't added |

