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

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

GET/chats/{chatId}/members/admins

Возвращает список всех администраторов группового чата и канала (пользователей и ботов) и их данные, например: идентификатор, имя, никнейм, время последней активности, URL аватара, флаги администратора, владельца и бота, а также права на управление каналом или групповым чатом для пользователей-администраторов

Бот, чей токен access_token используется для авторизации, должен быть администратором этого чата или канала. Подробнее о правах — в описании POST /chats/{chatId}/members/admins

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

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

Авторизация

access_token
apiKey

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

Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты. Выберите необходимого бота и нажмите ⋮ → Настройки → значок копирования справа от поля с токеном

Если вы верифицировали профиль и создали бота в мини-приложении «MAX для бизнеса», получить токен можно там же или в боте «MAX для бизнеса» с помощью команды Получить токен

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

Параметры

chatId
integer <int64>\-?\d+
ID группового чата или канала. Как получить ID — на странице «Получение ID чата или канала»

HTTP-коды ответов

КодОписание
200Список администраторов в групповом чате или канале
401Ошибка авторизации. Токен access_token указан некорректно или недействителен
403Ошибка доступа. У вас нет доступа к этому ресурсу
404Запрашиваемый ресурс не найден
500Внутренняя ошибка сервера

Подробнее о форматах ответа и кодах ошибок — на странице «Общее описание»

Результат

members
ChatMember[]
Список участников группового чата или канала с общей информацией о них, а также временем последней активности и списком прав доступа для пользователей и ботов, которые являются администраторами

user_id
integer <int64>
Идентификатор пользователя или бота

first_name
string
Отображаемое имя пользователя или бота

last_name
string Nullableoptional
Отображаемая фамилия пользователя. Для ботов это поле не возвращается

username
string Nullable
Никнейм бота. Для пользователей это поле не возвращается

is_bot
boolean
true, если это бот

last_activity_time
integer <int64>
Время последней активности пользователя или бота в MAX (Unix timestamp в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети, поле может не возвращаться

name
string Nullable
Устаревшее поле, скоро будет удалено

description
string Nullableoptional

до 16000 символов

Описание пользователя или бота. В случае с пользователем может принимать значение null, если описание не заполнено

avatar_url
stringoptional
URL аватара пользователя или бота в уменьшенном размере

full_avatar_url
stringoptional
URL аватара пользователя или бота в полном размере

last_access_time
integer <int64>
Время последней активности пользователя в чате. Может быть устаревшим для суперчатов (равно времени вступления)

is_owner
boolean
Является ли пользователь владельцем группового чата или канала

is_admin
boolean
Является ли пользователь администратором группового чата или канала

join_time
integer <int64>
Дата присоединения к чату в формате Unix timestamp в миллисекундах

permissions
ChatAdminPermission[] Nullable

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

Ниже приведено краткое описание всех прав — подробнее читайте в разделе «Доступные права администратора»

Краткое описание доступных прав администратора:

  • read_all_messages — читать все сообщения в канале или групповом чате
  • edit — редактировать посты и комментарии в каналах (для групповых чатов недоступно). Ранее вместо edit в API использовалось edit_message — в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используется edit
  • delete — удалять посты и комментарии в каналах (для групповых чатов недоступно). Ранее вместо delete в API использовалось delete_message — в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используется delete
  • write — редактировать и удалять сообщения в групповых чатах, а также писать посты и комментарии в каналах. Ранее вместо write в API использовалось post_edit_delete_message — в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используется write
  • pin_message — закреплять сообщение
  • change_chat_info — изменять информацию о канале или групповом чате
  • add_remove_members — добавлять и удалять участников группового чата (доступно пользователям и ботам) или подписчиков канала (доступно только пользователям)
  • add_admins — добавлять и удалять администраторов группового чата или канала
  • edit_link — изменять ссылку на групповой чат (для каналов недоступно)
  • can_call — звонить в групповом чате (для каналов недоступно)
  • view_stats — право на просмотр статистики каналов (для групповых чатов недоступно). Назначается по умолчанию владельцам каналов. Для других пользователей-администраторов канала и ботов недоступно

alias
stringoptional

Описание роли, которое будет отображаться на клиентском устройстве в настройках чата или канала рядом с именем пользователя

Если пользователь администратор или владелец и ему не установлено это название, то поле не передаётся, клиентское устройство на своей стороне подменит значение на соответствующее: “владелец” или “админ”

marker
integer <int64> Nullableoptional
Указатель на следующую страницу данных