{ "meta": {}, "group": { "title": "Available methods", "anchor": "available-methods" }, "object": { "anchor": "sendpoll", "name": "sendPoll", "description": "Use this method to send a native poll. On success, the sent Message is returned.", "html_description": "

Use this method to send a native poll. On success, the sent Message is returned.

", "rst_description": "Use this method to send a native poll. On success, the sent :class:`aiogram.types.message.Message` is returned.", "annotations": [ { "type": "String", "required": false, "description": "Unique identifier of the business connection on behalf of which the message will be sent", "html_description": "Unique identifier of the business connection on behalf of which the message will be sent", "rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n", "name": "business_connection_id" }, { "type": "Integer or String", "required": true, "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.", "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.", "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Polls can't be sent to channel direct messages chats.\n", "name": "chat_id" }, { "type": "Integer", "required": false, "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only", "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only", "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n", "name": "message_thread_id" }, { "type": "String", "required": true, "description": "Poll question, 1-300 characters", "html_description": "Poll question, 1-300 characters", "rst_description": "Poll question, 1-300 characters\n", "name": "question" }, { "type": "String", "required": false, "description": "Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed", "html_description": "Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed", "rst_description": "Mode for parsing entities in the question. See `formatting options `_ for more details. Currently, only custom emoji entities are allowed\n", "name": "question_parse_mode" }, { "type": "Array of MessageEntity", "required": false, "description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode", "html_description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode", "rst_description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question_parse_mode*\n", "name": "question_entities" }, { "type": "Array of InputPollOption", "required": true, "description": "A JSON-serialized list of 2-12 answer options", "html_description": "A JSON-serialized list of 2-12 answer options", "rst_description": "A JSON-serialized list of 2-12 answer options\n", "name": "options" }, { "type": "Boolean", "required": false, "description": "True, if the poll needs to be anonymous, defaults to True", "html_description": "True, if the poll needs to be anonymous, defaults to True", "rst_description": ":code:`True`, if the poll needs to be anonymous, defaults to :code:`True`\n", "name": "is_anonymous" }, { "type": "String", "required": false, "description": "Poll type, 'quiz' or 'regular', defaults to 'regular'", "html_description": "Poll type, “quiz” or “regular”, defaults to “regular”", "rst_description": "Poll type, 'quiz' or 'regular', defaults to 'regular'\n", "name": "type" }, { "type": "Boolean", "required": false, "description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False", "html_description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False", "rst_description": ":code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`\n", "name": "allows_multiple_answers" }, { "type": "Integer", "required": false, "description": "0-based identifier of the correct answer option, required for polls in quiz mode", "html_description": "0-based identifier of the correct answer option, required for polls in quiz mode", "rst_description": "0-based identifier of the correct answer option, required for polls in quiz mode\n", "name": "correct_option_id" }, { "type": "String", "required": false, "description": "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", "html_description": "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", "rst_description": "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\n", "name": "explanation" }, { "type": "String", "required": false, "description": "Mode for parsing entities in the explanation. See formatting options for more details.", "html_description": "Mode for parsing entities in the explanation. See formatting options for more details.", "rst_description": "Mode for parsing entities in the explanation. See `formatting options `_ for more details.\n", "name": "explanation_parse_mode" }, { "type": "Array of MessageEntity", "required": false, "description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode", "html_description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode", "rst_description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation_parse_mode*\n", "name": "explanation_entities" }, { "type": "Integer", "required": false, "description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.", "html_description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.", "rst_description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.\n", "name": "open_period" }, { "type": "Integer", "required": false, "description": "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.", "html_description": "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.", "rst_description": "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*.\n", "name": "close_date" }, { "type": "Boolean", "required": false, "description": "Pass True if the poll needs to be immediately closed. This can be useful for poll preview.", "html_description": "Pass True if the poll needs to be immediately closed. This can be useful for poll preview.", "rst_description": "Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.\n", "name": "is_closed" }, { "type": "Boolean", "required": false, "description": "Sends the message silently. Users will receive a notification with no sound.", "html_description": "Sends the message silently. Users will receive a notification with no sound.", "rst_description": "Sends the message `silently `_. Users will receive a notification with no sound.\n", "name": "disable_notification" }, { "type": "Boolean", "required": false, "description": "Protects the contents of the sent message from forwarding and saving", "html_description": "Protects the contents of the sent message from forwarding and saving", "rst_description": "Protects the contents of the sent message from forwarding and saving\n", "name": "protect_content" }, { "type": "Boolean", "required": false, "description": "Pass True to allow 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", "html_description": "Pass True to allow 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", "rst_description": "Pass :code:`True` to allow 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\n", "name": "allow_paid_broadcast" }, { "type": "String", "required": false, "description": "Unique identifier of the message effect to be added to the message; for private chats only", "html_description": "Unique identifier of the message effect to be added to the message; for private chats only", "rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n", "name": "message_effect_id" }, { "type": "ReplyParameters", "required": false, "description": "Description of the message to reply to", "html_description": "Description of the message to reply to", "rst_description": "Description of the message to reply to\n", "name": "reply_parameters" }, { "type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply", "required": false, "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "html_description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove a reply keyboard or to force a reply from the user\n", "name": "reply_markup" }, { "type": "Boolean", "required": false, "description": "Pass True if the message should be sent even if the specified replied-to message is not found", "html_description": "Pass True if the message should be sent even if the specified replied-to message is not found", "rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n", "name": "allow_sending_without_reply", "deprecated": { "version": "7.0", "release_date": "2023-12-29" } }, { "type": "Integer", "required": false, "description": "If the message is a reply, ID of the original message", "html_description": "If the message is a reply, ID of the original message", "rst_description": "If the message is a reply, ID of the original message\n", "name": "reply_to_message_id", "deprecated": { "version": "7.0", "release_date": "2023-12-29" } } ], "category": "methods" } }