sendPoll#

Returns: Message

class aiogram.methods.send_poll.SendPoll(*, chat_id: int | str, question: str, options: ~typing.List[str], message_thread_id: int | None = None, is_anonymous: bool | None = None, type: str | None = None, allows_multiple_answers: bool | None = None, correct_option_id: int | None = None, explanation: str | None = None, explanation_parse_mode: str | ~aiogram.client.default.Default | None = <Default('parse_mode')>, explanation_entities: ~typing.List[~aiogram.types.message_entity.MessageEntity] | None = None, open_period: int | None = None, close_date: ~datetime.datetime | ~datetime.timedelta | int | None = None, is_closed: bool | None = None, disable_notification: bool | None = None, protect_content: bool | ~aiogram.client.default.Default | None = <Default('protect_content')>, reply_parameters: ~aiogram.types.reply_parameters.ReplyParameters | None = None, reply_markup: ~aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup | ~aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup | ~aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove | ~aiogram.types.force_reply.ForceReply | None = None, allow_sending_without_reply: bool | None = None, reply_to_message_id: int | None = None, **extra_data: ~typing.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: 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: int | None#

Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

is_anonymous: bool | None#

True, if the poll needs to be anonymous, defaults to True

type: str | None#

Poll type, ‘quiz’ or ‘regular’, defaults to ‘regular’

allows_multiple_answers: bool | None#

True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False

correct_option_id: int | None#

0-based identifier of the correct answer option, required for polls in quiz mode

explanation: str | None#

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: str | Default | None#

Mode for parsing entities in the explanation. See formatting options for more details.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

explanation_entities: List[MessageEntity] | None#

A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode

open_period: int | None#

Amount of time in seconds the poll will be active after creation, 5-600. Can’t be used together with close_date.

close_date: datetime.datetime | datetime.timedelta | int | None#

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: bool | None#

Pass True if the poll needs to be immediately closed. This can be useful for poll preview.

disable_notification: bool | None#

Sends the message silently. Users will receive a notification with no sound.

protect_content: bool | Default | None#

Protects the contents of the sent message from forwarding and saving

reply_parameters: ReplyParameters | None#

Description of the message to reply to

reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | None#

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.

allow_sending_without_reply: bool | None#

Pass True if the message should be sent even if the specified replied-to message is not found

reply_to_message_id: int | None#

If the message is a reply, ID of the original message

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(...)

As shortcut from received object#