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

GET/chats/{chatId}/members

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

Бот, чей токен access_token используется для авторизации, должен быть администратором этого чата или канала

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

BASH
Скопировать
curl -X GET "https://platform-api.max.ru/chats/{chatId}/members" \ -H "Authorization: {access_token}"

Авторизация

access_token
apiKey

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

Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты → Перейти → Расширенные настройки → Настроить

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

Параметры

chatId
integer <int64>
\-?\d+

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

user_ids
integer[] Nullable optional

Список ID пользователей, чьё членство нужно получить. Когда этот параметр передан, параметры count и marker игнорируются

marker
integer <int64> optional

Указатель на следующую страницу данных

count
integer [1-100] optional

По умолчанию: "20"

Количество участников, которых нужно вернуть в ответе

Результат

members
ChatMember[]

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

marker
integer <int64> Nullable optional

Указатель на следующую страницу данных