Message.reply_poll()

Message.reply_poll()

Bound method reply_poll of Message.

Use as a shortcut for:

await client.send_poll(
    chat_id=message.chat.id,
    question="This is a poll",
    options=[
        PollOption("A"),
        PollOption("B"),
        PollOption("C")
    ]
)

Example

await message.reply_poll(
    "This is a poll",
    [
        PollOption("A"),
        PollOption("B"),
        PollOption("C")
    ]
)
Parameters:

  • 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.

  • quote (bool, optional) – If True, the message will be sent as a reply to this message. If reply_to_message_id is passed, this parameter will be ignored. Defaults to True in group chats and False in private chats.

  • 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.

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

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

  • reply_in_chat_id – Union[int, str] = None, Unique identifier of target chat. for reply message in another chat.

  • 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.

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

  • 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.

  • 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:

On success, the sent Message is returned.

Raises:

RPCError – In case of a Telegram RPC error.