Создание опроса
Метод позволяет создавать опросы.
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/messages/createPoll/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
chat_id |
Нет* | string |
ID группового чата | Бот должен быть участником чата |
login |
Нет* | string |
Логин пользователя | — |
title |
Да | string |
Заголовок опроса | — |
answers |
Да | array of string |
Варианты ответа для опроса | В списке должно быть не менее двух элементов |
max_choices |
Нет | integer |
Максимальное количество возможных ответов | Положительное число. Значение по умолчанию: 1 |
is_anonymous |
Нет | boolean |
Является ли опрос анонимным | Значение по умолчанию: false |
payload_id |
Нет | string |
ID запроса | ID должен быть уникальным для каждого запроса. Запросы с одинаковым ID трактуются как дубликаты |
reply_message_id |
Нет | integer |
ID сообщения, на которое будет ответ | Сообщение должно быть из того же чата |
disable_notification |
Нет | boolean |
Нужно ли отключить уведомление | Значение по умолчанию: false |
important |
Нет | boolean |
Является ли сообщение важным | Значение по умолчанию: false |
disable_web_page_preview |
Нет | boolean |
Отключить раскрытие ссылок в сообщении | Значение по умолчанию: false |
thread_id |
Нет | integer |
Идентификатор треда (timestamp сообщения) | — |
(*) Параметры chat_id и login являются необязательными, но необходимо заполнить хотя бы один из двух:
- При заполнении
chat_idсообщение с опросом будет отправлено в групповой чат, заданный этим ID. - При заполнении
loginсообщение с опросом будет отправлено пользователю в приватный чат.
Ограничения
- Бот может отправлять сообщения только в те чаты, в которых он является участником или админом.
- Бот не может отправлять личные сообщения пользователям, для которых это запрещено настройками приватности.
- Бот не может отправлять личные сообщения пользователям вне своей организации.
Результат
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация об отправленном сообщении с опросом.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
message_id |
Да | integer |
ID сообщения с опросом в чате |
В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
description |
Да | string |
Описание ошибки |
Пример запроса
curl -X POST -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" -d '{"chat_id":"0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9", "title": "Вам нравится этот опрос?", "answers": ["Да!", "Не очень"], "is_anonymous": "true"}' 'https://botapi.messenger.yandex.net/bot/v1/messages/createPoll/'
Пример успешного ответа
{"ok": true, "message_id": 1647523230504005}
Пример ответа с ошибкой
{"ok": false, "description": "answers: ["Ensure this field has at least 2 elements."]"}
Была ли статья полезна?
Предыдущая
Следующая