send_poll()

Client.send_poll()

Send a new poll.

Usable by Users Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str). You can also use chat public link in form of t.me/<username> (str).

  • question (str) – Poll question, 1-255 characters.

  • options (List of PollOption) – List of PollOption.

  • question_entities (List of MessageEntity, optional) – List of special entities that appear in the poll question, which can be specified instead of parse_mode.

  • is_anonymous (bool, optional) – True, if the poll needs to be anonymous. Defaults to True.

  • type ( – obj`~pyrogram.enums.PollType`, optional): Poll type, QUIZ or REGULAR. Defaults to REGULAR.

  • allows_multiple_answers (bool, optional) – True, if the poll allows multiple answers, ignored for polls in quiz mode. Defaults to False.

  • correct_option_id (int, optional) – 0-based identifier of the correct answer option, required for polls in quiz mode.

  • explanation (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 (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • explanation_entities (List of MessageEntity) – List of special entities that appear in the poll explanation, which can be specified instead of parse_mode.

  • open_period (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 (datetime, optional) – Point in time 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, optional) – Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.

  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

  • protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

  • allow_paid_broadcast (bool, optional) – Pass True to allow the message to ignore regular broadcast limits for a small fee; for bots only

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. for forum supergroups only.

  • business_connection_id (str, optional) – Business connection identifier. for business bots only.

  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

  • reply_to_chat_id (int | str, optional) – Unique identifier for the origin chat. for reply to message from another chat. You can also use chat public link in form of t.me/<username> (str).

  • quote_text (str, optional) – Text to quote. for reply_to_message only.

  • quote_entities (List of MessageEntity, optional) – List of special entities that appear in quote_text, which can be specified instead of parse_mode. for reply_to_message only.

  • parse_mode (ParseMode, optional) – By default, quote_text are parsed using both Markdown and HTML styles. You can combine both syntaxes together. For quote_text.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • message_effect_id (int 64-bit, optional) – Unique identifier of the message effect to be added to the message; for private chats only.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Returns:

Message – On success, the sent poll message is returned.

Example

from pyrogram.types import PollOption

await app.send_poll(
    chat_id,
    "Is this a poll question?",
    [
        PollOption("Yes"),
        PollOption("No"),
        PollOption("Maybe")
    ]
)