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
) – Poll question, 1-255 characters.options (List of
str
) – List of answer options, 2-10 strings 1-100 characters each.message_thread_id (
int
, optional) – Unique identifier for the target message thread (topic) of the forum. for forum supergroups only.is_anonymous (
bool
, optional) – True, if the poll needs to be anonymous. Defaults to True.type ( – obj`~hydrogram.enums.PollType`, optional): Poll type,
QUIZ
orREGULAR
. Defaults toREGULAR
.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.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.
- 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"])