Получить данные о чате imbot.dialog.get

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

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

Scope: imbot

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

DEPRECATED

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

Метод imbot.dialog.get возвращает данные чата.

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

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

Название
тип

Описание

DIALOG_ID*
string

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

Поддерживаемые форматы:

  • XXX — идентификатор пользователя, который можно получить через user.get или user.search. Используется для получения данных о личных чатах.
  • chatXXX, где XXX — идентификатор группового чата, который можно получить через imbot.chat.get

Примеры кода

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

curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"DIALOG_ID":"chat2725"}' /
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.dialog.get
curl -X POST /
-H "Content-Type: application/json" /
-H "Accept: application/json" /
-d '{"DIALOG_ID":"chat2725","auth":"**put_access_token_here**"}' /
https://**put_your_bitrix24_address**/rest/imbot.dialog.get
try
{
    const response = await $b24.callMethod(
        'imbot.dialog.get',
        {
            DIALOG_ID: 'chat2725',
        }
    );
    
    const result = response.getData().result;
    console.log('Dialog data:', result);
    
    processResult(result);
}
catch( error )
{
    console.error('Error:', error);
}
try {
    $response = $b24Service
        ->core
        ->call(
            'imbot.dialog.get',
            [
                'DIALOG_ID' => 'chat2725'
            ]
        );

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

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

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting dialog: ' . $e->getMessage();
}
BX24.callMethod(
    'imbot.dialog.get',
    {
        DIALOG_ID: 'chat2725'
    },
    function (result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
require_once('crest.php');

$result = CRest::call(
    'imbot.dialog.get',
    [
        'DIALOG_ID' => 'chat2725'
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "imbot.dialog.get", b24.Params{
	"DIALOG_ID": "chat2725",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imbot.dialog.get: %w", err)
}

var item struct {
	ID              b24.ID `json:"id"`
	ParentChatID    int    `json:"parent_chat_id"`
	ParentMessageID int    `json:"parent_message_id"`
	Name            string `json:"name"`
	Description     string `json:"description"`
	Owner           int    `json:"owner"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.ParentChatID)

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

HTTP-статус: 200

{
    "result": {
        "id": 2725,
        "parent_chat_id": 0,
        "parent_message_id": 0,
        "name": "Новое имя для чата",
        "description": "Важные новости",
        "owner": 1291,
        "extranet": false,
        "avatar": "https://cdn-ru.bitrix24.ru/b13743910/resize_cache/33079/ff58db95aecdfa09ae61b51b5fd8f63f/im/708/70810b67c7c206ca3477933063b8ebbc/zuc0242aflwpzacvndxwnfhuxhzvgjaq",
        "color": "#f76187",
        "type": "chat",
        "counter": 0,
        "user_counter": 2,
        "message_count": 11,
        "unread_id": 0,
        "restrictions": {
            "avatar": true,
            "rename": true,
            "extend": true,
            "call": true,
            "mute": true,
            "leave": true,
            "leave_owner": true,
            "send": true,
            "user_list": true
            },
        "last_message_id": 33807,
        "last_id": 33807,
        "marked_id": 0,
        "disk_folder_id": 0,
        "entity_type": "CHAT",
        "entity_id": "13",
        "entity_data_1": "",
        "entity_data_2": "",
        "entity_data_3": "",
        "mute_list": [],
        "date_create": "2026-02-24T13:19:39+03:00",
        "message_type": "C",
        "public": "",
        "role": "member",
        "entity_link": {
            "type": "CHAT",
            "url": "",
            "id": "13"
            },
        "text_field_enabled": true,
        "background_id": null,
        "permissions": {
            "manage_users_add": "member",
            "manage_users_delete": "manager",
            "manage_ui": "member",
            "manage_settings": "owner",
            "manage_messages": "member",
            "can_post": "member"
            },
        "is_new": false,
        "readed_list": [
        {
            "user_id": 1291,
            "user_name": "MyBot",
            "message_id": 33807,
            "date": null
        }
        ],
        "manager_list": [1291],
        "last_message_views": {
            "message_id": 33807,
            "first_viewers": [
                {
                "user_id": 1271,
                "user_name": "Сотрудник",
                "date": "2026-02-24T15:41:17+03:00"
                }
            ],
            "count_of_viewers": 0
            },
        "dialog_id": "chat2725"
    },
    "time": {
        "start": 1771937178,
        "finish": 1771937178.934208,
        "duration": 0.9342079162597656,
        "processing": 0,
        "date_start": "2026-02-24T15:46:18+03:00",
        "date_finish": "2026-02-24T15:46:18+03:00",
        "operating_reset_at": 1771937778,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с описанием чата

time
time

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

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

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

{
    "error": "DIALOG_ID_EMPTY",
    "error_description": "Dialog ID can't be empty"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

Значение

DIALOG_ID_EMPTY

Dialog ID can't be empty

Не передан или передан некорректный DIALOG_ID

ACCESS_ERROR

You do not have access to the specified dialog

Нет доступа к указанному диалогу

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

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

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