Получение информации о чате или канале

Метод возвращает подробную информацию о чате или канале, включая список реакций, которые можно ставить на сообщения в этом чате.

HTTP метод: GET

URL: https://botapi.messenger.yandex.net/bot/v1/chats/getChat/

Заголовки

Authorization: OAuth <токен>

Параметры запроса

Имя параметра Обязательный Тип Описание Ограничения, значение по умолчанию
chat_id Да string ID чата, канала или приватного чата Бот должен состоять в чате или канале

Результат

Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о чате.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
data Да ChatInfo Информация о чате или канале

Поле data.available_reactions содержит реакции, доступные в этом чате. Используйте эти значения в методах установки реакции и получения реакций.

В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
description Да string Описание ошибки

Пример запроса

curl -H 'Authorization: OAuth AtXXXXXXXXXXX' \
    'https://botapi.messenger.yandex.net/bot/v1/chats/getChat/?chat_id=0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9'

Пример успешного ответа

{
  "ok": true,
  "data": {
    "type": "group",
    "id": "0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9",
    "private": false,
    "name": "Рабочий чат",
    "description": "Обсуждение проекта",
    "available_reactions": [
      {
        "type": "default_reaction",
        "name": "like"
      },
      {
        "type": "default_reaction",
        "name": "fire"
      }
    ]
  }
}

Пример ответа с ошибкой

{"ok": false, "description": "Bot is not a member of the chat"}
Предыдущая
Получение списка чатов
Следующая
Создание чата или канала