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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: imbot

Кто может выполнять метод: пользователь с доступом к чату

DEPRECATED

Развитие метода остановлено. Используйте imbot.v2.Chat.get.

Метод imbot.chat.get возвращает идентификатор чата.

Чтобы получить подробную информацию о чате, используйте метод imbot.dialog.get

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

ENTITY_TYPE*
string

Тип внешнего объекта.

Используется вместе с ENTITY_ID, который был передан при создании чата методом imbot.chat.add

ENTITY_ID*
string

Идентификатор внешнего объекта.

Используется вместе с ENTITY_TYPE, который был передан при создании чата методом imbot.chat.add

Примеры кода

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

curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"ENTITY_TYPE":"CHAT","ENTITY_ID":"13"}' /
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.chat.get

curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"ENTITY_TYPE":"CHAT","ENTITY_ID":"13","auth":"**put_access_token_here**"}' /
https://**put_your_bitrix24_address**/rest/imbot.chat.get

try
{
    const response = await $b24.callMethod(
        'imbot.chat.get',
        {
            ENTITY_TYPE: 'CHAT',
            ENTITY_ID: '13'
        }
    );
    
    const result = response.getData().result;
    console.log('Retrieved chat data:', result);
    processResult(result);
}
catch( error )
{
    console.error('Error:', error);
}

try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.chat.get',
            [
                'ENTITY_TYPE' => 'CHAT',
                'ENTITY_ID' => '13'
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error retrieving chat: ' . $e->getMessage();
}

BX24.callMethod(
    'imbot.chat.get',
    {
        ENTITY_TYPE: 'CHAT',
        ENTITY_ID: '13'
    },
    function (result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'imbot.chat.get',
    [
        'ENTITY_TYPE' => 'CHAT',
        'ENTITY_ID' => '13'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.chat.get", b24.Params{
	"ENTITY_TYPE": "CHAT",
	"ENTITY_ID":   "13",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imbot.chat.get: %w", err)
}

var item struct {
	ID b24.ID `json:"ID"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID)

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

HTTP-статус: 200

{
  "result": {
      "ID": 2725
  },
  "time": {
      "start": 1771929873,
      "finish": 1771929873.459722,
      "duration": 0.45972204208374023,
      "processing": 0,
      "date_start": "2026-02-24T13:44:33+03:00",
      "date_finish": "2026-02-24T13:44:33+03:00",
      "operating_reset_at": 1771930473,
      "operating": 0
    }
}

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

Название
тип

Описание

result
object

Идентификатор чата.

Возвращает null, если хотя бы один из параметров ENTITY_TYPE или ENTITY_ID не передан

time
time

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

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

HTTP-статус: 400, 403

{
    "error": "ACCESS_ERROR",
    "error_description": "You don't have access to this chat"
}

Название
тип

Описание

error
string

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

error_description
string

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

Возможные коды ошибок

Код

Описание

Значение

AUTHORIZE_ERROR

Method not available for guest session.

Метод недоступен в гостевой сессии

ACCESS_ERROR

You don't have access to this chat

Нет доступа к указанному чату

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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

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