` links only in chats with the user\n",
"name": "has_private_forwards",
"required": false
},
{
"type": "True",
- "description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.",
- "html_description": "| Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat",
+ "html_description": "Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat | ",
+ "rst_description": "*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat\n",
"name": "has_restricted_voice_and_video_messages",
"required": false
},
{
"type": "True",
- "description": "True, if users need to join the supergroup before they can send messages. Returned only in getChat.",
- "html_description": "Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if users need to join the supergroup before they can send messages",
+ "html_description": "Optional. True, if users need to join the supergroup before they can send messages | ",
+ "rst_description": "*Optional*. :code:`True`, if users need to join the supergroup before they can send messages\n",
"name": "join_to_send_messages",
"required": false
},
{
"type": "True",
- "description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.",
- "html_description": "Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators",
+ "html_description": "Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators | ",
+ "rst_description": "*Optional*. :code:`True`, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators\n",
"name": "join_by_request",
"required": false
},
{
"type": "String",
- "description": "Description, for groups, supergroups and channel chats. Returned only in getChat.",
- "html_description": "Optional. Description, for groups, supergroups and channel chats. Returned only in getChat. | ",
- "rst_description": "*Optional*. Description, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "Description, for groups, supergroups and channel chats",
+ "html_description": "Optional. Description, for groups, supergroups and channel chats | ",
+ "rst_description": "*Optional*. Description, for groups, supergroups and channel chats\n",
"name": "description",
"required": false
},
{
"type": "String",
- "description": "Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.",
- "html_description": "Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat. | ",
- "rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "Primary invite link, for groups, supergroups and channel chats",
+ "html_description": "Optional. Primary invite link, for groups, supergroups and channel chats | ",
+ "rst_description": "*Optional*. Primary invite link, for groups, supergroups and channel chats\n",
"name": "invite_link",
"required": false
},
{
"type": "Message",
- "description": "The most recent pinned message (by sending date). Returned only in getChat.",
- "html_description": "Optional. The most recent pinned message (by sending date). Returned only in getChat. | ",
- "rst_description": "*Optional*. The most recent pinned message (by sending date). Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "The most recent pinned message (by sending date)",
+ "html_description": "Optional. The most recent pinned message (by sending date) | ",
+ "rst_description": "*Optional*. The most recent pinned message (by sending date)\n",
"name": "pinned_message",
"required": false
},
{
"type": "ChatPermissions",
- "description": "Default chat member permissions, for groups and supergroups. Returned only in getChat.",
- "html_description": "Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat. | ",
- "rst_description": "*Optional*. Default chat member permissions, for groups and supergroups. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "Default chat member permissions, for groups and supergroups",
+ "html_description": "Optional. Default chat member permissions, for groups and supergroups | ",
+ "rst_description": "*Optional*. Default chat member permissions, for groups and supergroups\n",
"name": "permissions",
"required": false
},
{
"type": "Integer",
- "description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.",
- "html_description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat. | ",
- "rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds",
+ "html_description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds | ",
+ "rst_description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds\n",
"name": "slow_mode_delay",
"required": false
},
{
"type": "Integer",
- "description": "For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.",
- "html_description": "Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat. | ",
- "rst_description": "*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions",
+ "html_description": "Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions | ",
+ "rst_description": "*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions\n",
"name": "unrestrict_boost_count",
"required": false
},
{
"type": "Integer",
- "description": "The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.",
- "html_description": "Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat. | ",
- "rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "The time after which all messages sent to the chat will be automatically deleted; in seconds",
+ "html_description": "Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds | ",
+ "rst_description": "*Optional*. The time after which all messages sent to the chat will be automatically deleted; in seconds\n",
"name": "message_auto_delete_time",
"required": false
},
{
"type": "True",
- "description": "True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.",
- "html_description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.",
+ "html_description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. | ",
+ "rst_description": "*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.\n",
"name": "has_aggressive_anti_spam_enabled",
"required": false
},
{
"type": "True",
- "description": "True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.",
- "html_description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if non-administrators can only get the list of bots and administrators in the chat. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if non-administrators can only get the list of bots and administrators in the chat",
+ "html_description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat | ",
+ "rst_description": "*Optional*. :code:`True`, if non-administrators can only get the list of bots and administrators in the chat\n",
"name": "has_hidden_members",
"required": false
},
{
"type": "True",
- "description": "True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.",
- "html_description": "Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if messages from the chat can't be forwarded to other chats",
+ "html_description": "Optional. True, if messages from the chat can't be forwarded to other chats | ",
+ "rst_description": "*Optional*. :code:`True`, if messages from the chat can't be forwarded to other chats\n",
"name": "has_protected_content",
"required": false
},
{
"type": "True",
- "description": "True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.",
- "html_description": "Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if new chat members will have access to old messages; available only to chat administrators",
+ "html_description": "Optional. True, if new chat members will have access to old messages; available only to chat administrators | ",
+ "rst_description": "*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators\n",
"name": "has_visible_history",
"required": false
},
{
"type": "String",
- "description": "For supergroups, name of group sticker set. Returned only in getChat.",
- "html_description": "Optional. For supergroups, name of group sticker set. Returned only in getChat. | ",
- "rst_description": "*Optional*. For supergroups, name of group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "For supergroups, name of the group sticker set",
+ "html_description": "Optional. For supergroups, name of the group sticker set | ",
+ "rst_description": "*Optional*. For supergroups, name of the group sticker set\n",
"name": "sticker_set_name",
"required": false
},
{
"type": "True",
- "description": "True, if the bot can change the group sticker set. Returned only in getChat.",
- "html_description": "Optional. True, if the bot can change the group sticker set. Returned only in getChat. | ",
- "rst_description": "*Optional*. :code:`True`, if the bot can change the group sticker set. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "True, if the bot can change the group sticker set",
+ "html_description": "Optional. True, if the bot can change the group sticker set | ",
+ "rst_description": "*Optional*. :code:`True`, if the bot can change the group sticker set\n",
"name": "can_set_sticker_set",
"required": false
},
{
"type": "String",
- "description": "For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat.",
- "html_description": "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat. | ",
- "rst_description": "*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.",
+ "html_description": "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. | ",
+ "rst_description": "*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.\n",
"name": "custom_emoji_sticker_set_name",
"required": false
},
{
"type": "Integer",
- "description": "Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.",
- "html_description": "Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat. | ",
- "rst_description": "*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.",
+ "html_description": "Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. | ",
+ "rst_description": "*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.\n",
"name": "linked_chat_id",
"required": false
},
{
"type": "ChatLocation",
- "description": "For supergroups, the location to which the supergroup is connected. Returned only in getChat.",
- "html_description": "Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat. | ",
- "rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected. Returned only in :class:`aiogram.methods.get_chat.GetChat`.\n",
+ "description": "For supergroups, the location to which the supergroup is connected",
+ "html_description": "Optional. For supergroups, the location to which the supergroup is connected | ",
+ "rst_description": "*Optional*. For supergroups, the location to which the supergroup is connected\n",
"name": "location",
"required": false
}
@@ -845,6 +999,14 @@
"name": "sender_boost_count",
"required": false
},
+ {
+ "type": "User",
+ "description": "The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.",
+ "html_description": "Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. | ",
+ "rst_description": "*Optional*. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.\n",
+ "name": "sender_business_bot",
+ "required": false
+ },
{
"type": "Integer",
"description": "Date the message was sent in Unix time. It is always a positive number, representing a valid date.",
@@ -853,6 +1015,14 @@
"name": "date",
"required": true
},
+ {
+ "type": "String",
+ "description": "Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.",
+ "html_description": "Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier. | ",
+ "rst_description": "*Optional*. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.\n",
+ "name": "business_connection_id",
+ "required": false
+ },
{
"type": "Chat",
"description": "Chat the message belongs to",
@@ -941,6 +1111,14 @@
"name": "has_protected_content",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message",
+ "html_description": "Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message | ",
+ "rst_description": "*Optional*. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message\n",
+ "name": "is_from_offline",
+ "required": false
+ },
{
"type": "String",
"description": "The unique identifier of a media message group this message belongs to",
@@ -981,6 +1159,14 @@
"name": "link_preview_options",
"required": false
},
+ {
+ "type": "String",
+ "description": "Unique identifier of the message effect added to the message",
+ "html_description": "Optional. Unique identifier of the message effect added to the message | ",
+ "rst_description": "*Optional*. Unique identifier of the message effect added to the message\n",
+ "name": "effect_id",
+ "required": false
+ },
{
"type": "Animation",
"description": "Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set",
@@ -1069,6 +1255,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "True",
+ "description": "True, if the caption must be shown above the message media",
+ "html_description": "Optional. True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. True, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "True",
"description": "True, if the message media is covered by a spoiler animation",
@@ -1293,6 +1487,14 @@
"name": "boost_added",
"required": false
},
+ {
+ "type": "ChatBackground",
+ "description": "Service message: chat background set",
+ "html_description": "Optional. Service message: chat background set | ",
+ "rst_description": "*Optional*. Service message: chat background set\n",
+ "name": "chat_background_set",
+ "required": false
+ },
{
"type": "ForumTopicCreated",
"description": "Service message: forum topic created",
@@ -1494,9 +1696,9 @@
"annotations": [
{
"type": "String",
- "description": "Type of the entity. Currently, can be 'mention' (@username), 'hashtag' (#hashtag), 'cashtag' ($USD), 'bot_command' (/start@jobs_bot), 'url' (https://telegram.org), 'email' (do-not-reply@telegram.org), 'phone_number' (+1-212-555-0123), 'bold' (bold text), 'italic' (italic text), 'underline' (underlined text), 'strikethrough' (strikethrough text), 'spoiler' (spoiler message), 'blockquote' (block quotation), 'code' (monowidth string), 'pre' (monowidth block), 'text_link' (for clickable text URLs), 'text_mention' (for users without usernames), 'custom_emoji' (for inline custom emoji stickers)",
- "html_description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) | ",
- "rst_description": "Type of the entity. Currently, can be 'mention' (:code:`@username`), 'hashtag' (:code:`#hashtag`), 'cashtag' (:code:`$USD`), 'bot_command' (:code:`/start@jobs_bot`), 'url' (:code:`https://telegram.org`), 'email' (:code:`do-not-reply@telegram.org`), 'phone_number' (:code:`+1-212-555-0123`), 'bold' (**bold text**), 'italic' (*italic text*), 'underline' (underlined text), 'strikethrough' (strikethrough text), 'spoiler' (spoiler message), 'blockquote' (block quotation), 'code' (monowidth string), 'pre' (monowidth block), 'text_link' (for clickable text URLs), 'text_mention' (for users `without usernames `_), 'custom_emoji' (for inline custom emoji stickers)\n",
+ "description": "Type of the entity. Currently, can be 'mention' (@username), 'hashtag' (#hashtag), 'cashtag' ($USD), 'bot_command' (/start@jobs_bot), 'url' (https://telegram.org), 'email' (do-not-reply@telegram.org), 'phone_number' (+1-212-555-0123), 'bold' (bold text), 'italic' (italic text), 'underline' (underlined text), 'strikethrough' (strikethrough text), 'spoiler' (spoiler message), 'blockquote' (block quotation), 'expandable_blockquote' (collapsed-by-default block quotation), 'code' (monowidth string), 'pre' (monowidth block), 'text_link' (for clickable text URLs), 'text_mention' (for users without usernames), 'custom_emoji' (for inline custom emoji stickers)",
+ "html_description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) | ",
+ "rst_description": "Type of the entity. Currently, can be 'mention' (:code:`@username`), 'hashtag' (:code:`#hashtag`), 'cashtag' (:code:`$USD`), 'bot_command' (:code:`/start@jobs_bot`), 'url' (:code:`https://telegram.org`), 'email' (:code:`do-not-reply@telegram.org`), 'phone_number' (:code:`+1-212-555-0123`), 'bold' (**bold text**), 'italic' (*italic text*), 'underline' (underlined text), 'strikethrough' (strikethrough text), 'spoiler' (spoiler message), 'blockquote' (block quotation), 'expandable_blockquote' (collapsed-by-default block quotation), 'code' (monowidth string), 'pre' (monowidth block), 'text_link' (for clickable text URLs), 'text_mention' (for users `without usernames `_), 'custom_emoji' (for inline custom emoji stickers)\n",
"name": "type",
"required": true
},
@@ -1804,17 +2006,17 @@
},
{
"type": "Integer or String",
- "description": "If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername)",
- "html_description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername) | ",
- "rst_description": "*Optional*. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format :code:`@channelusername`)\n",
+ "description": "If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account.",
+ "html_description": "Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. | ",
+ "rst_description": "*Optional*. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format :code:`@channelusername`). Not supported for messages sent on behalf of a business account.\n",
"name": "chat_id",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic.",
- "html_description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic. | ",
- "rst_description": "*Optional*. Pass :code:`True` if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic.\n",
+ "description": "Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.",
+ "html_description": "Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the message should be sent even if the specified message to be replied to is not found. Always :code:`False` for replies in another chat or forum topic. Always :code:`True` for messages sent on behalf of a business account.\n",
"name": "allow_sending_without_reply",
"required": false
},
@@ -2601,6 +2803,14 @@
"name": "text",
"required": true
},
+ {
+ "type": "Array of MessageEntity",
+ "description": "Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts",
+ "html_description": "Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts | ",
+ "rst_description": "*Optional*. Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts\n",
+ "name": "text_entities",
+ "required": false
+ },
{
"type": "Integer",
"description": "Number of users that voted for this option",
@@ -2612,6 +2822,40 @@
],
"category": "types"
},
+ {
+ "anchor": "inputpolloption",
+ "name": "InputPollOption",
+ "description": "This object contains information about one answer option in a poll to send.",
+ "html_description": "This object contains information about one answer option in a poll to send.
",
+ "rst_description": "This object contains information about one answer option in a poll to send.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Option text, 1-100 characters",
+ "html_description": "Option text, 1-100 characters | ",
+ "rst_description": "Option text, 1-100 characters\n",
+ "name": "text",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed",
+ "html_description": "Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed | ",
+ "rst_description": "*Optional*. Mode for parsing entities in the text. See `formatting options `_ for more details. Currently, only custom emoji entities are allowed\n",
+ "name": "text_parse_mode",
+ "required": false
+ },
+ {
+ "type": "Array of MessageEntity",
+ "description": "A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode",
+ "html_description": "Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode | ",
+ "rst_description": "*Optional*. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of *text_parse_mode*\n",
+ "name": "text_entities",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "pollanswer",
"name": "PollAnswer",
@@ -2677,6 +2921,14 @@
"name": "question",
"required": true
},
+ {
+ "type": "Array of MessageEntity",
+ "description": "Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions",
+ "html_description": "Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions | ",
+ "rst_description": "*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions\n",
+ "name": "question_entities",
+ "required": false
+ },
{
"type": "Array of PollOption",
"description": "List of poll options",
@@ -2775,14 +3027,6 @@
"html_description": "This object represents a point on the map.
",
"rst_description": "This object represents a point on the map.",
"annotations": [
- {
- "type": "Float",
- "description": "Longitude as defined by sender",
- "html_description": "Longitude as defined by sender | ",
- "rst_description": "Longitude as defined by sender\n",
- "name": "longitude",
- "required": true
- },
{
"type": "Float",
"description": "Latitude as defined by sender",
@@ -2791,6 +3035,14 @@
"name": "latitude",
"required": true
},
+ {
+ "type": "Float",
+ "description": "Longitude as defined by sender",
+ "html_description": "Longitude as defined by sender | ",
+ "rst_description": "Longitude as defined by sender\n",
+ "name": "longitude",
+ "required": true
+ },
{
"type": "Float",
"description": "The radius of uncertainty for the location, measured in meters; 0-1500",
@@ -2988,6 +3240,304 @@
],
"category": "types"
},
+ {
+ "anchor": "backgroundfill",
+ "name": "BackgroundFill",
+ "description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n - BackgroundFillSolid\n - BackgroundFillGradient\n - BackgroundFillFreeformGradient",
+ "html_description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of
",
+ "rst_description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n\n - :class:`aiogram.types.background_fill_solid.BackgroundFillSolid`\n - :class:`aiogram.types.background_fill_gradient.BackgroundFillGradient`\n - :class:`aiogram.types.background_fill_freeform_gradient.BackgroundFillFreeformGradient`",
+ "annotations": [],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundfillsolid",
+ "name": "BackgroundFillSolid",
+ "description": "The background is filled using the selected color.",
+ "html_description": "The background is filled using the selected color.
",
+ "rst_description": "The background is filled using the selected color.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background fill, always 'solid'",
+ "html_description": "Type of the background fill, always “solid” | ",
+ "rst_description": "Type of the background fill, always 'solid'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The color of the background fill in the RGB24 format",
+ "html_description": "The color of the background fill in the RGB24 format | ",
+ "rst_description": "The color of the background fill in the RGB24 format\n",
+ "name": "color",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundfillgradient",
+ "name": "BackgroundFillGradient",
+ "description": "The background is a gradient fill.",
+ "html_description": "The background is a gradient fill.
",
+ "rst_description": "The background is a gradient fill.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background fill, always 'gradient'",
+ "html_description": "Type of the background fill, always “gradient” | ",
+ "rst_description": "Type of the background fill, always 'gradient'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Top color of the gradient in the RGB24 format",
+ "html_description": "Top color of the gradient in the RGB24 format | ",
+ "rst_description": "Top color of the gradient in the RGB24 format\n",
+ "name": "top_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Bottom color of the gradient in the RGB24 format",
+ "html_description": "Bottom color of the gradient in the RGB24 format | ",
+ "rst_description": "Bottom color of the gradient in the RGB24 format\n",
+ "name": "bottom_color",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Clockwise rotation angle of the background fill in degrees; 0-359",
+ "html_description": "Clockwise rotation angle of the background fill in degrees; 0-359 | ",
+ "rst_description": "Clockwise rotation angle of the background fill in degrees; 0-359\n",
+ "name": "rotation_angle",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundfillfreeformgradient",
+ "name": "BackgroundFillFreeformGradient",
+ "description": "The background is a freeform gradient that rotates after every message in the chat.",
+ "html_description": "The background is a freeform gradient that rotates after every message in the chat.
",
+ "rst_description": "The background is a freeform gradient that rotates after every message in the chat.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background fill, always 'freeform_gradient'",
+ "html_description": "Type of the background fill, always “freeform_gradient” | ",
+ "rst_description": "Type of the background fill, always 'freeform_gradient'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Array of Integer",
+ "description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format",
+ "html_description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format | ",
+ "rst_description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format\n",
+ "name": "colors",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundtype",
+ "name": "BackgroundType",
+ "description": "This object describes the type of a background. Currently, it can be one of\n - BackgroundTypeFill\n - BackgroundTypeWallpaper\n - BackgroundTypePattern\n - BackgroundTypeChatTheme",
+ "html_description": "This object describes the type of a background. Currently, it can be one of
",
+ "rst_description": "This object describes the type of a background. Currently, it can be one of\n\n - :class:`aiogram.types.background_type_fill.BackgroundTypeFill`\n - :class:`aiogram.types.background_type_wallpaper.BackgroundTypeWallpaper`\n - :class:`aiogram.types.background_type_pattern.BackgroundTypePattern`\n - :class:`aiogram.types.background_type_chat_theme.BackgroundTypeChatTheme`",
+ "annotations": [],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundtypefill",
+ "name": "BackgroundTypeFill",
+ "description": "The background is automatically filled based on the selected colors.",
+ "html_description": "The background is automatically filled based on the selected colors.
",
+ "rst_description": "The background is automatically filled based on the selected colors.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background, always 'fill'",
+ "html_description": "Type of the background, always “fill” | ",
+ "rst_description": "Type of the background, always 'fill'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "BackgroundFill",
+ "description": "The background fill",
+ "html_description": "The background fill | ",
+ "rst_description": "The background fill\n",
+ "name": "fill",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Dimming of the background in dark themes, as a percentage; 0-100",
+ "html_description": "Dimming of the background in dark themes, as a percentage; 0-100 | ",
+ "rst_description": "Dimming of the background in dark themes, as a percentage; 0-100\n",
+ "name": "dark_theme_dimming",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundtypewallpaper",
+ "name": "BackgroundTypeWallpaper",
+ "description": "The background is a wallpaper in the JPEG format.",
+ "html_description": "The background is a wallpaper in the JPEG format.
",
+ "rst_description": "The background is a wallpaper in the JPEG format.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background, always 'wallpaper'",
+ "html_description": "Type of the background, always “wallpaper” | ",
+ "rst_description": "Type of the background, always 'wallpaper'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Document",
+ "description": "Document with the wallpaper",
+ "html_description": "Document with the wallpaper | ",
+ "rst_description": "Document with the wallpaper\n",
+ "name": "document",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Dimming of the background in dark themes, as a percentage; 0-100",
+ "html_description": "Dimming of the background in dark themes, as a percentage; 0-100 | ",
+ "rst_description": "Dimming of the background in dark themes, as a percentage; 0-100\n",
+ "name": "dark_theme_dimming",
+ "required": true
+ },
+ {
+ "type": "True",
+ "description": "True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12",
+ "html_description": "Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12 | ",
+ "rst_description": "*Optional*. :code:`True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12\n",
+ "name": "is_blurred",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the background moves slightly when the device is tilted",
+ "html_description": "Optional. True, if the background moves slightly when the device is tilted | ",
+ "rst_description": "*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
+ "name": "is_moving",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundtypepattern",
+ "name": "BackgroundTypePattern",
+ "description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
+ "html_description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
",
+ "rst_description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background, always 'pattern'",
+ "html_description": "Type of the background, always “pattern” | ",
+ "rst_description": "Type of the background, always 'pattern'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "Document",
+ "description": "Document with the pattern",
+ "html_description": "Document with the pattern | ",
+ "rst_description": "Document with the pattern\n",
+ "name": "document",
+ "required": true
+ },
+ {
+ "type": "BackgroundFill",
+ "description": "The background fill that is combined with the pattern",
+ "html_description": "The background fill that is combined with the pattern | ",
+ "rst_description": "The background fill that is combined with the pattern\n",
+ "name": "fill",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Intensity of the pattern when it is shown above the filled background; 0-100",
+ "html_description": "Intensity of the pattern when it is shown above the filled background; 0-100 | ",
+ "rst_description": "Intensity of the pattern when it is shown above the filled background; 0-100\n",
+ "name": "intensity",
+ "required": true
+ },
+ {
+ "type": "True",
+ "description": "True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only",
+ "html_description": "Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only | ",
+ "rst_description": "*Optional*. :code:`True`, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only\n",
+ "name": "is_inverted",
+ "required": false
+ },
+ {
+ "type": "True",
+ "description": "True, if the background moves slightly when the device is tilted",
+ "html_description": "Optional. True, if the background moves slightly when the device is tilted | ",
+ "rst_description": "*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
+ "name": "is_moving",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "backgroundtypechattheme",
+ "name": "BackgroundTypeChatTheme",
+ "description": "The background is taken directly from a built-in chat theme.",
+ "html_description": "The background is taken directly from a built-in chat theme.
",
+ "rst_description": "The background is taken directly from a built-in chat theme.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Type of the background, always 'chat_theme'",
+ "html_description": "Type of the background, always “chat_theme” | ",
+ "rst_description": "Type of the background, always 'chat_theme'\n",
+ "name": "type",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "Name of the chat theme, which is usually an emoji",
+ "html_description": "Name of the chat theme, which is usually an emoji | ",
+ "rst_description": "Name of the chat theme, which is usually an emoji\n",
+ "name": "theme_name",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "chatbackground",
+ "name": "ChatBackground",
+ "description": "This object represents a chat background.",
+ "html_description": "This object represents a chat background.
",
+ "rst_description": "This object represents a chat background.",
+ "annotations": [
+ {
+ "type": "BackgroundType",
+ "description": "Type of the background",
+ "html_description": "Type of the background | ",
+ "rst_description": "Type of the background\n",
+ "name": "type",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "forumtopiccreated",
"name": "ForumTopicCreated",
@@ -3084,6 +3634,56 @@
"annotations": [],
"category": "types"
},
+ {
+ "anchor": "shareduser",
+ "name": "SharedUser",
+ "description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.",
+ "html_description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
",
+ "rst_description": "This object contains information about a user that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_users.KeyboardButtonRequestUsers` button.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.",
+ "html_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. | ",
+ "rst_description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.\n",
+ "name": "user_id",
+ "required": true
+ },
+ {
+ "type": "String",
+ "description": "First name of the user, if the name was requested by the bot",
+ "html_description": "Optional. First name of the user, if the name was requested by the bot | ",
+ "rst_description": "*Optional*. First name of the user, if the name was requested by the bot\n",
+ "name": "first_name",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Last name of the user, if the name was requested by the bot",
+ "html_description": "Optional. Last name of the user, if the name was requested by the bot | ",
+ "rst_description": "*Optional*. Last name of the user, if the name was requested by the bot\n",
+ "name": "last_name",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Username of the user, if the username was requested by the bot",
+ "html_description": "Optional. Username of the user, if the username was requested by the bot | ",
+ "rst_description": "*Optional*. Username of the user, if the username was requested by the bot\n",
+ "name": "username",
+ "required": false
+ },
+ {
+ "type": "Array of PhotoSize",
+ "description": "Available sizes of the chat photo, if the photo was requested by the bot",
+ "html_description": "Optional. Available sizes of the chat photo, if the photo was requested by the bot | ",
+ "rst_description": "*Optional*. Available sizes of the chat photo, if the photo was requested by the bot\n",
+ "name": "photo",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "usersshared",
"name": "UsersShared",
@@ -3100,11 +3700,11 @@
"required": true
},
{
- "type": "Array of Integer",
- "description": "Identifiers of the shared users. These numbers may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting them. But they have at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the users and could be unable to use these identifiers, unless the users are already known to the bot by some other means.",
- "html_description": "Identifiers of the shared users. These numbers may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting them. But they have at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the users and could be unable to use these identifiers, unless the users are already known to the bot by some other means. | ",
- "rst_description": "Identifiers of the shared users. These numbers may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting them. But they have at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the users and could be unable to use these identifiers, unless the users are already known to the bot by some other means.\n",
- "name": "user_ids",
+ "type": "Array of SharedUser",
+ "description": "Information about users shared with the bot.",
+ "html_description": "Information about users shared with the bot. | ",
+ "rst_description": "Information about users shared with the bot.\n",
+ "name": "users",
"required": true
}
],
@@ -3113,9 +3713,9 @@
{
"anchor": "chatshared",
"name": "ChatShared",
- "description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.",
- "html_description": "This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
",
- "rst_description": "This object contains information about the chat whose identifier was shared with the bot using a :class:`aiogram.types.keyboard_button_request_chat.KeyboardButtonRequestChat` button.",
+ "description": "This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.",
+ "html_description": "This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
",
+ "rst_description": "This object contains information about a chat that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_chat.KeyboardButtonRequestChat` button.",
"annotations": [
{
"type": "Integer",
@@ -3132,6 +3732,30 @@
"rst_description": "Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.\n",
"name": "chat_id",
"required": true
+ },
+ {
+ "type": "String",
+ "description": "Title of the chat, if the title was requested by the bot.",
+ "html_description": "Optional. Title of the chat, if the title was requested by the bot. | ",
+ "rst_description": "*Optional*. Title of the chat, if the title was requested by the bot.\n",
+ "name": "title",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Username of the chat, if the username was requested by the bot and available.",
+ "html_description": "Optional. Username of the chat, if the username was requested by the bot and available. | ",
+ "rst_description": "*Optional*. Username of the chat, if the username was requested by the bot and available.\n",
+ "name": "username",
+ "required": false
+ },
+ {
+ "type": "Array of PhotoSize",
+ "description": "Available sizes of the chat photo, if the photo was requested by the bot",
+ "html_description": "Optional. Available sizes of the chat photo, if the photo was requested by the bot | ",
+ "rst_description": "*Optional*. Available sizes of the chat photo, if the photo was requested by the bot\n",
+ "name": "photo",
+ "required": false
}
],
"category": "types"
@@ -3587,9 +4211,9 @@
{
"anchor": "replykeyboardmarkup",
"name": "ReplyKeyboardMarkup",
- "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).",
- "html_description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
",
- "rst_description": "This object represents a `custom keyboard `_ with reply options (see `Introduction to bots `_ for details and examples).",
+ "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
+ "html_description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.
",
+ "rst_description": "This object represents a `custom keyboard `_ with reply options (see `Introduction to bots `_ for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"annotations": [
{
"type": "Array of Array of KeyboardButton",
@@ -3645,9 +4269,9 @@
{
"anchor": "keyboardbutton",
"name": "KeyboardButton",
- "description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.\nNote: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.",
- "html_description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.
Note: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
",
- "rst_description": "This object represents one button of the reply keyboard. For simple text buttons, *String* can be used instead of this object to specify the button text. The optional fields *web_app*, *request_users*, *request_chat*, *request_contact*, *request_location*, and *request_poll* are mutually exclusive.\n**Note:** *request_users* and *request_chat* options will only work in Telegram versions released after 3 February, 2023. Older clients will display *unsupported message*.",
+ "description": "This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.\nNote: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.",
+ "html_description": "This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
Note: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
",
+ "rst_description": "This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, *String* can be used instead of this object to specify the button text.\n**Note:** *request_users* and *request_chat* options will only work in Telegram versions released after 3 February, 2023. Older clients will display *unsupported message*.",
"annotations": [
{
"type": "String",
@@ -3711,9 +4335,9 @@
{
"anchor": "keyboardbuttonrequestusers",
"name": "KeyboardButtonRequestUsers",
- "description": "This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed.",
- "html_description": "This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »
",
- "rst_description": "This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. `More about requesting users » `_",
+ "description": "This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed.",
+ "html_description": "This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »
",
+ "rst_description": "This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. `More about requesting users » `_",
"annotations": [
{
"type": "Integer",
@@ -3746,6 +4370,30 @@
"rst_description": "*Optional*. The maximum number of users to be selected; 1-10. Defaults to 1.\n",
"name": "max_quantity",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the users' first and last names",
+ "html_description": "Optional. Pass True to request the users' first and last names | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the users' first and last names\n",
+ "name": "request_name",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the users' usernames",
+ "html_description": "Optional. Pass True to request the users' usernames | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the users' usernames\n",
+ "name": "request_username",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the users' photos",
+ "html_description": "Optional. Pass True to request the users' photos | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the users' photos\n",
+ "name": "request_photo",
+ "required": false
}
],
"category": "types"
@@ -3753,9 +4401,9 @@
{
"anchor": "keyboardbuttonrequestchat",
"name": "KeyboardButtonRequestChat",
- "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.",
- "html_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats »
",
- "rst_description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. `More about requesting chats » `_",
+ "description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate..",
+ "html_description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».
",
+ "rst_description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. `More about requesting chats » `_.",
"annotations": [
{
"type": "Integer",
@@ -3820,6 +4468,30 @@
"rst_description": "*Optional*. Pass :code:`True` to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.\n",
"name": "bot_is_member",
"required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the chat's title",
+ "html_description": "Optional. Pass True to request the chat's title | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the chat's title\n",
+ "name": "request_title",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the chat's username",
+ "html_description": "Optional. Pass True to request the chat's username | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the chat's username\n",
+ "name": "request_username",
+ "required": false
+ },
+ {
+ "type": "Boolean",
+ "description": "Pass True to request the chat's photo",
+ "html_description": "Optional. Pass True to request the chat's photo | ",
+ "rst_description": "*Optional*. Pass :code:`True` to request the chat's photo\n",
+ "name": "request_photo",
+ "required": false
}
],
"category": "types"
@@ -3845,9 +4517,9 @@
{
"anchor": "replykeyboardremove",
"name": "ReplyKeyboardRemove",
- "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).",
- "html_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).
",
- "rst_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`).",
+ "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
",
+ "rst_description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"annotations": [
{
"type": "True",
@@ -3889,9 +4561,9 @@
{
"anchor": "inlinekeyboardbutton",
"name": "InlineKeyboardButton",
- "description": "This object represents one button of an inline keyboard. You must use exactly one of the optional fields.",
- "html_description": "This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
",
- "rst_description": "This object represents one button of an inline keyboard. You **must** use exactly one of the optional fields.",
+ "description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
+ "html_description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.
",
+ "rst_description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
"annotations": [
{
"type": "String",
@@ -3911,17 +4583,17 @@
},
{
"type": "String",
- "description": "Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes",
- "html_description": "Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes | ",
- "rst_description": "*Optional*. Data to be sent in a `callback query `_ to the bot when button is pressed, 1-64 bytes\n",
+ "description": "Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. Data to be sent in a `callback query `_ to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "callback_data",
"required": false
},
{
"type": "WebAppInfo",
- "description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.",
- "html_description": "Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. | ",
- "rst_description": "*Optional*. Description of the `Web App `_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot.\n",
+ "description": "Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. Description of the `Web App `_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "web_app",
"required": false
},
@@ -3935,25 +4607,25 @@
},
{
"type": "String",
- "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.",
- "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query",
"required": false
},
{
"type": "String",
- "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.",
- "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. | ",
- "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.\n",
+ "description": "If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
\n
\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_current_chat",
"required": false
},
{
"type": "SwitchInlineQueryChosenChat",
- "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field",
- "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field | ",
- "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field\n",
+ "description": "If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.",
+ "html_description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account. | ",
+ "rst_description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.\n",
"name": "switch_inline_query_chosen_chat",
"required": false
},
@@ -3967,9 +4639,9 @@
},
{
"type": "Boolean",
- "description": "Specify True, to send a Pay button.\n\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.",
- "html_description": "Optional. Specify True, to send a Pay button.
\n
\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. | ",
- "rst_description": "*Optional*. Specify :code:`True`, to send a `Pay button `_.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.\n",
+ "description": "Specify True, to send a Pay button. Substrings '' and 'XTR' in the buttons's text will be replaced with a Telegram Star icon.\n\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.",
+ "html_description": "Optional. Specify True, to send a Pay button. Substrings “![\"⭐\"/](\"//telegram.org/img/emoji/40/E2AD90.png\") ” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.
\n
\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages. | ",
+ "rst_description": "*Optional*. Specify :code:`True`, to send a `Pay button `_. Substrings '⭐' and 'XTR' in the buttons's text will be replaced with a Telegram Star icon.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.\n",
"name": "pay",
"required": false
}
@@ -4137,9 +4809,9 @@
{
"anchor": "forcereply",
"name": "ForceReply",
- "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
- "html_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
\n\n- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
\n- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
\n
\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
\n
",
- "rst_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode `_.\n\n **Example:** A `poll bot `_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
+ "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
+ "html_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.
\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
\n\n- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
\n- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
\n
\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
\n
",
+ "rst_description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode `_. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n\n **Example:** A `poll bot `_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"annotations": [
{
"type": "True",
@@ -4373,9 +5045,9 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can edit stories posted by other users",
- "html_description": "True, if the administrator can edit stories posted by other users | ",
- "rst_description": ":code:`True`, if the administrator can edit stories posted by other users\n",
+ "description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
+ "html_description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | ",
+ "rst_description": ":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories",
"required": true
},
@@ -4389,33 +5061,33 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
- "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; channels only | ",
- "rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
+ "description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
+ "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"name": "can_post_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the administrator can edit messages of other users and can pin messages; channels only",
- "html_description": "Optional. True, if the administrator can edit messages of other users and can pin messages; channels only | ",
- "rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; channels only\n",
+ "description": "True, if the administrator can edit messages of other users and can pin messages; for channels only",
+ "html_description": "Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; for channels only\n",
"name": "can_edit_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to pin messages; groups and supergroups only",
- "html_description": "Optional. True, if the user is allowed to pin messages; groups and supergroups only | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; groups and supergroups only\n",
+ "description": "True, if the user is allowed to pin messages; for groups and supergroups only",
+ "html_description": "Optional. True, if the user is allowed to pin messages; for groups and supergroups only | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; for groups and supergroups only\n",
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
- "html_description": "Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only\n",
+ "description": "True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
+ "html_description": "Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics",
"required": false
}
@@ -4477,6 +5149,14 @@
"name": "invite_link",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator",
+ "html_description": "Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator | ",
+ "rst_description": "*Optional*. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator\n",
+ "name": "via_join_request",
+ "required": false
+ },
{
"type": "Boolean",
"description": "True, if the user joined the chat via a chat folder invite link",
@@ -4644,9 +5324,9 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can edit stories posted by other users",
- "html_description": "True, if the administrator can edit stories posted by other users | ",
- "rst_description": ":code:`True`, if the administrator can edit stories posted by other users\n",
+ "description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
+ "html_description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | ",
+ "rst_description": ":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories",
"required": true
},
@@ -4660,33 +5340,33 @@
},
{
"type": "Boolean",
- "description": "True, if the administrator can post messages in the channel, or access channel statistics; channels only",
- "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; channels only | ",
- "rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; channels only\n",
+ "description": "True, if the administrator can post messages in the channel, or access channel statistics; for channels only",
+ "html_description": "Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"name": "can_post_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the administrator can edit messages of other users and can pin messages; channels only",
- "html_description": "Optional. True, if the administrator can edit messages of other users and can pin messages; channels only | ",
- "rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; channels only\n",
+ "description": "True, if the administrator can edit messages of other users and can pin messages; for channels only",
+ "html_description": "Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only | ",
+ "rst_description": "*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; for channels only\n",
"name": "can_edit_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to pin messages; groups and supergroups only",
- "html_description": "Optional. True, if the user is allowed to pin messages; groups and supergroups only | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; groups and supergroups only\n",
+ "description": "True, if the user is allowed to pin messages; for groups and supergroups only",
+ "html_description": "Optional. True, if the user is allowed to pin messages; for groups and supergroups only | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to pin messages; for groups and supergroups only\n",
"name": "can_pin_messages",
"required": false
},
{
"type": "Boolean",
- "description": "True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only",
- "html_description": "Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only | ",
- "rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only\n",
+ "description": "True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
+ "html_description": "Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | ",
+ "rst_description": "*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics",
"required": false
},
@@ -5121,6 +5801,152 @@
],
"category": "types"
},
+ {
+ "anchor": "birthdate",
+ "name": "Birthdate",
+ "description": "Describes the birthdate of a user.",
+ "html_description": "Describes the birthdate of a user.
",
+ "rst_description": "Describes the birthdate of a user.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "Day of the user's birth; 1-31",
+ "html_description": "Day of the user's birth; 1-31 | ",
+ "rst_description": "Day of the user's birth; 1-31\n",
+ "name": "day",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Month of the user's birth; 1-12",
+ "html_description": "Month of the user's birth; 1-12 | ",
+ "rst_description": "Month of the user's birth; 1-12\n",
+ "name": "month",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Year of the user's birth",
+ "html_description": "Optional. Year of the user's birth | ",
+ "rst_description": "*Optional*. Year of the user's birth\n",
+ "name": "year",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "businessintro",
+ "name": "BusinessIntro",
+ "description": "Contains information about the start page settings of a Telegram Business account.",
+ "html_description": "Contains information about the start page settings of a Telegram Business account.
",
+ "rst_description": "Contains information about the start page settings of a Telegram Business account.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Title text of the business intro",
+ "html_description": "Optional. Title text of the business intro | ",
+ "rst_description": "*Optional*. Title text of the business intro\n",
+ "name": "title",
+ "required": false
+ },
+ {
+ "type": "String",
+ "description": "Message text of the business intro",
+ "html_description": "Optional. Message text of the business intro | ",
+ "rst_description": "*Optional*. Message text of the business intro\n",
+ "name": "message",
+ "required": false
+ },
+ {
+ "type": "Sticker",
+ "description": "Sticker of the business intro",
+ "html_description": "Optional. Sticker of the business intro | ",
+ "rst_description": "*Optional*. Sticker of the business intro\n",
+ "name": "sticker",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "businesslocation",
+ "name": "BusinessLocation",
+ "description": "Contains information about the location of a Telegram Business account.",
+ "html_description": "Contains information about the location of a Telegram Business account.
",
+ "rst_description": "Contains information about the location of a Telegram Business account.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Address of the business",
+ "html_description": "Address of the business | ",
+ "rst_description": "Address of the business\n",
+ "name": "address",
+ "required": true
+ },
+ {
+ "type": "Location",
+ "description": "Location of the business",
+ "html_description": "Optional. Location of the business | ",
+ "rst_description": "*Optional*. Location of the business\n",
+ "name": "location",
+ "required": false
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "businessopeninghoursinterval",
+ "name": "BusinessOpeningHoursInterval",
+ "description": "Describes an interval of time during which a business is open.",
+ "html_description": "Describes an interval of time during which a business is open.
",
+ "rst_description": "Describes an interval of time during which a business is open.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60",
+ "html_description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60 | ",
+ "rst_description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60\n",
+ "name": "opening_minute",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60",
+ "html_description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60 | ",
+ "rst_description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60\n",
+ "name": "closing_minute",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "businessopeninghours",
+ "name": "BusinessOpeningHours",
+ "description": "Describes the opening hours of a business.",
+ "html_description": "Describes the opening hours of a business.
",
+ "rst_description": "Describes the opening hours of a business.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique name of the time zone for which the opening hours are defined",
+ "html_description": "Unique name of the time zone for which the opening hours are defined | ",
+ "rst_description": "Unique name of the time zone for which the opening hours are defined\n",
+ "name": "time_zone_name",
+ "required": true
+ },
+ {
+ "type": "Array of BusinessOpeningHoursInterval",
+ "description": "List of time intervals describing business opening hours",
+ "html_description": "List of time intervals describing business opening hours | ",
+ "rst_description": "List of time intervals describing business opening hours\n",
+ "name": "opening_hours",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "chatlocation",
"name": "ChatLocation",
@@ -5941,6 +6767,98 @@
],
"category": "types"
},
+ {
+ "anchor": "businessconnection",
+ "name": "BusinessConnection",
+ "description": "Describes the connection of the bot with a business account.",
+ "html_description": "Describes the connection of the bot with a business account.
",
+ "rst_description": "Describes the connection of the bot with a business account.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "id",
+ "required": true
+ },
+ {
+ "type": "User",
+ "description": "Business account user that created the business connection",
+ "html_description": "Business account user that created the business connection | ",
+ "rst_description": "Business account user that created the business connection\n",
+ "name": "user",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
+ "html_description": "Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | ",
+ "rst_description": "Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
+ "name": "user_chat_id",
+ "required": true
+ },
+ {
+ "type": "Integer",
+ "description": "Date the connection was established in Unix time",
+ "html_description": "Date the connection was established in Unix time | ",
+ "rst_description": "Date the connection was established in Unix time\n",
+ "name": "date",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours",
+ "html_description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours | ",
+ "rst_description": "True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours\n",
+ "name": "can_reply",
+ "required": true
+ },
+ {
+ "type": "Boolean",
+ "description": "True, if the connection is active",
+ "html_description": "True, if the connection is active | ",
+ "rst_description": "True, if the connection is active\n",
+ "name": "is_enabled",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
+ {
+ "anchor": "businessmessagesdeleted",
+ "name": "BusinessMessagesDeleted",
+ "description": "This object is received when messages are deleted from a connected business account.",
+ "html_description": "This object is received when messages are deleted from a connected business account.
",
+ "rst_description": "This object is received when messages are deleted from a connected business account.",
+ "annotations": [
+ {
+ "type": "String",
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id",
+ "required": true
+ },
+ {
+ "type": "Chat",
+ "description": "Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.",
+ "html_description": "Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. | ",
+ "rst_description": "Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.\n",
+ "name": "chat",
+ "required": true
+ },
+ {
+ "type": "Array of Integer",
+ "description": "The list of identifiers of deleted messages in the chat of the business account",
+ "html_description": "The list of identifiers of deleted messages in the chat of the business account | ",
+ "rst_description": "The list of identifiers of deleted messages in the chat of the business account\n",
+ "name": "message_ids",
+ "required": true
+ }
+ ],
+ "category": "types"
+ },
{
"anchor": "responseparameters",
"name": "ResponseParameters",
@@ -6023,6 +6941,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "Boolean",
"description": "Pass True if the photo needs to be covered with a spoiler animation",
@@ -6089,6 +7015,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "Integer",
"description": "Video width",
@@ -6187,6 +7121,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "Integer",
"description": "Animation width",
@@ -6420,6 +7362,14 @@
"html_description": "Use this method to send text messages. On success, the sent Message is returned.
",
"rst_description": "Use this method to send text messages. 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,
@@ -6484,6 +7434,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -6495,9 +7453,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -6595,9 +7553,9 @@
{
"type": "Array of Integer",
"required": true,
- "description": "Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.",
- "html_description": "Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. | ",
- "rst_description": "Identifiers of 1-100 messages in the chat *from_chat_id* to forward. The identifiers must be specified in a strictly increasing order.\n",
+ "description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.",
+ "html_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. | ",
+ "rst_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to forward. The identifiers must be specified in a strictly increasing order.\n",
"name": "message_ids"
},
{
@@ -6682,6 +7640,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.",
+ "html_description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. | ",
+ "rst_description": "Pass :code:`True`, if the caption must be shown above the message media. Ignored if a new caption isn't specified.\n",
+ "name": "show_caption_above_media"
+ },
{
"type": "Boolean",
"required": false,
@@ -6709,9 +7675,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -6751,9 +7717,9 @@
{
"type": "Array of Integer",
"required": true,
- "description": "Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
- "html_description": "Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. | ",
- "rst_description": "Identifiers of 1-100 messages in the chat *from_chat_id* to copy. The identifiers must be specified in a strictly increasing order.\n",
+ "description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
+ "html_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. | ",
+ "rst_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to copy. The identifiers must be specified in a strictly increasing order.\n",
"name": "message_ids"
},
{
@@ -6790,6 +7756,14 @@
"html_description": "Use this method to send photos. On success, the sent Message is returned.
",
"rst_description": "Use this method to send photos. 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,
@@ -6838,6 +7812,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media"
+ },
{
"type": "Boolean",
"required": false,
@@ -6862,6 +7844,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -6873,9 +7863,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -6888,6 +7878,14 @@
"html_description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
",
"rst_description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the :class:`aiogram.methods.send_voice.SendVoice` method instead.",
"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,
@@ -6984,6 +7982,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -6995,9 +8001,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7010,6 +8016,14 @@
"html_description": "Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
",
"rst_description": "Use this method to send general files. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.",
"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,
@@ -7090,6 +8104,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7101,9 +8123,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7116,6 +8138,14 @@
"html_description": "Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
",
"rst_description": "Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.",
"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,
@@ -7196,6 +8226,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media"
+ },
{
"type": "Boolean",
"required": false,
@@ -7228,6 +8266,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7239,9 +8285,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7254,6 +8300,14 @@
"html_description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
",
"rst_description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.",
"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,
@@ -7334,6 +8388,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media"
+ },
{
"type": "Boolean",
"required": false,
@@ -7358,6 +8420,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7369,9 +8439,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7380,10 +8450,18 @@
{
"anchor": "sendvoice",
"name": "sendVoice",
- "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
- "html_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
",
- "rst_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
+ "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
+ "html_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
",
+ "rst_description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"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,
@@ -7456,6 +8534,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7467,9 +8553,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7482,6 +8568,14 @@
"html_description": "As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
",
"rst_description": "As of `v.4.0 `_, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. 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,
@@ -7546,6 +8640,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7557,9 +8659,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7572,6 +8674,14 @@
"html_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
",
"rst_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of `Messages `_ that were sent 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,
@@ -7612,6 +8722,14 @@
"rst_description": "Protects the contents of the sent messages from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7630,6 +8748,14 @@
"html_description": "Use this method to send point on the map. On success, the sent Message is returned.
",
"rst_description": "Use this method to send point on the map. 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,
@@ -7673,9 +8799,9 @@
{
"type": "Integer",
"required": false,
- "description": "Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.",
- "html_description": "Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. | ",
- "rst_description": "Period in seconds for which the location will be updated (see `Live Locations `_, should be between 60 and 86400.\n",
+ "description": "Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
+ "html_description": "Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | ",
+ "rst_description": "Period in seconds during which the location will be updated (see `Live Locations `_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period"
},
{
@@ -7710,6 +8836,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7721,9 +8855,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7736,6 +8870,14 @@
"html_description": "Use this method to send information about a venue. On success, the sent Message is returned.
",
"rst_description": "Use this method to send information about a venue. 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,
@@ -7832,6 +8974,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7843,9 +8993,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7858,6 +9008,14 @@
"html_description": "Use this method to send phone contacts. On success, the sent Message is returned.
",
"rst_description": "Use this method to send phone contacts. 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,
@@ -7922,6 +9080,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -7933,9 +9099,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -7948,6 +9114,14 @@
"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,
@@ -7973,11 +9147,27 @@
"name": "question"
},
{
- "type": "Array of String",
+ "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 answer options, 2-10 strings 1-100 characters each",
- "html_description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each | ",
- "rst_description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each\n",
+ "description": "A JSON-serialized list of 2-10 answer options",
+ "html_description": "A JSON-serialized list of 2-10 answer options | ",
+ "rst_description": "A JSON-serialized list of 2-10 answer options\n",
"name": "options"
},
{
@@ -8031,9 +9221,9 @@
{
"type": "Array of MessageEntity",
"required": false,
- "description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode",
- "html_description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode | ",
- "rst_description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of *parse_mode*\n",
+ "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"
},
{
@@ -8076,6 +9266,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -8087,9 +9285,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -8102,6 +9300,14 @@
"html_description": "Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
",
"rst_description": "Use this method to send an animated emoji that will display a random value. 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,
@@ -8142,6 +9348,14 @@
"rst_description": "Protects the contents of the sent message from forwarding\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -8153,9 +9367,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -8168,6 +9382,14 @@
"html_description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
\nExample: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
\n
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
",
"rst_description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns :code:`True` on success.\n\n Example: The `ImageBot `_ needs some time to process a request and upload the image. Instead of sending a text message along the lines of 'Retrieving image, please wait…', the bot may use :class:`aiogram.methods.send_chat_action.SendChatAction` with *action* = *upload_photo*. The user will see a 'sending photo' status for the bot.\n\nWe only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.",
"annotations": [
+ {
+ "type": "String",
+ "required": false,
+ "description": "Unique identifier of the business connection on behalf of which the action will be sent",
+ "html_description": "Unique identifier of the business connection on behalf of which the action will be sent | ",
+ "rst_description": "Unique identifier of the business connection on behalf of which the action will be sent\n",
+ "name": "business_connection_id"
+ },
{
"type": "Integer or String",
"required": true,
@@ -8179,9 +9401,9 @@
{
"type": "Integer",
"required": false,
- "description": "Unique identifier for the target message thread; supergroups only",
- "html_description": "Unique identifier for the target message thread; supergroups only | ",
- "rst_description": "Unique identifier for the target message thread; supergroups only\n",
+ "description": "Unique identifier for the target message thread; for supergroups only",
+ "html_description": "Unique identifier for the target message thread; for supergroups only | ",
+ "rst_description": "Unique identifier for the target message thread; for supergroups only\n",
"name": "message_thread_id"
},
{
@@ -8221,9 +9443,9 @@
{
"type": "Array of ReactionType",
"required": false,
- "description": "New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.",
- "html_description": "New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. | ",
- "rst_description": "New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.\n",
+ "description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.",
+ "html_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. | ",
+ "rst_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.\n",
"name": "reaction"
},
{
@@ -8513,9 +9735,9 @@
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the administrator can edit stories posted by other users",
- "html_description": "Pass True if the administrator can edit stories posted by other users | ",
- "rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users\n",
+ "description": "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
+ "html_description": "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | ",
+ "rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"name": "can_edit_stories"
},
{
@@ -8529,33 +9751,33 @@
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the administrator can post messages in the channel, or access channel statistics; channels only",
- "html_description": "Pass True if the administrator can post messages in the channel, or access channel statistics; channels only | ",
- "rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; channels only\n",
+ "description": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only",
+ "html_description": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only | ",
+ "rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
"name": "can_post_messages"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the administrator can edit messages of other users and can pin messages; channels only",
- "html_description": "Pass True if the administrator can edit messages of other users and can pin messages; channels only | ",
- "rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages; channels only\n",
+ "description": "Pass True if the administrator can edit messages of other users and can pin messages; for channels only",
+ "html_description": "Pass True if the administrator can edit messages of other users and can pin messages; for channels only | ",
+ "rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages; for channels only\n",
"name": "can_edit_messages"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the administrator can pin messages, supergroups only",
- "html_description": "Pass True if the administrator can pin messages, supergroups only | ",
- "rst_description": "Pass :code:`True` if the administrator can pin messages, supergroups only\n",
+ "description": "Pass True if the administrator can pin messages; for supergroups only",
+ "html_description": "Pass True if the administrator can pin messages; for supergroups only | ",
+ "rst_description": "Pass :code:`True` if the administrator can pin messages; for supergroups only\n",
"name": "can_pin_messages"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only",
- "html_description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only | ",
- "rst_description": "Pass :code:`True` if the user is allowed to create, rename, close, and reopen forum topics, supergroups only\n",
+ "description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
+ "html_description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | ",
+ "rst_description": "Pass :code:`True` if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"name": "can_manage_topics"
}
],
@@ -9080,9 +10302,9 @@
{
"anchor": "getchat",
"name": "getChat",
- "description": "Use this method to get up to date information about the chat. Returns a Chat object on success.",
- "html_description": "Use this method to get up to date information about the chat. Returns a Chat object on success.
",
- "rst_description": "Use this method to get up to date information about the chat. Returns a :class:`aiogram.types.chat.Chat` object on success.",
+ "description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.",
+ "html_description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.
",
+ "rst_description": "Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.",
"annotations": [
{
"type": "Integer or String",
@@ -9590,6 +10812,24 @@
],
"category": "methods"
},
+ {
+ "anchor": "getbusinessconnection",
+ "name": "getBusinessConnection",
+ "description": "Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.",
+ "html_description": "Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
",
+ "rst_description": "Use this method to get information about the connection of the bot with a business account. Returns a :class:`aiogram.types.business_connection.BusinessConnection` object on success.",
+ "annotations": [
+ {
+ "type": "String",
+ "required": true,
+ "description": "Unique identifier of the business connection",
+ "html_description": "Unique identifier of the business connection | ",
+ "rst_description": "Unique identifier of the business connection\n",
+ "name": "business_connection_id"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "setmycommands",
"name": "setMyCommands",
@@ -10032,6 +11272,14 @@
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name": "caption_entities"
},
+ {
+ "type": "Boolean",
+ "required": false,
+ "description": "Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.",
+ "html_description": "Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. | ",
+ "rst_description": "Pass :code:`True`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.\n",
+ "name": "show_caption_above_media"
+ },
{
"type": "InlineKeyboardMarkup",
"required": false,
@@ -10140,6 +11388,14 @@
"rst_description": "Longitude of new location\n",
"name": "longitude"
},
+ {
+ "type": "Integer",
+ "required": false,
+ "description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged",
+ "html_description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged | ",
+ "rst_description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged\n",
+ "name": "live_period"
+ },
{
"type": "Float",
"required": false,
@@ -10337,9 +11593,9 @@
{
"type": "Array of Integer",
"required": true,
- "description": "Identifiers of 1-100 messages to delete. See deleteMessage for limitations on which messages can be deleted",
- "html_description": "Identifiers of 1-100 messages to delete. See deleteMessage for limitations on which messages can be deleted | ",
- "rst_description": "Identifiers of 1-100 messages to delete. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
+ "description": "A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted",
+ "html_description": "A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted | ",
+ "rst_description": "A JSON-serialized list of 1-100 identifiers of messages to delete. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
"name": "message_ids"
}
],
@@ -10513,22 +11769,6 @@
"name": "sticker_type",
"required": true
},
- {
- "type": "Boolean",
- "description": "True, if the sticker set contains animated stickers",
- "html_description": "True, if the sticker set contains animated stickers | ",
- "rst_description": ":code:`True`, if the sticker set contains `animated stickers `_\n",
- "name": "is_animated",
- "required": true
- },
- {
- "type": "Boolean",
- "description": "True, if the sticker set contains video stickers",
- "html_description": "True, if the sticker set contains video stickers | ",
- "rst_description": ":code:`True`, if the sticker set contains `video stickers `_\n",
- "name": "is_video",
- "required": true
- },
{
"type": "Array of Sticker",
"description": "List of all set stickers",
@@ -10605,6 +11845,14 @@
"name": "sticker",
"required": true
},
+ {
+ "type": "String",
+ "description": "Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a WEBM video",
+ "html_description": "Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a WEBM video | ",
+ "rst_description": "Format of the added sticker, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, 'video' for a **WEBM** video\n",
+ "name": "format",
+ "required": true
+ },
{
"type": "Array of String",
"description": "List of 1-20 emoji associated with the sticker",
@@ -10639,6 +11887,14 @@
"html_description": "Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
",
"rst_description": "Use this method to send static .WEBP, `animated `_ .TGS, or `video `_ .WEBM stickers. 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,
@@ -10658,9 +11914,9 @@
{
"type": "InputFile or String",
"required": true,
- "description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.",
- "html_description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL. | ",
- "rst_description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. :ref:`More information on Sending Files » `. Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.\n",
+ "description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files. Video and animated stickers can't be sent via an HTTP URL.",
+ "html_description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL. | ",
+ "rst_description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. :ref:`More information on Sending Files » `. Video and animated stickers can't be sent via an HTTP URL.\n",
"name": "sticker"
},
{
@@ -10687,6 +11943,14 @@
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
"name": "protect_content"
},
+ {
+ "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,
@@ -10698,9 +11962,9 @@
{
"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 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 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 reply keyboard or to force a reply from the user.\n",
+ "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"
}
],
@@ -10734,9 +11998,9 @@
{
"type": "Array of String",
"required": true,
- "description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.",
- "html_description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. | ",
- "rst_description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.\n",
+ "description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.",
+ "html_description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. | ",
+ "rst_description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.\n",
"name": "custom_emoji_ids"
}
],
@@ -10745,9 +12009,9 @@
{
"anchor": "uploadstickerfile",
"name": "uploadStickerFile",
- "description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.",
- "html_description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.
",
- "rst_description": "Use this method to upload a file with a sticker for later use in the :class:`aiogram.methods.create_new_sticker_set.CreateNewStickerSet` and :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet` methods (the file can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.",
+ "description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.",
+ "html_description": "Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.
",
+ "rst_description": "Use this method to upload a file with a sticker for later use in the :class:`aiogram.methods.create_new_sticker_set.CreateNewStickerSet`, :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet`, or :class:`aiogram.methods.replace_sticker_in_set.ReplaceStickerInSet` methods (the file can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.",
"annotations": [
{
"type": "Integer",
@@ -10815,14 +12079,6 @@
"rst_description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set\n",
"name": "stickers"
},
- {
- "type": "String",
- "required": true,
- "description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'",
- "html_description": "Format of stickers in the set, must be one of “static”, “animated”, “video” | ",
- "rst_description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'\n",
- "name": "sticker_format"
- },
{
"type": "String",
"required": false,
@@ -10845,9 +12101,9 @@
{
"anchor": "addstickertoset",
"name": "addStickerToSet",
- "description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.",
- "html_description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
",
- "rst_description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
+ "description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.",
+ "html_description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.
",
+ "rst_description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
"annotations": [
{
"type": "Integer",
@@ -10920,6 +12176,48 @@
],
"category": "methods"
},
+ {
+ "anchor": "replacestickerinset",
+ "name": "replaceStickerInSet",
+ "description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.",
+ "html_description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.
",
+ "rst_description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling :class:`aiogram.methods.delete_sticker_from_set.DeleteStickerFromSet`, then :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet`, then :class:`aiogram.methods.set_sticker_position_in_set.SetStickerPositionInSet`. Returns :code:`True` on success.",
+ "annotations": [
+ {
+ "type": "Integer",
+ "required": true,
+ "description": "User identifier of the sticker set owner",
+ "html_description": "User identifier of the sticker set owner | ",
+ "rst_description": "User identifier of the sticker set owner\n",
+ "name": "user_id"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Sticker set name",
+ "html_description": "Sticker set name | ",
+ "rst_description": "Sticker set name\n",
+ "name": "name"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "File identifier of the replaced sticker",
+ "html_description": "File identifier of the replaced sticker | ",
+ "rst_description": "File identifier of the replaced sticker\n",
+ "name": "old_sticker"
+ },
+ {
+ "type": "InputSticker",
+ "required": true,
+ "description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.",
+ "html_description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. | ",
+ "rst_description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.\n",
+ "name": "sticker"
+ }
+ ],
+ "category": "methods"
+ },
{
"anchor": "setstickeremojilist",
"name": "setStickerEmojiList",
@@ -11054,6 +12352,14 @@
"html_description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | ",
"rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animated-sticker-requirements `_`https://core.telegram.org/stickers#animated-sticker-requirements `_ for animated sticker technical requirements), or a **WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-sticker-requirements `_`https://core.telegram.org/stickers#video-sticker-requirements `_ for video sticker technical requirements. Pass a *file_id* as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
"name": "thumbnail"
+ },
+ {
+ "type": "String",
+ "required": true,
+ "description": "Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a WEBM video",
+ "html_description": "Format of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a WEBM video | ",
+ "rst_description": "Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **WEBM** video\n",
+ "name": "format"
}
],
"category": "methods"
@@ -11461,6 +12767,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -11583,6 +12897,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -11705,6 +13027,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -11803,6 +13133,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "Integer",
"description": "Video width",
@@ -12221,9 +13559,9 @@
},
{
"type": "Integer",
- "description": "Period in seconds for which the location can be updated, should be between 60 and 86400.",
- "html_description": "Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. | ",
- "rst_description": "*Optional*. Period in seconds for which the location can be updated, should be between 60 and 86400.\n",
+ "description": "Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
+ "html_description": "Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | ",
+ "rst_description": "*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period",
"required": false
},
@@ -12627,6 +13965,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -12709,6 +14055,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -12791,6 +14145,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -13021,6 +14383,14 @@
"name": "caption_entities",
"required": false
},
+ {
+ "type": "Boolean",
+ "description": "Pass True, if the caption must be shown above the message media",
+ "html_description": "Optional. Pass True, if the caption must be shown above the message media | ",
+ "rst_description": "*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
+ "name": "show_caption_above_media",
+ "required": false
+ },
{
"type": "InlineKeyboardMarkup",
"description": "Inline keyboard attached to the message",
@@ -13280,9 +14650,9 @@
},
{
"type": "Integer",
- "description": "Period in seconds for which the location can be updated, should be between 60 and 86400.",
- "html_description": "Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. | ",
- "rst_description": "*Optional*. Period in seconds for which the location can be updated, should be between 60 and 86400.\n",
+ "description": "Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
+ "html_description": "Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. | ",
+ "rst_description": "*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"name": "live_period",
"required": false
},
@@ -13454,33 +14824,33 @@
},
{
"type": "String",
- "description": "Payment provider token, obtained via @BotFather",
- "html_description": "Payment provider token, obtained via @BotFather | ",
- "rst_description": "Payment provider token, obtained via `@BotFather `_\n",
+ "description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
+ "html_description": "Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Payment provider token, obtained via `@BotFather `_. Pass an empty string for payments in `Telegram Stars `_.\n",
"name": "provider_token",
- "required": true
+ "required": false
},
{
"type": "String",
- "description": "Three-letter ISO 4217 currency code, see more on currencies",
- "html_description": "Three-letter ISO 4217 currency code, see more on currencies | ",
- "rst_description": "Three-letter ISO 4217 currency code, see `more on currencies `_\n",
+ "description": "Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
+ "html_description": "Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. | ",
+ "rst_description": "Three-letter ISO 4217 currency code, see `more on currencies `_. Pass 'XTR' for payments in `Telegram Stars `_.\n",
"name": "currency",
"required": true
},
{
"type": "Array of LabeledPrice",
- "description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
- "html_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) | ",
- "rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)\n",
+ "description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
+ "html_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. | ",
+ "rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars `_.\n",
"name": "prices",
"required": true
},
{
"type": "Integer",
- "description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
- "html_description": "Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 | ",
- "rst_description": "*Optional*. The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0\n",
+ "description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
+ "html_description": "Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars `_.\n",
"name": "max_tip_amount",
"required": false
},
@@ -13534,57 +14904,57 @@
},
{
"type": "Boolean",
- "description": "Pass True if you require the user's full name to complete the order",
- "html_description": "Optional. Pass True if you require the user's full name to complete the order | ",
- "rst_description": "*Optional*. Pass :code:`True` if you require the user's full name to complete the order\n",
+ "description": "Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_name",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if you require the user's phone number to complete the order",
- "html_description": "Optional. Pass True if you require the user's phone number to complete the order | ",
- "rst_description": "*Optional*. Pass :code:`True` if you require the user's phone number to complete the order\n",
+ "description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_phone_number",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if you require the user's email address to complete the order",
- "html_description": "Optional. Pass True if you require the user's email address to complete the order | ",
- "rst_description": "*Optional*. Pass :code:`True` if you require the user's email address to complete the order\n",
+ "description": "Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_email",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if you require the user's shipping address to complete the order",
- "html_description": "Optional. Pass True if you require the user's shipping address to complete the order | ",
- "rst_description": "*Optional*. Pass :code:`True` if you require the user's shipping address to complete the order\n",
+ "description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_shipping_address",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if the user's phone number should be sent to provider",
- "html_description": "Optional. Pass True if the user's phone number should be sent to provider | ",
- "rst_description": "*Optional*. Pass :code:`True` if the user's phone number should be sent to provider\n",
+ "description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars `_.\n",
"name": "send_phone_number_to_provider",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if the user's email address should be sent to provider",
- "html_description": "Optional. Pass True if the user's email address should be sent to provider | ",
- "rst_description": "*Optional*. Pass :code:`True` if the user's email address should be sent to provider\n",
+ "description": "Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars `_.\n",
"name": "send_email_to_provider",
"required": false
},
{
"type": "Boolean",
- "description": "Pass True if the final price depends on the shipping method",
- "html_description": "Optional. Pass True if the final price depends on the shipping method | ",
- "rst_description": "*Optional*. Pass :code:`True` if the final price depends on the shipping method\n",
+ "description": "Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.",
+ "html_description": "Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "*Optional*. Pass :code:`True` if the final price depends on the shipping method. Ignored for payments in `Telegram Stars `_.\n",
"name": "is_flexible",
"required": false
}
@@ -13741,34 +15111,34 @@
},
{
"type": "String",
- "required": true,
- "description": "Payment provider token, obtained via @BotFather",
- "html_description": "Payment provider token, obtained via @BotFather | ",
- "rst_description": "Payment provider token, obtained via `@BotFather `_\n",
+ "required": false,
+ "description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
+ "html_description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | ",
+ "rst_description": "Payment provider token, obtained via `@BotFather `_. Pass an empty string for payments in `Telegram Stars `_.\n",
"name": "provider_token"
},
{
"type": "String",
"required": true,
- "description": "Three-letter ISO 4217 currency code, see more on currencies",
- "html_description": "Three-letter ISO 4217 currency code, see more on currencies | ",
- "rst_description": "Three-letter ISO 4217 currency code, see `more on currencies `_\n",
+ "description": "Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
+ "html_description": "Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. | ",
+ "rst_description": "Three-letter ISO 4217 currency code, see `more on currencies `_. Pass 'XTR' for payments in `Telegram Stars `_.\n",
"name": "currency"
},
{
"type": "Array of LabeledPrice",
"required": true,
- "description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
- "html_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) | ",
- "rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)\n",
+ "description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
+ "html_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. | ",
+ "rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars `_.\n",
"name": "prices"
},
{
"type": "Integer",
"required": false,
- "description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
- "html_description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0 | ",
- "rst_description": "The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0\n",
+ "description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
+ "html_description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | ",
+ "rst_description": "The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars `_.\n",
"name": "max_tip_amount"
},
{
@@ -13830,57 +15200,57 @@
{
"type": "Boolean",
"required": false,
- "description": "Pass True if you require the user's full name to complete the order",
- "html_description": "Pass True if you require the user's full name to complete the order | ",
- "rst_description": "Pass :code:`True` if you require the user's full name to complete the order\n",
+ "description": "Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_name"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if you require the user's phone number to complete the order",
- "html_description": "Pass True if you require the user's phone number to complete the order | ",
- "rst_description": "Pass :code:`True` if you require the user's phone number to complete the order\n",
+ "description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_phone_number"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if you require the user's email address to complete the order",
- "html_description": "Pass True if you require the user's email address to complete the order | ",
- "rst_description": "Pass :code:`True` if you require the user's email address to complete the order\n",
+ "description": "Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_email"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if you require the user's shipping address to complete the order",
- "html_description": "Pass True if you require the user's shipping address to complete the order | ",
- "rst_description": "Pass :code:`True` if you require the user's shipping address to complete the order\n",
+ "description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
+ "html_description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars `_.\n",
"name": "need_shipping_address"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the user's phone number should be sent to provider",
- "html_description": "Pass True if the user's phone number should be sent to provider | ",
- "rst_description": "Pass :code:`True` if the user's phone number should be sent to provider\n",
+ "description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
+ "html_description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | ",
+ "rst_description": "Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars `_.\n",
"name": "send_phone_number_to_provider"
},
{
"type": "Boolean",
"required": false,
- "description": "Pass True if the user's email address should be sent to provider",
- "html_description": "Pass |