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

Scope: im

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

Метод 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 формат определяется модулем или интеграцией. Может быть произвольной строкой.

При создании чата можно передать произвольную пару ENTITY_TYPE и ENTITY_ID. Метод im.chat.get вернет чат, если вызвать его с той же парой значений

Примеры кода

Как использовать примеры в документации

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
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.chat.get
        
try
        {
            const response = await $b24.callMethod(
                'im.chat.get',
                {
                    ENTITY_TYPE: 'CRM',
                    ENTITY_ID: 'DEAL|1663'
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'im.chat.get',
                    [
                        'ENTITY_TYPE' => 'CRM',
                        'ENTITY_ID' => 'DEAL|1663',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'CHAT_ID: ' . var_export($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'im.chat.get',
            {
                ENTITY_TYPE: 'CRM',
                ENTITY_ID: 'DEAL|1663',
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'im.chat.get',
            [
                'ENTITY_TYPE' => 'CRM',
                'ENTITY_ID' => 'DEAL|1663',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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

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

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

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Создать чат
Следующая
Получить данные о чате