метод REST scope: im

im.chat.get

Получить идентификатор чата

Кто может выполнять: любой пользователь

Описание

Метод im.chat.get получает идентификатор чата.

Параметры

ENTITY_TYPE string обязательный

Тип объекта для связи чата с внешним контекстом. Передается строкой.

Возможные значения:
- VIDEOCONF — чат видеоконференции
- AI_ASSISTANT_PRIVATE — приватный чат с AI-ассистентом
- LINES — чат открытой линии со стороны оператора
- LIVECHAT — чат открытой линии со стороны клиента
- ANNOUNCEMENT — чат объявлений
- CALENDAR — чат, связанный с событием календаря
- MAIL — чат, связанный с почтовой перепиской
- CRM — системный чат «для обсуждения» CRM-элемента. Метод не вернет идентификаторы других чатов, связанных с элементом CRM
- SONET_GROUP — системный чат группы или проекта
- TASKS_TASK — чат задачи в новой карточке задач
- TASKS — системный чат задачи в старой карточке задач
- CALL — чат, связанный со звонком

ENTITY_ID string обязательный

Идентификатор объекта в рамках ENTITY_TYPE.

Передается строкой. Формат зависит от выбранного ENTITY_TYPE.

Поддерживаемые форматы для распространенных типов:
- CRM<CRM_TYPE>|<ID>, например LEAD|13, DEAL|1663, CONTACT|25, COMPANY|7. Для смарт-процессов — DYNAMIC_<entityTypeId>|<itemId>
- LINES<connectorId>|<lineId>|<connectorChatId>|<connectorUserId>, например telegrambot|2|209607941|744
- LIVECHAT<connectorId>|<lineId>
- TASKS, TASKS_TASK — идентификатор задачи, например 8293
- CALENDAR — идентификатор события календаря
- SONET_GROUP — идентификатор группы

Для остальных ENTITY_TYPE формат определяется модулем или интеграцией.

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.get

Ответ

HTTP-статус: 200

{
    "result": {
        "ID": 1437
    },
    "time": {
        "start": 1772028217,
        "finish": 1772028217.949613,
        "duration": 0.949613094329834,
        "processing": 0,
        "date_start": "2026-02-25T17:03:37+03:00",
        "date_finish": "2026-02-25T17:03:37+03:00",
        "operating_reset_at": 1772028817,
        "operating": 0
    }
}

Возвращаемые данные

result object

Возвращает объект с идентификатором чата ID.

Метод вернет null:
- если чат не найден
- не указаны обязательные параметры
- параметры заполнены неверно

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.