Получить чаты для объекта CRM imopenlines.crm.chat.get
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
imopenlinesКто может выполнять метод: любой пользователь с доступом к объекту CRM
Метод imopenlines.crm.chat.get получает список чатов, которые привязаны к объекту CRM.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CRM_ENTITY_TYPE* |
Тип объекта CRM. Возможные значения:
|
|
CRM_ENTITY* |
Идентификатор объекта CRM. Получить идентификатор можно универсальным методом получения списка элементов CRM |
|
ACTIVE_ONLY |
Флаг возврата только активных чатов. Возможные значения:
По умолчанию — |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"ACTIVE_ONLY":"N"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.crm.chat.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CRM_ENTITY_TYPE":"lead","CRM_ENTITY":1205,"ACTIVE_ONLY":"N","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.get
// 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
// Shape of each Chat returned in result[]
type Chat = {
CHAT_ID: string
CONNECTOR_ID: string
CONNECTOR_TITLE: string
}
try {
const response = await $b24.actions.v2.call.make<Chat[]>({
method: 'imopenlines.crm.chat.get',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
ACTIVE_ONLY: 'N',
},
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('Chats count:', result.length, 'First chat ID:', result[0]?.CHAT_ID)
}
} 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 getCrmChats() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'imopenlines.crm.chat.get',
params: {
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
ACTIVE_ONLY: 'N',
},
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('Chats count:', result.length, 'First chat ID:', result[0]?.CHAT_ID)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getCrmChats)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.imopenlines.crm.chat.get(
crm_entity_type="lead",
crm_entity=1205,
active_only=False,
).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.chat.get',
[
'CRM_ENTITY_TYPE' => 'lead',
'CRM_ENTITY' => 1205,
'ACTIVE_ONLY' => 'N',
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'imopenlines.crm.chat.get',
{
CRM_ENTITY_TYPE: 'lead',
CRM_ENTITY: 1205,
ACTIVE_ONLY: 'N'
},
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'imopenlines.crm.chat.get',
[
'CRM_ENTITY_TYPE' => 'lead',
'CRM_ENTITY' => 1205,
'ACTIVE_ONLY' => 'N',
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imopenlines.crm.chat.get", b24.Params{
"CRM_ENTITY_TYPE": "lead",
"CRM_ENTITY": 1205,
"ACTIVE_ONLY": "N",
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("imopenlines.crm.chat.get: %w", err)
}
var items []struct {
ChatID b24.ID `json:"CHAT_ID"`
ConnectorID string `json:"CONNECTOR_ID"`
ConnectorTitle string `json:"CONNECTOR_TITLE"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ChatID, it.ConnectorID)
}
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"CHAT_ID": "1763",
"CONNECTOR_ID": "livechat",
"CONNECTOR_TITLE": "Онлайн-чат"
}
],
"time": {
"start": 1773758908,
"finish": 1773758908.592458,
"duration": 0.5924580097198486,
"processing": 0,
"date_start": "2026-03-17T17:48:28+03:00",
"date_finish": "2026-03-17T17:48:28+03:00",
"operating_reset_at": 1773759508,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список объектов чатов (подробное описание). Возвращает пустой массив |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
CHAT_ID |
Идентификатор чата |
|
CONNECTOR_ID |
Идентификатор коннектора |
|
CONNECTOR_TITLE |
Название коннектора |
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'CRM_ENTITY' is null or empty"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access denied! You dont have access to this action |
У пользователя нет доступа к объекту CRM |
|
|
|
Argument 'CRM_ENTITY_TYPE' is null or empty |
Не передан или передан пустым обязательный параметр |
|
|
|
Argument 'CRM_ENTITY' is null or empty |
Не передан или передан пустым обязательный параметр |
|
|
|
The value of an argument 'CRM_ENTITY' has an invalid type |
Параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |