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

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

HTTP метод: GET

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

Заголовки

Authorization: OAuth <токен>

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

Имя параметра Обязательный Тип Описание Ограничения, значение по умолчанию
chat_id Да string ID чата или канала Бот должен состоять в чате (канале)
role Нет string Фильтр по роли участника Возможные значения: admin, member, subscriber
limit Нет integer Максимальное количество участников в ответе От 1 до 1000. Значение по умолчанию: 100
offset Нет string Смещение для пагинации Значение guid последнего участника из предыдущего ответа

Результат

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

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

Для получения следующей страницы передайте guid последнего участника из ответа в параметр offset.

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

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

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

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

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

{
  "ok": true,
  "data": [
    {
      "guid": "447c35f4-191f-4e98-8711-01885b2dcc18",
      "login": "anya@example.org",
      "role": "admin",
      "is_bot": false
    },
    {
      "guid": "6d8d04f7-31f7-4030-8926-305587256f0e",
      "login": "vasya@example.org",
      "role": "member",
      "is_bot": false
    }
  ]
}

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

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