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

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

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

Scope: im

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

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

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

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

Название
тип

Описание

DIALOG_ID*
string

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

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

Примеры: chat1435, sg103

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ImDialogGetResult = {
  id: number
  parent_chat_id: number
  parent_message_id: number
  name: string
  description: string
  owner: number
  extranet: boolean
  avatar: string
  color: string
  type: string
  counter: number
  user_counter: number
  message_count: number
  unread_id: number
  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
  }
  last_message_id: number
  last_id: number
  marked_id: number
  disk_folder_id: number
  entity_type: string
  entity_id: string
  entity_data_1: string
  entity_data_2: string
  entity_data_3: string
  mute_list: number[]
  date_create: ISODate
  message_type: string
  public: string
  role: string
  entity_link: {
    type: string
    url: string
    id: string
  }
  text_field_enabled: boolean
  background_id: number | null
  permissions: {
    manage_users_add: string
    manage_users_delete: string
    manage_ui: string
    manage_settings: string
    manage_messages: string
    can_post: string
  }
  is_new: boolean
  readed_list: {
    user_id: number
    user_name: string
    message_id: number
    date: ISODate | null
  }[]
  manager_list: number[]
  last_message_views: {
    message_id: number
    first_viewers: number[]
    count_of_viewers: number
  }
  dialog_id: string
}

try {
  const response = await $b24.actions.v2.call.make<ImDialogGetResult>({
    method: 'im.dialog.get',
    params: {
      DIALOG_ID: 'chat1435',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Dialog:', result.id, result.name, result.type, result.role)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getDialog() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.dialog.get',
        params: {
          DIALOG_ID: 'chat1435',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Dialog:', result.id, result.name, result.type, result.role)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getDialog)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.im.dialog.get(
        dialog_id="chat1435",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "im.dialog.get", b24.Params{
	"DIALOG_ID": "chat1435",
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("im.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": 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

Каждое поле объекта показывает, какому кругу участников доступно действие:

member — всем участникам чата
manager — владельцу и администраторам чата
owner — только владельцу чата

Название `тип`	Описание
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 `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

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

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

Была ли статья полезна?

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

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

Получить данные о чате 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

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

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

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

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