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

Для корректной работы ваших чат-ботов и мини-приложений направляйте запросы на домен platform-api2.max.ru вместо platform-api.max.ru. Также убедитесь, что добавили сертификат Минцифры в список доверенных

GET/chats/{chatId}

Возвращает информацию о групповом чате или канале по его ID

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

BASH

Скопировать

curl -X GET "https://platform-api2.max.ru/chats/{chatId}" \
  -H "Authorization: {access_token}"

Авторизация

access_token
apiKey

Передача токена через query-параметры больше не поддерживается — используйте заголовок Authorization: <token>

Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты → Перейти → Расширенные настройки → Настроить
Eсли вы верифицировали профиль и создали бота в мини-приложении «MAX для бизнеса», получить токен можно там же или в боте «MAX для бизнеса» с помощью команды Получить токен

Рекомендуем не разглашать токен посторонним, чтобы они не получили доступ к управлению ботом. Токен может быть отозван за нарушение Правил платформы

Параметры

chatId
integer <int64>
\-?\d+

ID запрашиваемого группового чата или канала. Как получить ID — в разделе «Получение chat_id»

Результат

chat_id
integer <int64>

ID чата или канала — в зависимости от ограничений метода и от того, с чем вы работаете. Как получить ID — в разделе «Получение chat_id»

type
enum ChatType

Возможные значения в enum: "chat" "channel" "dialog"

Тип чата:

"chat" — Групповой чат
"channel" — Канал
"dialog" — Диалог

status
enum ChatStatus

Возможные значения в enum: "active" "removed" "left" "closed"

Статус чата:

"active" — Бот является активным участником чата
"removed" — Бот был удалён из чата
"left" — Бот покинул чат
"closed" — Чат был закрыт

title
string Nullable

Отображаемое название чата или канала. Может быть null для диалогов

icon
object Image Nullable

Аватар группового чата или канала

last_event_time
integer <int64>

Время последнего события в чате или канале в формате Unix timestamp в миллисекундах

participants_count
integer <int32>

Количество участников чата или канала. Для диалогов всегда 2

owner_id
integer <int64> Nullable optional

ID владельца чата или канала

participants
object Nullable optional

Список участников в формате ключ-значение, где ключ — идентификатор участника user_id, а значение — время его последней активности в чате или канале last_event_time. Может быть null, если запрашивается список чатов

is_public
boolean

Параметр показывает, доступен ли групповой чат или канал публично. Для диалогов и приватных каналов — всегда false

link
string Nullable optional

Ссылка на чат

description
string Nullable

Описание чата или канала

dialog_with_user
object UserWithPhoto Nullable optional

Данные о пользователе в диалоге (только для чатов типа "dialog")

messages_count
integer Nullable optional

Количество сообщений в групповом чате или постов канале

pinned_message
object Message Nullable optional

Закреплённое сообщение в чате (возвращается только при запросе конкретного чата или канала)