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

Scope: im

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

Метод im.dialog.get получает информацию о чате.

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

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

Название
тип

Описание

DIALOG_ID*
string

Идентификатор чата в формате:

chatXXX — чат
sgXXX — чат группы или проекта
XXX — идентификатор пользователя личного чата

Примеры: chat1435, sg103

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat1435"}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.dialog.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"DIALOG_ID":"chat1435","auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.dialog.get

try
        {
            const response = await $b24.callMethod(
                'im.dialog.get',
                {
                    DIALOG_ID: 'chat1435'
                }
            );
        
            console.log(response.getData().result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.dialog.get',
                    [
                        'DIALOG_ID' => 'chat1435',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

BX24.callMethod(
            'im.dialog.get',
            {
                DIALOG_ID: 'chat1435'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.dialog.get',
            [
                'DIALOG_ID' => 'chat1435',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "id": 1439,
                "parent_chat_id": 0,
                "parent_message_id": 0,
                "name": "Чат по сделке",
                "description": "Здесь обсуждаем сделку",
                "owner": 503,
                "extranet": false,
                "avatar": "",
                "color": "#f76187",
                "type": "crm",
                "counter": 0,
                "user_counter": 3,
                "message_count": 3,
                "unread_id": 0,
                "restrictions": {
                    "avatar": false,
                    "rename": false,
                    "extend": true,
                    "call": true,
                    "mute": true,
                    "leave": true,
                    "leave_owner": false,
                    "send": true,
                    "user_list": true,
                    "path": "",
                    "path_title": ""
                },
                "last_message_id": 84477,
                "last_id": 84477,
                "marked_id": 0,
                "disk_folder_id": 0,
                "entity_type": "CRM",
                "entity_id": "DEAL|1663",
                "entity_data_1": "",
                "entity_data_2": "",
                "entity_data_3": "",
                "mute_list": [],
                "date_create": "2026-02-25T16:50:58+03:00",
                "message_type": "C",
                "public": "",
                "role": "owner",
                "entity_link": {
                    "type": "DEAL",
                    "url": "/crm/deal/details/1663/",
                    "id": "DEAL|1663"
                },
                "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": 103,
                        "user_name": "Иван Иванов",
                        "message_id": 0,
                        "date": null
                    },
                    {
                        "user_id": 547,
                        "user_name": "Петр Петров",
                        "message_id": 0,
                        "date": null
                    }
                ],
                "manager_list": [
                    503
                ],
                "last_message_views": {
                    "message_id": 84477,
                    "first_viewers": [],
                    "count_of_viewers": 0
                },
                "dialog_id": "chat1439"
            },
            "time": {
                "start": 1772030091,
                "finish": 1772030091.165223,
                "duration": 0.1652228832244873,
                "processing": 0,
                "date_start": "2026-02-25T17:34:51+03:00",
                "date_finish": "2026-02-25T17:34:51+03:00",
                "operating_reset_at": 1772030691,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Корневой объект с данными чата (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result-item

Название `тип`	Описание
id `integer`	Идентификатор чата
parent_chat_id `integer`	Идентификатор родительского чата
parent_message_id `integer`	Идентификатор родительского сообщения
name `string`	Название чата
description `string`	Описание чата
owner `integer`	Идентификатор владельца чата
extranet `boolean`	Признак участия внешнего экстранет-пользователя
avatar `string`	Ссылка на аватар чата
color `string`	Цвет чата в формате HEX
type `string`	Тип чата
counter `integer`	Счетчик непрочитанных сообщений
user_counter `integer`	Количество участников чата
message_count `integer`	Количество сообщений в чате
unread_id `integer`	Идентификатор первого непрочитанного сообщения
restrictions `object`	Ограничения действий в чате (подробное описание)
last_message_id `integer`	Идентификатор последнего сообщения
last_id `integer`	Идентификатор последнего прочитанного сообщения
marked_id `integer`	Идентификатор помеченного сообщения
disk_folder_id `integer`	Идентификатор папки чата на Диске
entity_type `string`	Внешний код чата: тип
entity_id `string`	Внешний код чата: идентификатор
entity_data_1 `string`	Внешние данные 1 для чата
entity_data_2 `string`	Внешние данные 2 для чата
entity_data_3 `string`	Внешние данные 3 для чата
mute_list `array`	Список пользователей с отключенными уведомлениями
date_create `datetime`	Дата создания чата в формате ATOM
message_type `string`	Тип сообщений чата
public `string`	Признак публичности чата
role `string`	Роль текущего пользователя в чате
entity_link `object`	Ссылка на связанный объект (подробное описание)
text_field_enabled `boolean`	Доступность поля ввода сообщений
background_id `integer`	Идентификатор фона чата. Если не задан, значение `null`
permissions `object`	Права действий в чате (подробное описание)
is_new `boolean`	Признак нового диалога
readed_list `array`	Список пользователей и статусов прочтения (подробное описание)
manager_list `array`	Список идентификаторов менеджеров чата
last_message_views `object`	Информация о просмотрах последнего сообщения (подробное описание)
dialog_id `string`	Идентификатор диалога, переданный в параметре `DIALOG_ID`

Объект restrictions

Название `тип`	Описание
avatar `boolean`	Доступность изменения аватара
rename `boolean`	Доступность изменения названия
extend `boolean`	Доступность расширения чата
call `boolean`	Доступность звонков
mute `boolean`	Доступность отключения уведомлений
leave `boolean`	Доступность выхода из чата
leave_owner `boolean`	Доступность выхода владельца из чата
send `boolean`	Доступность отправки сообщений
user_list `boolean`	Доступность просмотра списка участников
path `string`	Ссылка на чат
path_title `string`	Текст ссылки на чат

Объект entity_link

Название `тип`	Описание
type `string`	Тип связанного объекта
url `string`	Ссылка на связанный объект
id `string`	Идентификатор связанного объекта

Объект permissions

Название `тип`	Описание
manage_users_add `string`	Право на добавление участников
manage_users_delete `string`	Право на удаление участников
manage_ui `string`	Право на управление интерфейсом чата
manage_settings `string`	Право на управление настройками чата
manage_messages `string`	Право на управление сообщениями
can_post `string`	Право на отправку сообщений

Объект readed_list

Название `тип`	Описание
user_id `integer`	Идентификатор пользователя
user_name `string`	Имя пользователя
message_id `integer`	Идентификатор последнего прочитанного сообщения
date `datetime`	Дата прочтения. Если не задана, значение `null`

Объект last_message_views

Название `тип`	Описание
message_id `integer`	Идентификатор сообщения
first_viewers `array`	Список первых просмотревших пользователей
count_of_viewers `integer`	Количество просмотров

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

HTTP-статус: 400

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`DIALOG_ID_EMPTY`	Dialog ID can't be empty	Не передан обязательный параметр `DIALOG_ID`
`403`	`ACCESS_ERROR`	You do not have access to the specified dialog	Недостаточно прав на просмотр диалога

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

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

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

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

Обзор методов

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

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

Примеры кодаПримеры кода

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

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

Объект result-itemОбъект result-item

Объект restrictionsОбъект restrictions

Объект entity_linkОбъект entity_link

Объект permissionsОбъект permissions

Объект readed_listОбъект readed_list

Объект last_message_viewsОбъект last_message_views

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

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

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

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