sendPoll#
Returns: Message
- class aiogram.methods.send_poll.SendPoll(*, chat_id: Union[int, str], question: str, options: List[str], message_thread_id: Optional[int] = None, is_anonymous: Optional[bool] = None, type: Optional[str] = None, allows_multiple_answers: Optional[bool] = None, correct_option_id: Optional[int] = None, explanation: Optional[str] = None, explanation_parse_mode: Optional[str] = sentinel.UNSET, explanation_entities: Optional[List[MessageEntity]] = None, open_period: Optional[int] = None, close_date: Optional[Union[datetime, timedelta, int]] = None, is_closed: Optional[bool] = None, disable_notification: Optional[bool] = None, protect_content: Optional[bool] = None, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: Optional[bool] = None, reply_markup: Optional[Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]] = None, **extra_data: Any)[source]#
Use this method to send a native poll. On success, the sent
aiogram.types.message.Message
is returned.Source: https://core.telegram.org/bots/api#sendpoll
- chat_id: Union[int, str]#
Unique identifier for the target chat or username of the target channel (in the format
@channelusername
)
- question: str#
Poll question, 1-300 characters
- options: List[str]#
A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
- message_thread_id: Optional[int]#
Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
- is_anonymous: Optional[bool]#
True
, if the poll needs to be anonymous, defaults toTrue
- type: Optional[str]#
Poll type, ‘quiz’ or ‘regular’, defaults to ‘regular’
- allows_multiple_answers: Optional[bool]#
True
, if the poll allows multiple answers, ignored for polls in quiz mode, defaults toFalse
- correct_option_id: Optional[int]#
0-based identifier of the correct answer option, required for polls in quiz mode
- explanation: Optional[str]#
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: Optional[str]#
Mode for parsing entities in the explanation. See formatting options for more details.
- explanation_entities: Optional[List[MessageEntity]]#
A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode
- open_period: Optional[int]#
Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date.
- close_date: Optional[Union[datetime, timedelta, int]]#
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: Optional[bool]#
Pass
True
if the poll needs to be immediately closed. This can be useful for poll preview.
- disable_notification: Optional[bool]#
Sends the message silently. Users will receive a notification with no sound.
- protect_content: Optional[bool]#
Protects the contents of the sent message from forwarding and saving
- reply_to_message_id: Optional[int]#
If the message is a reply, ID of the original message
- allow_sending_without_reply: Optional[bool]#
Pass
True
if the message should be sent even if the specified replied-to message is not found
- reply_markup: Optional[Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]]#
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.
Usage#
As bot method#
result: Message = await bot.send_poll(...)
Method as object#
Imports:
from aiogram.methods.send_poll import SendPoll
alias:
from aiogram.methods import SendPoll
With specific bot#
result: Message = await bot(SendPoll(...))
As reply into Webhook in handler#
return SendPoll(...)