mirror of https://github.com/aiogram/aiogram.git synced 2025-12-11 18:01:04 +00:00

Alex Root Junior 6be0b36305

* AIOG-T-20 Bot API 4.8

* AIOG-T-20 Update aliases

* AIOG-T-20 Add parse mode passing in sendPoll method

* AIOG-T-20 Small changes in docs

* AIOG-T-20 Revert overriding remove keyboard default value and add tests

* AIOG-T-20 Bot API 4.8

2020-05-02 23:01:32 +03:00

3.5 KiB

Raw Blame History

sendPoll

Description

Use this method to send a native poll. On success, the sent Message is returned.

Arguments

Name	Type	Description
`chat_id`	`#!python3 Union[int, str]`	Unique identifier for the target chat or username of the target channel (in the format @channelusername)
`question`	`#!python3 str`	Poll question, 1-255 characters
`options`	`#!python3 List[str]`	A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
`is_anonymous`	`#!python3 Optional[bool]`	Optional. True, if the poll needs to be anonymous, defaults to True
`type`	`#!python3 Optional[str]`	Optional. Poll type, 'quiz' or 'regular', defaults to 'regular'
`allows_multiple_answers`	`#!python3 Optional[bool]`	Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False
`correct_option_id`	`#!python3 Optional[int]`	Optional. 0-based identifier of the correct answer option, required for polls in quiz mode
`explanation`	`#!python3 Optional[str]`	Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
`explanation_parse_mode`	`#!python3 Optional[str]`	Optional. Mode for parsing entities in the explanation. See formatting options for more details.
`open_period`	`#!python3 Optional[int]`	Optional. Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
`close_date`	`#!python3 Optional[Union[datetime.datetime, datetime.timedelta, int]]`	Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.
`is_closed`	`#!python3 Optional[bool]`	Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.
`disable_notification`	`#!python3 Optional[bool]`	Optional. Sends the message silently. Users will receive a notification with no sound.
`reply_to_message_id`	`#!python3 Optional[int]`	Optional. If the message is a reply, ID of the original message
`reply_markup`	`#!python3 Optional[Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]]`	Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Response

Type: #!python3 Message

Description: On success, the sent Message is returned.

Usage

As bot method

result: Message = await bot.send_poll(...)

Method as object

Imports:

from aiogram.methods import SendPoll
from aiogram.api.methods import SendPoll
from aiogram.api.methods.send_poll import SendPoll

In handlers with current bot

result: Message = await SendPoll(...)

With specific bot

result: Message = await bot(SendPoll(...))

As reply into Webhook in handler

return SendPoll(...)

3.5 KiB Raw Blame History