Получение результатов опроса
Метод позволяет получать результаты опроса пользователей в чате: общее количество проголосовавших и число голосов, отданных за каждый вариант ответа.
HTTP метод: GET
URL: https://botapi.messenger.yandex.net/bot/v1/polls/getResults/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON или URL Query)
Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата | Бот должен быть участником чата |
login |
Нет* | string |
Логин пользователя | — |
message_id |
Да | integer |
ID сообщения с опросом в чате | — |
invite_hash |
Нет | string |
Хеш пригласительной ссылки, если бот еще не состоит в чате | — |
thread_id |
Нет | integer |
Идентификатор треда (timestamp сообщения) | — |
(*) Параметры chat_id
и login
являются необязательными, но необходимо заполнить хотя бы один из двух.
Результат
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о результатах опроса.
Имя параметра | Обязательный | Тип | Описание |
---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
answers |
Да | map from int to int |
Результаты опроса, в формате ключ - номер варианта, значение - количество голосов |
voted_count |
Да | integer |
Количество проголосовавших в опросе |
Пример запроса
curl -H 'Authorization: OAuth AtXXXXXXXXXXX' 'https://botapi.messenger.yandex.net/bot/v1/polls/getResults?login=maria&message_id=1647523230504005'
Пример успешного ответа
{"ok": true, "voted_count": 5, "answers": {'1': 5, '2': 0}}
Пример ответа с ошибкой
{"ok": false, "description": "Bot is not a member of the chat"}
Была ли статья полезна?
Предыдущая
Следующая