Управление участниками чата или канала
Метод позволяет добавлять и удалять участников в чат, добавлять и удалять подписчиков канала, а также назначать администраторов чата или канала.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/chats/updateMembers/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Да | string |
ID чата (канала) | Бот должен состоять в чате (канале) |
members |
Нет* | User[] |
Список пользователей, которых нужно сделать участниками чата | Бот должен состоять в чате. Если хотя бы один из пользователей (User) был администратором, бот должен быть администратором Не более 500 пользователей за раз |
admins |
Нет* | User[] |
Список пользователей, которых нужно сделать администраторами чата (канала) | Бот должен быть администратором чата (канала) Не более 100 пользователей за раз |
subscribers |
Нет* | User[] |
Список пользователей, которых нужно сделать подписчиками канала | Бот должен состоять в чате. Пользователи (User) не могут быть администраторами чата Не более 500 пользователей за раз |
remove |
Нет* | User[] |
Список пользователей, которых нужно удалить из чата (канала) | Для удаления администраторов бот должен быть администратором чата (канала) Не более 500 пользователей за раз |
(*) Параметры members, admins, subscribers и remove являются необязательными, но должен быть задан хотя бы один из списков.
Ограничения
Каждый пользователь в запросе должен быть уникален, в противном случае будет возвращена ошибка.
Результат
В случае успешного запроса все пользователи будут иметь указанные в запросе роли. В случае ошибки будет возвращено сообщение с ее описанием, роли пользователей не поменяются.
Пример успешного ответа
{"ok": true}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая