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

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>';

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

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

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

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

Код

Описание

Значение

AUTHORIZE_ERROR

Method not available for guest session.

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

ACCESS_ERROR

You don't have access to this chat

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

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

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

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

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

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