send_poll()

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

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

  • options (List of str | InputPollOption) – List of answer options, 2-10 strings 1-100 characters each.

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

  • correct_option_ids (List of int, optional) – List of 0-based identifiers of the correct answer options, required for polls in quiz mode with multiple correct answers.

  • explanation (str | FormattedText, 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.

  • explanation_media (InputPollMedia, optional) – Media to display as part of the explanation.

  • description (FormattedText, optional) – Poll description.

  • description_media (InputPollMedia, optional) – Media to display as part of the description.

  • allows_revoting (bool, optional) – True, if the poll allows changing the vote.

  • members_only (bool, optional) – True, if only members of the chat can vote.

  • country_codes (List of str, optional) – List of country ISO2 codes for country-specific polls.

  • shuffle_options (bool, optional) – True, if the poll options should be shuffled.

  • allow_adding_options (bool, optional) – True, if users can add options to the poll.

  • hide_results_until_closes (bool, optional) – True, if the poll results are hidden until the poll closes.

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

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

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

  • reply_to_chat_id (int | str, optional) – Unique identifier for the chat to which the replied message belongs. Only applicable in combination with reply_to_message_id.

  • reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

  • message_thread_id (int, optional) – Unique identifier for a message thread in a forum topic.

  • allow_paid_broadcast (bool, optional) – If True, you will be allowed to send up to 1000 messages per second. Ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance. For bots only.

  • paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

  • business_connection_id (str, optional) – Unique identifier of the business connection.

  • quote_text (str, optional) – Text of the quote to reply to.

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

  • effect_id (int, optional) – Unique identifier of the effect to apply to the message.

  • show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

  • repeat_period (int, optional) – New period in seconds for the message to be sent repeatedly.

  • suggested_post_parameters (SuggestedPostParameters, optional) – Parameters of the suggested post.

  • direct_messages_topic_id (int, optional) – Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only.

  • background (bool, optional) – Send the message in background.

  • clear_draft (bool, optional) – Clear the draft of the chat.

  • update_stickersets_order (bool, optional) – Move the sticker set to the top of the list.

  • send_as (int | str, optional) – Unique identifier (int) or username (str) of the chat or channel to send the message as.

  • quick_reply_shortcut (int, optional) – Unique identifier of the quick reply shortcut the message belongs to.

Returns:

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

Example

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