Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
', 'rst_description': 'Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.', 'annotations': [], 'category': 'methods', 'returning': {'type': 'Array of Sticker', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'Sticker'}}}, 'description': 'Returns an Array of Sticker objects.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#getforumtopiciconstickers
:param request_timeout: Request timeout
:return: Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.
@@ -1612,7 +1612,7 @@ class Bot(ContextInstanceMixin["Bot"]):
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.
- Source: https://core.telegram.org/bots/api#{'anchor': 'getgamehighscores', 'name': 'getGameHighScores', 'description': 'Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.\nThis method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.', 'html_description': 'Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
A simple method for testing your bot\'s authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
', 'rst_description': "A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a :class:`aiogram.types.user.User` object.", 'annotations': [], 'category': 'methods', 'returning': {'type': 'User', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'User'}}, 'description': 'Returns basic information about the bot in form of a User object.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#getme
:param request_timeout: Request timeout
:return: Returns basic information about the bot in form of a :class:`aiogram.types.user.User` object.
@@ -1655,7 +1655,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of :class:`aiogram.types.bot_command.BotCommand` objects. If commands aren't set, an empty list is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'getmycommands', 'name': 'getMyCommands', 'description': "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.", 'html_description': 'Use this method to get the current list of the bot\'s commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren\'t set, an empty list is returned.
', 'rst_description': "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of :class:`aiogram.types.bot_command.BotCommand` objects. If commands aren't set, an empty list is returned.", 'annotations': [{'type': 'BotCommandScope', 'required': False, 'description': 'A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.', 'html_description': 'Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
', 'rst_description': 'Use this method to get the current default administrator rights of the bot. Returns :class:`aiogram.types.chat_administrator_rights.ChatAdministratorRights` on success.', 'annotations': [{'type': 'Boolean', 'required': False, 'description': 'Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.', 'html_description': '`_). Returns an Array of :class:`aiogram.types.update.Update` objects.\n\n **Notes**\n \n **1.** This method will not work if an outgoing webhook is set up.\n \n **2.** In order to avoid getting duplicate updates, recalculate *offset* after each server response.', 'annotations': [{'type': 'Integer', 'required': False, 'description': 'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.', 'html_description': 'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. | ', 'rst_description': 'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as :class:`aiogram.methods.get_updates.GetUpdates` is called with an *offset* higher than its *update_id*. The negative offset can be specified to retrieve updates starting from *-offset* update from the end of the updates queue. All previous updates will forgotten.\n', 'name': 'offset', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.', 'html_description': 'Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. | ', 'rst_description': 'Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n', 'name': 'limit', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.', 'html_description': 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. | ', 'rst_description': 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.\n', 'name': 'timeout', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Array of String', 'required': False, 'description': "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.", 'html_description': 'A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
\n
\nPlease note that this parameter doesn\'t affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. | ', 'rst_description': "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.\n", 'name': 'allowed_updates', 'parsed_type': {'type': 'array', 'items': {'type': 'std', 'name': 'str'}}}], 'category': 'methods', 'returning': {'type': 'Array of Update', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'Update'}}}, 'description': 'Returns an Array of Update objects.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#getupdates
:param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as :class:`aiogram.methods.get_updates.GetUpdates` is called with an *offset* higher than its *update_id*. The negative offset can be specified to retrieve updates starting from *-offset* update from the end of the updates queue. All previous updates will forgotten.
:param limit: Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
@@ -1754,7 +1754,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get a list of profile pictures for a user. Returns a :class:`aiogram.types.user_profile_photos.UserProfilePhotos` object.
- Source: https://core.telegram.org/bots/api#{'anchor': 'getuserprofilephotos', 'name': 'getUserProfilePhotos', 'description': 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.', 'html_description': 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
', 'rst_description': 'Use this method to get a list of profile pictures for a user. Returns a :class:`aiogram.types.user_profile_photos.UserProfilePhotos` object.', 'annotations': [{'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user | ', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Sequential number of the first photo to be returned. By default, all photos are returned.', 'html_description': 'Sequential number of the first photo to be returned. By default, all photos are returned. | ', 'rst_description': 'Sequential number of the first photo to be returned. By default, all photos are returned.\n', 'name': 'offset', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.', 'html_description': 'Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. | ', 'rst_description': 'Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n', 'name': 'limit', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'UserProfilePhotos', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'UserProfilePhotos'}}, 'description': 'Returns a UserProfilePhotos object.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#getuserprofilephotos
:param user_id: Unique identifier of the target user
:param offset: Sequential number of the first photo to be returned. By default, all photos are returned.
@@ -1777,7 +1777,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to get current webhook status. Requires no parameters. On success, returns a :class:`aiogram.types.webhook_info.WebhookInfo` object. If the bot is using :class:`aiogram.methods.get_updates.GetUpdates`, will return an object with the *url* field empty.
- Source: https://core.telegram.org/bots/api#{'anchor': 'getwebhookinfo', 'name': 'getWebhookInfo', 'description': 'Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.', 'html_description': 'Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
', 'rst_description': 'Use this method to get current webhook status. Requires no parameters. On success, returns a :class:`aiogram.types.webhook_info.WebhookInfo` object. If the bot is using :class:`aiogram.methods.get_updates.GetUpdates`, will return an object with the *url* field empty.', 'annotations': [], 'category': 'methods', 'returning': {'type': 'WebhookInfo', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'WebhookInfo'}}, 'description': 'On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#getwebhookinfo
:param request_timeout: Request timeout
:return: If the bot is using :class:`aiogram.methods.get_updates.GetUpdates`, will return an object with the *url* field empty.
@@ -1794,7 +1794,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method for your bot to leave a group, supergroup or channel. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'leavechat', 'name': 'leaveChat', 'description': 'Use this method for your bot to leave a group, supergroup or channel. Returns True on success.', 'html_description': 'Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
', 'rst_description': 'Use this method for your bot to leave a group, supergroup or channel. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#leavechat
:param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)
:param request_timeout: Request timeout
@@ -1813,7 +1813,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns :code:`True` on success. Requires no parameters.
- Source: https://core.telegram.org/bots/api#{'anchor': 'logout', 'name': 'logOut', 'description': 'Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.', 'html_description': 'Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
', 'rst_description': 'Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns :code:`True` on success. Requires no parameters.', 'annotations': [], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#logout
:param request_timeout: Request timeout
:return: Requires no parameters.
@@ -1832,7 +1832,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'pinchatmessage', 'name': 'pinChatMessage', 'description': "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", 'html_description': "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
", 'rst_description': "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Identifier of a message to pin', 'html_description': 'Identifier of a message to pin | ', 'rst_description': 'Identifier of a message to pin\n', 'name': 'message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.', 'html_description': 'Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. | ', 'rst_description': 'Pass :code:`True` if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#pinchatmessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_id: Identifier of a message to pin
@@ -1869,7 +1869,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass :code:`False` for all boolean parameters to demote a user. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'promotechatmember', 'name': 'promoteChatMember', 'description': 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.', 'html_description': 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
', 'rst_description': 'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass :code:`False` for all boolean parameters to demote a user. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user | ', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': "Pass True if the administrator's presence in the chat is hidden", 'html_description': "Pass True if the administrator's presence in the chat is hidden | ", 'rst_description': "Pass :code:`True` if the administrator's presence in the chat is hidden\n", 'name': 'is_anonymous', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege', 'html_description': 'Pass True if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege | ', 'rst_description': 'Pass :code:`True` if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n', 'name': 'can_manage_chat', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can create channel posts, channels only', 'html_description': 'Pass True if the administrator can create channel posts, channels only | ', 'rst_description': 'Pass :code:`True` if the administrator can create channel posts, channels only\n', 'name': 'can_post_messages', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'can_edit_messages', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can delete messages of other users', 'html_description': 'Pass True if the administrator can delete messages of other users | ', 'rst_description': 'Pass :code:`True` if the administrator can delete messages of other users\n', 'name': 'can_delete_messages', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can manage video chats', 'html_description': 'Pass True if the administrator can manage video chats | ', 'rst_description': 'Pass :code:`True` if the administrator can manage video chats\n', 'name': 'can_manage_video_chats', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can restrict, ban or unban chat members', 'html_description': 'Pass True if the administrator can restrict, ban or unban chat members | ', 'rst_description': 'Pass :code:`True` if the administrator can restrict, ban or unban chat members\n', 'name': 'can_restrict_members', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)', 'html_description': 'Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) | ', 'rst_description': 'Pass :code:`True` if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)\n', 'name': 'can_promote_members', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can change chat title, photo and other settings', 'html_description': 'Pass True if the administrator can change chat title, photo and other settings | ', 'rst_description': 'Pass :code:`True` if the administrator can change chat title, photo and other settings\n', 'name': 'can_change_info', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the administrator can invite new users to the chat', 'html_description': 'Pass True if the administrator can invite new users to the chat | ', 'rst_description': 'Pass :code:`True` if the administrator can invite new users to the chat\n', 'name': 'can_invite_users', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'can_pin_messages', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'can_manage_topics', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#promotechatmember
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param user_id: Unique identifier of the target user
@@ -1916,7 +1916,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'reopenforumtopic', 'name': 'reopenForumTopic', 'description': 'Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.', 'html_description': 'Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
', 'rst_description': 'Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier for the target message thread of the forum topic', 'html_description': 'Unique identifier for the target message thread of the forum topic | ', 'rst_description': 'Unique identifier for the target message thread of the forum topic\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#reopenforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
@@ -1942,7 +1942,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass :code:`True` for all permissions to lift restrictions from a user. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'restrictchatmember', 'name': 'restrictChatMember', 'description': 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.', 'html_description': 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
', 'rst_description': 'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass :code:`True` for all permissions to lift restrictions from a user. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user | ', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'ChatPermissions', 'required': True, 'description': 'A JSON-serialized object for new user permissions', 'html_description': 'A JSON-serialized object for new user permissions | ', 'rst_description': 'A JSON-serialized object for new user permissions\n', 'name': 'permissions', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatPermissions'}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.', 'html_description': 'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | ', 'rst_description': 'Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission.\n', 'name': 'use_independent_chat_permissions', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever', 'html_description': 'Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever | ', 'rst_description': 'Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n', 'name': 'until_date', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'datetime.datetime'}, {'type': 'std', 'name': 'datetime.timedelta'}, {'type': 'std', 'name': 'int'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#restrictchatmember
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param user_id: Unique identifier of the target user
@@ -1971,7 +1971,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.
- Source: https://core.telegram.org/bots/api#{'anchor': 'revokechatinvitelink', 'name': 'revokeChatInviteLink', 'description': 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.', 'html_description': 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
', 'rst_description': 'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier of the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier of the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier of the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'The invite link to revoke', 'html_description': 'The invite link to revoke | ', 'rst_description': 'The invite link to revoke\n', 'name': 'invite_link', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'ChatInviteLink', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatInviteLink'}}, 'description': 'Returns the revoked invite link as ChatInviteLink object.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#revokechatinvitelink
:param chat_id: Unique identifier of the target chat or username of the target channel (in the format :code:`@channelusername`)
:param invite_link: The invite link to revoke
@@ -2010,7 +2010,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendanimation', 'name': 'sendAnimation', '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.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files', 'html_description': 'Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files » | ', 'rst_description': 'Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'animation', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Duration of sent animation in seconds', 'html_description': 'Duration of sent animation in seconds | ', 'rst_description': 'Duration of sent animation in seconds\n', 'name': 'duration', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Animation width', 'html_description': 'Animation width | ', 'rst_description': 'Animation width\n', 'name': 'width', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Animation height', 'html_description': 'Animation height | ', 'rst_description': 'Animation height\n', 'name': 'height', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile or String', 'required': False, 'description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", 'html_description': 'Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail\'s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can\'t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ', 'rst_description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': False, 'description': 'Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing', 'html_description': 'Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing | ', 'rst_description': 'Animation caption (may also be used when resending animation by *file_id*), 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the animation caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the animation caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the animation caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the animation needs to be covered with a spoiler animation', 'html_description': 'Pass True if the animation needs to be covered with a spoiler animation | ', 'rst_description': 'Pass :code:`True` if the animation needs to be covered with a spoiler animation\n', 'name': 'has_spoiler', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendanimation
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param animation: Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. :ref:`More information on Sending Files » `
@@ -2077,7 +2077,7 @@ class Bot(ContextInstanceMixin["Bot"]):
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.
For sending voice messages, use the :class:`aiogram.methods.send_voice.SendVoice` method instead.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendaudio', 'name': 'sendAudio', '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.\nFor sending voice messages, use the sendVoice method instead.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files', 'html_description': 'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | ', 'rst_description': 'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'audio', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Audio caption, 0-1024 characters after entities parsing', 'html_description': 'Audio caption, 0-1024 characters after entities parsing | ', 'rst_description': 'Audio caption, 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the audio caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the audio caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the audio caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Integer', 'required': False, 'description': 'Duration of the audio in seconds', 'html_description': 'Duration of the audio in seconds | ', 'rst_description': 'Duration of the audio in seconds\n', 'name': 'duration', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Performer', 'html_description': 'Performer | ', 'rst_description': 'Performer\n', 'name': 'performer', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Track name', 'html_description': 'Track name | ', 'rst_description': 'Track name\n', 'name': 'title', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'InputFile or String', 'required': False, 'description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", 'html_description': 'Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail\'s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can\'t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ', 'rst_description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendaudio
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `
@@ -2131,7 +2131,7 @@ class Bot(ContextInstanceMixin["Bot"]):
We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendchataction', 'name': 'sendChatAction', '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.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.", '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.', 'html_description': 'Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. | ', 'rst_description': 'Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for `text messages `_, *upload_photo* for `photos `_, *record_video* or *upload_video* for `videos `_, *record_voice* or *upload_voice* for `voice notes `_, *upload_document* for `general files `_, *choose_sticker* for `stickers `_, *find_location* for `location data `_, *record_video_note* or *upload_video_note* for `video notes `_.\n', 'name': 'action', 'enum_value': 'ChatAction.UPLOAD_VIDEO_NOTE', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'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', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendchataction
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param action: Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for `text messages `_, *upload_photo* for `photos `_, *record_video* or *upload_video* for `videos `_, *record_voice* or *upload_voice* for `voice notes `_, *upload_document* for `general files `_, *choose_sticker* for `stickers `_, *find_location* for `location data `_, *record_video_note* or *upload_video_note* for `video notes `_.
@@ -2167,7 +2167,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send phone contacts. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendcontact', 'name': 'sendContact', 'description': 'Use this method to send phone contacts. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': "Contact's phone number", 'html_description': "Contact's phone number | ", 'rst_description': "Contact's phone number\n", 'name': 'phone_number', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': True, 'description': "Contact's first name", 'html_description': "Contact's first name | ", 'rst_description': "Contact's first name\n", 'name': 'first_name', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': "Contact's last name", 'html_description': "Contact's last name | ", 'rst_description': "Contact's last name\n", 'name': 'last_name', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Additional data about the contact in the form of a vCard, 0-2048 bytes', 'html_description': 'Additional data about the contact in the form of a vCard, 0-2048 bytes | ', 'rst_description': 'Additional data about the contact in the form of a `vCard `_, 0-2048 bytes\n', 'name': 'vcard', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendcontact
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param phone_number: Contact's phone number
@@ -2216,7 +2216,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'senddice', 'name': 'sendDice', 'description': 'Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': "Emoji on which the dice throw animation is based. Currently, must be one of '', '', '', '', '', or ''. Dice can have values 1-6 for '', '' and '', values 1-5 for '' and '', and values 1-64 for ''. Defaults to ''", 'html_description': 'Emoji on which the dice throw animation is based. Currently, must be one of “ ”, “ ”, “ ”, “ ”, “ ”, or “ ”. Dice can have values 1-6 for “”, “” and “”, values 1-5 for “” and “”, and values 1-64 for “”. Defaults to “” | ', 'rst_description': "Emoji on which the dice throw animation is based. Currently, must be one of '🎲', '🎯', '🏀', '⚽', '🎳', or '🎰'. Dice can have values 1-6 for '🎲', '🎯' and '🎳', values 1-5 for '🏀' and '⚽', and values 1-64 for '🎰'. Defaults to '🎲'\n", 'name': 'emoji', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding', 'html_description': 'Protects the contents of the sent message from forwarding | ', 'rst_description': 'Protects the contents of the sent message from forwarding\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#senddice
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_thread_id: Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
@@ -2264,7 +2264,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'senddocument', 'name': 'sendDocument', '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.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'File 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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files', 'html_description': 'File 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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | ', 'rst_description': 'File 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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'document', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile or String', 'required': False, 'description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", 'html_description': 'Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail\'s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can\'t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ', 'rst_description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': False, 'description': 'Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing', 'html_description': 'Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing | ', 'rst_description': 'Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the document caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the document caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the document caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Boolean', 'required': False, 'description': 'Disables automatic server-side content type detection for files uploaded using multipart/form-data', 'html_description': 'Disables automatic server-side content type detection for files uploaded using multipart/form-data | ', 'rst_description': 'Disables automatic server-side content type detection for files uploaded using multipart/form-data\n', 'name': 'disable_content_type_detection', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#senddocument
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param document: File 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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `
@@ -2315,7 +2315,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send a game. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendgame', 'name': 'sendGame', 'description': 'Use this method to send a game. On success, the sent Message is returned.', 'html_description': 'Use this method to send a game. On success, the sent Message is returned.
', 'rst_description': 'Use this method to send a game. On success, the sent :class:`aiogram.types.message.Message` is returned.', 'annotations': [{'type': 'Integer', 'required': True, 'description': 'Unique identifier for the target chat', 'html_description': 'Unique identifier for the target chat | ', 'rst_description': 'Unique identifier for the target chat\n', 'name': 'chat_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': True, 'description': 'Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.', 'html_description': 'Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. | ', 'rst_description': 'Short name of the game, serves as the unique identifier for the game. Set up your games via `@BotFather `_.\n', 'name': 'game_short_name', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'InlineKeyboardMarkup', 'required': False, 'description': "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.", 'html_description': 'A JSON-serialized object for an inline keyboard. If empty, one \'Play game_title\' button will be shown. If not empty, the first button must launch the game. | ', 'rst_description': "A JSON-serialized object for an `inline keyboard `_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.\n", 'name': 'reply_markup', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendgame
:param chat_id: Unique identifier for the target chat
:param game_short_name: Short name of the game, serves as the unique identifier for the game. Set up your games via `@BotFather `_.
@@ -2376,7 +2376,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send invoices. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendinvoice', 'name': 'sendInvoice', 'description': 'Use this method to send invoices. On success, the sent Message is returned.', 'html_description': 'Use this method to send invoices. On success, the sent Message is returned.
', 'rst_description': 'Use this method to send invoices. On success, the sent :class:`aiogram.types.message.Message` is returned.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'Product name, 1-32 characters', 'html_description': 'Product name, 1-32 characters | ', 'rst_description': 'Product name, 1-32 characters\n', 'name': 'title', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': True, 'description': 'Product description, 1-255 characters', 'html_description': 'Product description, 1-255 characters | ', 'rst_description': 'Product description, 1-255 characters\n', 'name': 'description', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': True, 'description': 'Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.', 'html_description': 'Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. | ', 'rst_description': 'Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n', 'name': 'payload', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'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', 'name': 'provider_token', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'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', 'name': 'currency', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'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', 'name': 'prices', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'LabeledPrice'}}}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'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', 'name': 'max_tip_amount', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Array of Integer', 'required': False, 'description': 'A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.', 'html_description': 'A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | ', 'rst_description': 'A JSON-serialized array of suggested amounts of tips in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed *max_tip_amount*.\n', 'name': 'suggested_tip_amounts', 'parsed_type': {'type': 'array', 'items': {'type': 'std', 'name': 'int'}}}, {'type': 'String', 'required': False, 'description': 'Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter', 'html_description': 'Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter | ', 'rst_description': 'Unique deep-linking parameter. If left empty, **forwarded copies** of the sent message will have a *Pay* button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a *URL* button with a deep link to the bot (instead of a *Pay* button), with the value used as the start parameter\n', 'name': 'start_parameter', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.', 'html_description': 'JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | ', 'rst_description': 'JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.\n', 'name': 'provider_data', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.', 'html_description': 'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. | ', 'rst_description': 'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.\n', 'name': 'photo_url', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': 'Photo size in bytes', 'html_description': 'Photo size in bytes | ', 'rst_description': 'Photo size in bytes\n', 'name': 'photo_size', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Photo width', 'html_description': 'Photo width | ', 'rst_description': 'Photo width\n', 'name': 'photo_width', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Photo height', 'html_description': 'Photo height | ', 'rst_description': 'Photo height\n', 'name': 'photo_height', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'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", 'name': 'need_name', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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", 'name': 'need_phone_number', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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", 'name': 'need_email', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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", 'name': 'need_shipping_address', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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", 'name': 'send_phone_number_to_provider', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': "Pass True if the user's email address should be sent to provider", 'html_description': "Pass True if the user's email address should be sent to provider | ", 'rst_description': "Pass :code:`True` if the user's email address should be sent to provider\n", 'name': 'send_email_to_provider', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the final price depends on the shipping method', 'html_description': 'Pass True if the final price depends on the shipping method | ', 'rst_description': 'Pass :code:`True` if the final price depends on the shipping method\n', 'name': 'is_flexible', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'InlineKeyboardMarkup', 'required': False, 'description': "A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.", 'html_description': 'A JSON-serialized object for an inline keyboard. If empty, one \'Pay total price\' button will be shown. If not empty, the first button must be a Pay button. | ', 'rst_description': "A JSON-serialized object for an `inline keyboard `_. If empty, one 'Pay :code:`total price`' button will be shown. If not empty, the first button must be a Pay button.\n", 'name': 'reply_markup', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendinvoice
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param title: Product name, 1-32 characters
@@ -2464,7 +2464,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send point on the map. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendlocation', 'name': 'sendLocation', 'description': 'Use this method to send point on the map. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Float number', 'required': True, 'description': 'Latitude of the location', 'html_description': 'Latitude of the location | ', 'rst_description': 'Latitude of the location\n', 'name': 'latitude', 'parsed_type': {'type': 'std', 'name': 'float'}}, {'type': 'Float number', 'required': True, 'description': 'Longitude of the location', 'html_description': 'Longitude of the location | ', 'rst_description': 'Longitude of the location\n', 'name': 'longitude', 'parsed_type': {'type': 'std', 'name': 'float'}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Float number', 'required': False, 'description': 'The radius of uncertainty for the location, measured in meters; 0-1500', 'html_description': 'The radius of uncertainty for the location, measured in meters; 0-1500 | ', 'rst_description': 'The radius of uncertainty for the location, measured in meters; 0-1500\n', 'name': 'horizontal_accuracy', 'parsed_type': {'type': 'std', 'name': 'float'}}, {'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', 'name': 'live_period', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.', 'html_description': 'For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | ', 'rst_description': 'For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n', 'name': 'heading', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.', 'html_description': 'For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | ', 'rst_description': 'For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n', 'name': 'proximity_alert_radius', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendlocation
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param latitude: Latitude of the location
@@ -2514,7 +2514,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendmediagroup', 'name': 'sendMediaGroup', '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.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo', 'required': True, 'description': 'A JSON-serialized array describing messages to be sent, must include 2-10 items', 'html_description': 'A JSON-serialized array describing messages to be sent, must include 2-10 items | ', 'rst_description': 'A JSON-serialized array describing messages to be sent, must include 2-10 items\n', 'name': 'media', 'parsed_type': {'type': 'array', 'items': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputMediaAudio, InputMediaDocument, InputMediaPhoto'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'InputMediaVideo'}}]}}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends messages silently. Users will receive a notification with no sound.', 'html_description': 'Sends messages silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends messages `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent messages from forwarding and saving', 'html_description': 'Protects the contents of the sent messages from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent messages from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the messages are a reply, ID of the original message', 'html_description': 'If the messages are a reply, ID of the original message | ', 'rst_description': 'If the messages are a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'array of Message', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}}, 'description': 'On success, an array of Messages that were sent is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendmediagroup
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param media: A JSON-serialized array describing messages to be sent, must include 2-10 items
@@ -2558,7 +2558,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send text messages. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendmessage', 'name': 'sendMessage', 'description': 'Use this method to send text messages. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'Text of the message to be sent, 1-4096 characters after entities parsing', 'html_description': 'Text of the message to be sent, 1-4096 characters after entities parsing | ', 'rst_description': 'Text of the message to be sent, 1-4096 characters after entities parsing\n', 'name': 'text', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the message text. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the message text. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the message text. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | ', 'rst_description': 'A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n', 'name': 'entities', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Boolean', 'required': False, 'description': 'Disables link previews for links in this message', 'html_description': 'Disables link previews for links in this message | ', 'rst_description': 'Disables link previews for links in this message\n', 'name': 'disable_web_page_preview', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendmessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param text: Text of the message to be sent, 1-4096 characters after entities parsing
@@ -2611,7 +2611,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send photos. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendphoto', 'name': 'sendPhoto', 'description': 'Use this method to send photos. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files", 'html_description': 'Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo\'s width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » | ', 'rst_description': "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. :ref:`More information on Sending Files » `\n", 'name': 'photo', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing', 'html_description': 'Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing | ', 'rst_description': 'Photo caption (may also be used when resending photos by *file_id*), 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the photo caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the photo caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the photo caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the photo needs to be covered with a spoiler animation', 'html_description': 'Pass True if the photo needs to be covered with a spoiler animation | ', 'rst_description': 'Pass :code:`True` if the photo needs to be covered with a spoiler animation\n', 'name': 'has_spoiler', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendphoto
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. :ref:`More information on Sending Files » `
@@ -2673,7 +2673,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send a native poll. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendpoll', 'name': 'sendPoll', 'description': 'Use this method to send a native poll. On success, the sent Message is returned.', 'html_description': 'Use this method to send a native poll. On success, the sent Message is returned.
', 'rst_description': 'Use this method to send a native poll. On success, the sent :class:`aiogram.types.message.Message` is returned.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'Poll question, 1-300 characters', 'html_description': 'Poll question, 1-300 characters | ', 'rst_description': 'Poll question, 1-300 characters\n', 'name': 'question', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Array of String', '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', 'name': 'options', 'parsed_type': {'type': 'array', 'items': {'type': 'std', 'name': 'str'}}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'True, if the poll needs to be anonymous, defaults to True', 'html_description': 'True, if the poll needs to be anonymous, defaults to True | ', 'rst_description': ':code:`True`, if the poll needs to be anonymous, defaults to :code:`True`\n', 'name': 'is_anonymous', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'String', 'required': False, 'description': "Poll type, 'quiz' or 'regular', defaults to 'regular'", 'html_description': 'Poll type, “quiz” or “regular”, defaults to “regular” | ', 'rst_description': "Poll type, 'quiz' or 'regular', defaults to 'regular'\n", 'name': 'type', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Boolean', 'required': False, 'description': 'True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False', 'html_description': 'True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False | ', 'rst_description': ':code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`\n', 'name': 'allows_multiple_answers', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': '0-based identifier of the correct answer option, required for polls in quiz mode', 'html_description': '0-based identifier of the correct answer option, required for polls in quiz mode | ', 'rst_description': '0-based identifier of the correct answer option, required for polls in quiz mode\n', 'name': 'correct_option_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing', 'html_description': 'Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing | ', 'rst_description': 'Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing\n', 'name': 'explanation', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the explanation. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the explanation. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the explanation. See `formatting options `_ for more details.\n', 'name': 'explanation_parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'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', 'name': 'explanation_entities', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Integer', 'required': False, 'description': "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.", 'html_description': "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. | ", 'rst_description': "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.\n", 'name': 'open_period', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.", 'html_description': "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period. | ", 'rst_description': "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*.\n", 'name': 'close_date', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'datetime.datetime'}, {'type': 'std', 'name': 'datetime.timedelta'}, {'type': 'std', 'name': 'int'}]}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the poll needs to be immediately closed. This can be useful for poll preview.', 'html_description': 'Pass True if the poll needs to be immediately closed. This can be useful for poll preview. | ', 'rst_description': 'Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.\n', 'name': 'is_closed', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendpoll
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param question: Poll question, 1-300 characters
@@ -2738,7 +2738,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send static .WEBP, `animated `_ .TGS, or `video `_ .WEBM stickers. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendsticker', 'name': 'sendSticker', 'description': 'Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files', '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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | ', '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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'sticker', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendsticker
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param sticker: 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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `
@@ -2788,7 +2788,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to send information about a venue. On success, the sent :class:`aiogram.types.message.Message` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendvenue', 'name': 'sendVenue', 'description': 'Use this method to send information about a venue. On success, the sent Message is returned.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Float number', 'required': True, 'description': 'Latitude of the venue', 'html_description': 'Latitude of the venue | ', 'rst_description': 'Latitude of the venue\n', 'name': 'latitude', 'parsed_type': {'type': 'std', 'name': 'float'}}, {'type': 'Float number', 'required': True, 'description': 'Longitude of the venue', 'html_description': 'Longitude of the venue | ', 'rst_description': 'Longitude of the venue\n', 'name': 'longitude', 'parsed_type': {'type': 'std', 'name': 'float'}}, {'type': 'String', 'required': True, 'description': 'Name of the venue', 'html_description': 'Name of the venue | ', 'rst_description': 'Name of the venue\n', 'name': 'title', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': True, 'description': 'Address of the venue', 'html_description': 'Address of the venue | ', 'rst_description': 'Address of the venue\n', 'name': 'address', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Foursquare identifier of the venue', 'html_description': 'Foursquare identifier of the venue | ', 'rst_description': 'Foursquare identifier of the venue\n', 'name': 'foursquare_id', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': "Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)", 'html_description': 'Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | ', 'rst_description': "Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)\n", 'name': 'foursquare_type', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Google Places identifier of the venue', 'html_description': 'Google Places identifier of the venue | ', 'rst_description': 'Google Places identifier of the venue\n', 'name': 'google_place_id', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Google Places type of the venue. (See supported types.)', 'html_description': 'Google Places type of the venue. (See supported types.) | ', 'rst_description': 'Google Places type of the venue. (See `supported types `_.)\n', 'name': 'google_place_type', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendvenue
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param latitude: Latitude of the venue
@@ -2854,7 +2854,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendvideo', 'name': 'sendVideo', '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.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files', 'html_description': 'Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files » | ', 'rst_description': 'Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'video', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Duration of sent video in seconds', 'html_description': 'Duration of sent video in seconds | ', 'rst_description': 'Duration of sent video in seconds\n', 'name': 'duration', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Video width', 'html_description': 'Video width | ', 'rst_description': 'Video width\n', 'name': 'width', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Video height', 'html_description': 'Video height | ', 'rst_description': 'Video height\n', 'name': 'height', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile or String', 'required': False, 'description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", 'html_description': 'Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail\'s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can\'t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ', 'rst_description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': False, 'description': 'Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing', 'html_description': 'Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing | ', 'rst_description': 'Video caption (may also be used when resending videos by *file_id*), 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the video caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the video caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the video caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the video needs to be covered with a spoiler animation', 'html_description': 'Pass True if the video needs to be covered with a spoiler animation | ', 'rst_description': 'Pass :code:`True` if the video needs to be covered with a spoiler animation\n', 'name': 'has_spoiler', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the uploaded video is suitable for streaming', 'html_description': 'Pass True if the uploaded video is suitable for streaming | ', 'rst_description': 'Pass :code:`True` if the uploaded video is suitable for streaming\n', 'name': 'supports_streaming', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendvideo
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param video: Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. :ref:`More information on Sending Files » `
@@ -2918,7 +2918,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'anchor': 'sendvideonote', 'name': 'sendVideoNote', '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.', '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': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files. Sending video notes by a URL is currently unsupported', 'html_description': 'Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported | ', 'rst_description': 'Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. :ref:`More information on Sending Files » `. Sending video notes by a URL is currently unsupported\n', 'name': 'video_note', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Duration of sent video in seconds', 'html_description': 'Duration of sent video in seconds | ', 'rst_description': 'Duration of sent video in seconds\n', 'name': 'duration', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Video width and height, i.e. diameter of the video message', 'html_description': 'Video width and height, i.e. diameter of the video message | ', 'rst_description': 'Video width and height, i.e. diameter of the video message\n', 'name': 'length', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile or String', 'required': False, 'description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", 'html_description': 'Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail\'s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can\'t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » | ', 'rst_description': "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendvideonote
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param video_note: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. :ref:`More information on Sending Files » `. Sending video notes by a URL is currently unsupported
@@ -2971,7 +2971,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
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.
- Source: https://core.telegram.org/bots/api#{'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.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile or String', 'required': True, 'description': 'Audio file 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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files', 'html_description': 'Audio file 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 file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | ', 'rst_description': 'Audio file 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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `\n', 'name': 'voice', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only', 'html_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only | ', 'rst_description': 'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Voice message caption, 0-1024 characters after entities parsing', 'html_description': 'Voice message caption, 0-1024 characters after entities parsing | ', 'rst_description': 'Voice message caption, 0-1024 characters after entities parsing\n', 'name': 'caption', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'String', 'required': False, 'description': 'Mode for parsing entities in the voice message caption. See formatting options for more details.', 'html_description': 'Mode for parsing entities in the voice message caption. See formatting options for more details. | ', 'rst_description': 'Mode for parsing entities in the voice message caption. See `formatting options `_ for more details.\n', 'name': 'parse_mode', 'parsed_type': {'type': 'std', 'name': 'str'}, 'value': 'UNSET'}, {'type': 'Array of MessageEntity', 'required': False, 'description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode', 'html_description': 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | ', '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', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'MessageEntity'}}}}, {'type': 'Integer', 'required': False, 'description': 'Duration of the voice message in seconds', 'html_description': 'Duration of the voice message in seconds | ', 'rst_description': 'Duration of the voice message in seconds\n', 'name': 'duration', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Sends the message silently. Users will receive a notification with no sound.', 'html_description': 'Sends the message silently. Users will receive a notification with no sound. | ', 'rst_description': 'Sends the message `silently `_. Users will receive a notification with no sound.\n', 'name': 'disable_notification', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Protects the contents of the sent message from forwarding and saving', 'html_description': 'Protects the contents of the sent message from forwarding and saving | ', 'rst_description': 'Protects the contents of the sent message from forwarding and saving\n', 'name': 'protect_content', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'If the message is a reply, ID of the original message', 'html_description': 'If the message is a reply, ID of the original message | ', 'rst_description': 'If the message is a reply, ID of the original message\n', 'name': 'reply_to_message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the message should be sent even if the specified replied-to message is not found', 'html_description': 'Pass True if the message should be sent even if the specified replied-to message is not found | ', 'rst_description': 'Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n', 'name': 'allow_sending_without_reply', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'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', 'name': 'reply_markup', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardMarkup'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ReplyKeyboardRemove'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'ForceReply'}}]}}], 'category': 'methods', 'returning': {'type': 'Message', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, 'description': 'On success, the sent Message is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#sendvoice
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param voice: Audio file 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 file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `
@@ -3015,7 +3015,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatadministratorcustomtitle', 'name': 'setChatAdministratorCustomTitle', 'description': 'Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.', 'html_description': 'Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
', 'rst_description': 'Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user | ', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': True, 'description': 'New custom title for the administrator; 0-16 characters, emoji are not allowed', 'html_description': 'New custom title for the administrator; 0-16 characters, emoji are not allowed | ', 'rst_description': 'New custom title for the administrator; 0-16 characters, emoji are not allowed\n', 'name': 'custom_title', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatadministratorcustomtitle
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param user_id: Unique identifier of the target user
@@ -3040,7 +3040,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatdescription', 'name': 'setChatDescription', 'description': 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.', 'html_description': 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
', 'rst_description': 'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': False, 'description': 'New chat description, 0-255 characters', 'html_description': 'New chat description, 0-255 characters | ', 'rst_description': 'New chat description, 0-255 characters\n', 'name': 'description', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatdescription
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param description: New chat description, 0-255 characters
@@ -3065,7 +3065,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to change the bot's menu button in a private chat, or the default menu button. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatmenubutton', 'name': 'setChatMenuButton', 'description': "Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.", 'html_description': "Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
", 'rst_description': "Use this method to change the bot's menu button in a private chat, or the default menu button. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer', 'required': False, 'description': "Unique identifier for the target private chat. If not specified, default bot's menu button will be changed", 'html_description': "Unique identifier for the target private chat. If not specified, default bot's menu button will be changed | ", 'rst_description': "Unique identifier for the target private chat. If not specified, default bot's menu button will be changed\n", 'name': 'chat_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'MenuButton', 'required': False, 'description': "A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault", 'html_description': 'A JSON-serialized object for the bot\'s new menu button. Defaults to MenuButtonDefault | ', 'rst_description': "A JSON-serialized object for the bot's new menu button. Defaults to :class:`aiogram.types.menu_button_default.MenuButtonDefault`\n", 'name': 'menu_button', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'MenuButtonDefault'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'MenuButtonWebApp'}}, {'type': 'entity', 'references': {'category': 'types', 'name': 'MenuButtonCommands'}}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatmenubutton
:param chat_id: Unique identifier for the target private chat. If not specified, default bot's menu button will be changed
:param menu_button: A JSON-serialized object for the bot's new menu button. Defaults to :class:`aiogram.types.menu_button_default.MenuButtonDefault`
@@ -3089,7 +3089,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatpermissions', 'name': 'setChatPermissions', 'description': 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.', 'html_description': 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
', 'rst_description': 'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* administrator rights. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'ChatPermissions', 'required': True, 'description': 'A JSON-serialized object for new default chat permissions', 'html_description': 'A JSON-serialized object for new default chat permissions | ', 'rst_description': 'A JSON-serialized object for new default chat permissions\n', 'name': 'permissions', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatPermissions'}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.', 'html_description': 'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | ', 'rst_description': 'Pass :code:`True` if chat permissions are set independently. Otherwise, the *can_send_other_messages* and *can_add_web_page_previews* permissions will imply the *can_send_messages*, *can_send_audios*, *can_send_documents*, *can_send_photos*, *can_send_videos*, *can_send_video_notes*, and *can_send_voice_notes* permissions; the *can_send_polls* permission will imply the *can_send_messages* permission.\n', 'name': 'use_independent_chat_permissions', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatpermissions
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param permissions: A JSON-serialized object for new default chat permissions
@@ -3114,7 +3114,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatphoto', 'name': 'setChatPhoto', 'description': "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", 'html_description': "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
", 'rst_description': "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'InputFile', 'required': True, 'description': 'New chat photo, uploaded using multipart/form-data', 'html_description': 'New chat photo, uploaded using multipart/form-data | ', 'rst_description': 'New chat photo, uploaded using multipart/form-data\n', 'name': 'photo', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatphoto
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param photo: New chat photo, uploaded using multipart/form-data
@@ -3137,7 +3137,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in :class:`aiogram.methods.get_chat.GetChat` requests to check if the bot can use this method. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchatstickerset', 'name': 'setChatStickerSet', 'description': 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.', 'html_description': 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
', 'rst_description': 'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in :class:`aiogram.methods.get_chat.GetChat` requests to check if the bot can use this method. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'Name of the sticker set to be set as the group sticker set', 'html_description': 'Name of the sticker set to be set as the group sticker set | ', 'rst_description': 'Name of the sticker set to be set as the group sticker set\n', 'name': 'sticker_set_name', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchatstickerset
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param sticker_set_name: Name of the sticker set to be set as the group sticker set
@@ -3160,7 +3160,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setchattitle', 'name': 'setChatTitle', 'description': "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.", 'html_description': "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
", 'rst_description': "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'New chat title, 1-128 characters', 'html_description': 'New chat title, 1-128 characters | ', 'rst_description': 'New chat title, 1-128 characters\n', 'name': 'title', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setchattitle
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param title: New chat title, 1-128 characters
@@ -3188,7 +3188,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is :code:`False`.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setgamescore', 'name': 'setGameScore', 'description': "Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.", 'html_description': 'Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user\'s current score in the chat and force is False.
', 'rst_description': "Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is :code:`False`.", 'annotations': [{'type': 'Integer', 'required': True, 'description': 'User identifier', 'html_description': 'User identifier | ', 'rst_description': 'User identifier\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': True, 'description': 'New score, must be non-negative', 'html_description': 'New score, must be non-negative | ', 'rst_description': 'New score, must be non-negative\n', 'name': 'score', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters', 'html_description': 'Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters | ', 'rst_description': 'Pass :code:`True` if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters\n', 'name': 'force', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True if the game message should not be automatically edited to include the current scoreboard', 'html_description': 'Pass True if the game message should not be automatically edited to include the current scoreboard | ', 'rst_description': 'Pass :code:`True` if the game message should not be automatically edited to include the current scoreboard\n', 'name': 'disable_edit_message', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'Integer', 'required': False, 'description': 'Required if inline_message_id is not specified. Unique identifier for the target chat', 'html_description': 'Required if inline_message_id is not specified. Unique identifier for the target chat | ', 'rst_description': 'Required if *inline_message_id* is not specified. Unique identifier for the target chat\n', 'name': 'chat_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Integer', 'required': False, 'description': 'Required if inline_message_id is not specified. Identifier of the sent message', 'html_description': 'Required if inline_message_id is not specified. Identifier of the sent message | ', 'rst_description': 'Required if *inline_message_id* is not specified. Identifier of the sent message\n', 'name': 'message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Required if chat_id and message_id are not specified. Identifier of the inline message', 'html_description': 'Required if chat_id and message_id are not specified. Identifier of the inline message | ', 'rst_description': 'Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n', 'name': 'inline_message_id', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'Message or True', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, {'type': 'std', 'name': 'bool', 'value': True}]}, 'description': "On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False."}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setgamescore
:param user_id: User identifier
:param score: New score, must be non-negative
@@ -3222,7 +3222,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to change the list of the bot's commands. See `this manual `_ for more details about bot commands. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setmycommands', 'name': 'setMyCommands', 'description': "Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.", 'html_description': 'Use this method to change the list of the bot\'s commands. See this manual for more details about bot commands. Returns True on success.
', 'rst_description': "Use this method to change the list of the bot's commands. See `this manual `_ for more details about bot commands. Returns :code:`True` on success.", 'annotations': [{'type': 'Array of BotCommand', 'required': True, 'description': "A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.", 'html_description': "A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. | ", 'rst_description': "A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.\n", 'name': 'commands', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'BotCommand'}}}}, {'type': 'BotCommandScope', 'required': False, 'description': 'A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.', 'html_description': 'A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. | ', 'rst_description': 'A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`.\n', 'name': 'scope', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'BotCommandScope'}}}, {'type': 'String', 'required': False, 'description': 'A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands', 'html_description': 'A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands | ', 'rst_description': 'A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands\n', 'name': 'language_code', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setmycommands
:param commands: A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
:param scope: A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`.
@@ -3247,7 +3247,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setmydefaultadministratorrights', 'name': 'setMyDefaultAdministratorRights', 'description': "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.", 'html_description': "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
", 'rst_description': "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns :code:`True` on success.", 'annotations': [{'type': 'ChatAdministratorRights', 'required': False, 'description': 'A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.', 'html_description': 'A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared. | ', 'rst_description': 'A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.\n', 'name': 'rights', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'ChatAdministratorRights'}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.', 'html_description': 'Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. | ', 'rst_description': 'Pass :code:`True` to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.\n', 'name': 'for_channels', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setmydefaultadministratorrights
:param rights: A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
:param for_channels: Pass :code:`True` to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
@@ -3271,7 +3271,7 @@ class Bot(ContextInstanceMixin["Bot"]):
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns :code:`True` on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setpassportdataerrors', 'name': 'setPassportDataErrors', 'description': "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.", 'html_description': "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
", 'rst_description': "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns :code:`True` on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.", 'annotations': [{'type': 'Integer', 'required': True, 'description': 'User identifier', 'html_description': 'User identifier | ', 'rst_description': 'User identifier\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Array of PassportElementError', 'required': True, 'description': 'A JSON-serialized array describing the errors', 'html_description': 'A JSON-serialized array describing the errors | ', 'rst_description': 'A JSON-serialized array describing the errors\n', 'name': 'errors', 'parsed_type': {'type': 'array', 'items': {'type': 'entity', 'references': {'category': 'types', 'name': 'PassportElementError'}}}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setpassportdataerrors
:param user_id: User identifier
:param errors: A JSON-serialized array describing the errors
@@ -3294,7 +3294,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to move a sticker in a set created by the bot to a specific position. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setstickerpositioninset', 'name': 'setStickerPositionInSet', 'description': 'Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.', 'html_description': 'Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
', 'rst_description': 'Use this method to move a sticker in a set created by the bot to a specific position. Returns :code:`True` on success.', 'annotations': [{'type': 'String', 'required': True, 'description': 'File identifier of the sticker', 'html_description': 'File identifier of the sticker | ', 'rst_description': 'File identifier of the sticker\n', 'name': 'sticker', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': True, 'description': 'New sticker position in the set, zero-based', 'html_description': 'New sticker position in the set, zero-based | ', 'rst_description': 'New sticker position in the set, zero-based\n', 'name': 'position', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setstickerpositioninset
:param sticker: File identifier of the sticker
:param position: New sticker position in the set, zero-based
@@ -3318,7 +3318,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setstickersetthumb', 'name': 'setStickerSetThumb', 'description': 'Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.', 'html_description': 'Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
', 'rst_description': 'Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns :code:`True` on success.', 'annotations': [{'type': 'String', 'required': True, 'description': 'Sticker set name', 'html_description': 'Sticker set name | ', 'rst_description': 'Sticker set name\n', 'name': 'name', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'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', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile or String', 'required': False, 'description': "A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the 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 sticker set thumbnails can't be uploaded via HTTP URL.", 'html_description': 'A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the 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 sticker set thumbnails can\'t be uploaded via HTTP URL. | ', 'rst_description': "A **PNG** image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a **TGS** animation with the 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 sticker set thumbnails can't be uploaded via HTTP URL.\n", 'name': 'thumb', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setstickersetthumb
:param name: Sticker set name
:param user_id: User identifier of the sticker set owner
@@ -3358,7 +3358,7 @@ class Bot(ContextInstanceMixin["Bot"]):
**3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**.
If you're having any trouble setting up webhooks, please check out this `amazing guide to webhooks `_.
- Source: https://core.telegram.org/bots/api#{'anchor': 'setwebhook', 'name': 'setWebhook', 'description': "Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\nNotes\n1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.\n2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.\n3. Ports currently supported for webhooks: 443, 80, 88, 8443.\nIf you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.", 'html_description': 'Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you\'d like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
\nNotes
\n1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
\n2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
\n3. Ports currently supported for webhooks: 443, 80, 88, 8443.
\nIf you\'re having any trouble setting up webhooks, please check out this amazing guide to webhooks.
\n
', 'rst_description': "Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized :class:`aiogram.types.update.Update`. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns :code:`True` on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret_token*. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\n\n **Notes**\n \n **1.** You will not be able to receive updates using :class:`aiogram.methods.get_updates.GetUpdates` for as long as an outgoing webhook is set up.\n \n **2.** To use a self-signed certificate, you need to upload your `public key certificate `_ using *certificate* parameter. Please upload as InputFile, sending a String will not work.\n \n **3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**.\n If you're having any trouble setting up webhooks, please check out this `amazing guide to webhooks `_.", 'annotations': [{'type': 'String', 'required': True, 'description': 'HTTPS URL to send updates to. Use an empty string to remove webhook integration', 'html_description': 'HTTPS URL to send updates to. Use an empty string to remove webhook integration | ', 'rst_description': 'HTTPS URL to send updates to. Use an empty string to remove webhook integration\n', 'name': 'url', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'InputFile', 'required': False, 'description': 'Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.', 'html_description': 'Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. | ', 'rst_description': 'Upload your public key certificate so that the root certificate in use can be checked. See our `self-signed guide `_ for details.\n', 'name': 'certificate', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}}, {'type': 'String', 'required': False, 'description': 'The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS', 'html_description': 'The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS | ', 'rst_description': 'The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS\n', 'name': 'ip_address', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'Integer', 'required': False, 'description': "The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.", 'html_description': "The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | ", 'rst_description': "The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to *40*. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.\n", 'name': 'max_connections', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Array of String', 'required': False, 'description': "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.", 'html_description': 'A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
\nPlease note that this parameter doesn\'t affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. | ', 'rst_description': "A JSON-serialized list of the update types you want your bot to receive. For example, specify ['message', 'edited_channel_post', 'callback_query'] to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member* (default). If not specified, the previous setting will be used.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.\n", 'name': 'allowed_updates', 'parsed_type': {'type': 'array', 'items': {'type': 'std', 'name': 'str'}}}, {'type': 'Boolean', 'required': False, 'description': 'Pass True to drop all pending updates', 'html_description': 'Pass True to drop all pending updates | ', 'rst_description': 'Pass :code:`True` to drop all pending updates\n', 'name': 'drop_pending_updates', 'parsed_type': {'type': 'std', 'name': 'bool'}}, {'type': 'String', 'required': False, 'description': "A secret token to be sent in a header 'X-Telegram-Bot-Api-Secret-Token' in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.", 'html_description': 'A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. | ', 'rst_description': "A secret token to be sent in a header 'X-Telegram-Bot-Api-Secret-Token' in every webhook request, 1-256 characters. Only characters :code:`A-Z`, :code:`a-z`, :code:`0-9`, :code:`_` and :code:`-` are allowed. The header is useful to ensure that the request comes from a webhook set by you.\n", 'name': 'secret_token', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#setwebhook
:param url: HTTPS URL to send updates to. Use an empty string to remove webhook integration
:param certificate: Upload your public key certificate so that the root certificate in use can be checked. See our `self-signed guide `_ for details.
@@ -3393,7 +3393,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'stopmessagelivelocation', 'name': 'stopMessageLiveLocation', 'description': 'Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.', 'html_description': 'Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
', 'rst_description': 'Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.', 'annotations': [{'type': 'Integer or String', 'required': False, 'description': 'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Required if inline_message_id is not specified. Identifier of the message with live location to stop', 'html_description': 'Required if inline_message_id is not specified. Identifier of the message with live location to stop | ', 'rst_description': 'Required if *inline_message_id* is not specified. Identifier of the message with live location to stop\n', 'name': 'message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'String', 'required': False, 'description': 'Required if chat_id and message_id are not specified. Identifier of the inline message', 'html_description': 'Required if chat_id and message_id are not specified. Identifier of the inline message | ', 'rst_description': 'Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n', 'name': 'inline_message_id', 'parsed_type': {'type': 'std', 'name': 'str'}}, {'type': 'InlineKeyboardMarkup', 'required': False, 'description': 'A JSON-serialized object for a new inline keyboard.', 'html_description': 'A JSON-serialized object for a new inline keyboard. | ', 'rst_description': 'A JSON-serialized object for a new `inline keyboard `_.\n', 'name': 'reply_markup', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}}], 'category': 'methods', 'returning': {'type': 'Message or True', 'parsed_type': {'type': 'union', 'items': [{'type': 'entity', 'references': {'category': 'types', 'name': 'Message'}}, {'type': 'std', 'name': 'bool', 'value': True}]}, 'description': 'On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#stopmessagelivelocation
:param chat_id: Required if *inline_message_id* is not specified. Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_id: Required if *inline_message_id* is not specified. Identifier of the message with live location to stop
@@ -3421,7 +3421,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to stop a poll which was sent by the bot. On success, the stopped :class:`aiogram.types.poll.Poll` is returned.
- Source: https://core.telegram.org/bots/api#{'anchor': 'stoppoll', 'name': 'stopPoll', 'description': 'Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.', 'html_description': 'Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
', 'rst_description': 'Use this method to stop a poll which was sent by the bot. On success, the stopped :class:`aiogram.types.poll.Poll` is returned.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Identifier of the original message with the poll', 'html_description': 'Identifier of the original message with the poll | ', 'rst_description': 'Identifier of the original message with the poll\n', 'name': 'message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InlineKeyboardMarkup', 'required': False, 'description': 'A JSON-serialized object for a new message inline keyboard.', 'html_description': 'A JSON-serialized object for a new message inline keyboard. | ', 'rst_description': 'A JSON-serialized object for a new message `inline keyboard `_.\n', 'name': 'reply_markup', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InlineKeyboardMarkup'}}}], 'category': 'methods', 'returning': {'type': 'Poll', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'Poll'}}, 'description': 'On success, the stopped Poll is returned.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#stoppoll
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_id: Identifier of the original message with the poll
@@ -3447,7 +3447,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unbanchatmember', 'name': 'unbanChatMember', 'description': "Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.", 'html_description': "Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
", 'rst_description': "Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target user', 'html_description': 'Unique identifier of the target user | ', 'rst_description': 'Unique identifier of the target user\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'Boolean', 'required': False, 'description': 'Do nothing if the user is not banned', 'html_description': 'Do nothing if the user is not banned | ', 'rst_description': 'Do nothing if the user is not banned\n', 'name': 'only_if_banned', 'parsed_type': {'type': 'std', 'name': 'bool'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'The user will not return to the group or channel automatically, but will be able to join via link, etc. Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unbanchatmember
:param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`)
:param user_id: Unique identifier of the target user
@@ -3472,7 +3472,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unbanchatsenderchat', 'name': 'unbanChatSenderChat', 'description': 'Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.', 'html_description': 'Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
', 'rst_description': 'Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier of the target sender chat', 'html_description': 'Unique identifier of the target sender chat | ', 'rst_description': 'Unique identifier of the target sender chat\n', 'name': 'sender_chat_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unbanchatsenderchat
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param sender_chat_id: Unique identifier of the target sender chat
@@ -3494,7 +3494,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unpinallchatmessages', 'name': 'unpinAllChatMessages', 'description': "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", 'html_description': "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
", 'rst_description': "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unpinallchatmessages
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param request_timeout: Request timeout
@@ -3515,7 +3515,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unpinallforumtopicmessages', 'name': 'unpinAllForumTopicMessages', 'description': 'Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.', 'html_description': 'Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
', 'rst_description': 'Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns :code:`True` on success.', 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': True, 'description': 'Unique identifier for the target message thread of the forum topic', 'html_description': 'Unique identifier for the target message thread of the forum topic | ', 'rst_description': 'Unique identifier for the target message thread of the forum topic\n', 'name': 'message_thread_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unpinallforumtopicmessages
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param message_thread_id: Unique identifier for the target message thread of the forum topic
@@ -3538,7 +3538,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unpinchatmessage', 'name': 'unpinChatMessage', 'description': "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.", 'html_description': "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
", 'rst_description': "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername)', 'html_description': 'Unique identifier for the target chat or username of the target channel (in the format @channelusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'Integer', 'required': False, 'description': 'Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.', 'html_description': 'Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. | ', 'rst_description': 'Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.\n', 'name': 'message_id', 'parsed_type': {'type': 'std', 'name': 'int'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unpinchatmessage
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)
:param message_id: Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.
@@ -3561,7 +3561,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to upload a .PNG file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'uploadstickerfile', 'name': 'uploadStickerFile', 'description': 'Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.', 'html_description': 'Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
', 'rst_description': 'Use this method to upload a .PNG file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.', 'annotations': [{'type': 'Integer', 'required': True, 'description': 'User identifier of sticker file owner', 'html_description': 'User identifier of sticker file owner | ', 'rst_description': 'User identifier of sticker file owner\n', 'name': 'user_id', 'parsed_type': {'type': 'std', 'name': 'int'}}, {'type': 'InputFile', 'required': True, 'description': 'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files', 'html_description': 'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files » | ', 'rst_description': '**PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. :ref:`More information on Sending Files » `\n', 'name': 'png_sticker', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'InputFile'}}}], 'category': 'methods', 'returning': {'type': 'File', 'parsed_type': {'type': 'entity', 'references': {'category': 'types', 'name': 'File'}}, 'description': 'Returns the uploaded File on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#uploadstickerfile
:param user_id: User identifier of sticker file owner
:param png_sticker: **PNG** image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. :ref:`More information on Sending Files » `
@@ -3583,7 +3583,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'closegeneralforumtopic', 'name': 'closeGeneralForumTopic', 'description': "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.", 'html_description': "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
", 'rst_description': "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#closegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param request_timeout: Request timeout
@@ -3604,7 +3604,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'editgeneralforumtopic', 'name': 'editGeneralForumTopic', 'description': "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.", 'html_description': "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
", 'rst_description': "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have *can_manage_topics* administrator rights. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}, {'type': 'String', 'required': True, 'description': 'New topic name, 1-128 characters', 'html_description': 'New topic name, 1-128 characters | ', 'rst_description': 'New topic name, 1-128 characters\n', 'name': 'name', 'parsed_type': {'type': 'std', 'name': 'str'}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#editgeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param name: New topic name, 1-128 characters
@@ -3626,7 +3626,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'hidegeneralforumtopic', 'name': 'hideGeneralForumTopic', 'description': "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.", 'html_description': "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
", 'rst_description': "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#hidegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param request_timeout: Request timeout
@@ -3646,7 +3646,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'reopengeneralforumtopic', 'name': 'reopenGeneralForumTopic', 'description': "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.", 'html_description': "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
", 'rst_description': "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#reopengeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param request_timeout: Request timeout
@@ -3666,7 +3666,7 @@ class Bot(ContextInstanceMixin["Bot"]):
"""
Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.
- Source: https://core.telegram.org/bots/api#{'anchor': 'unhidegeneralforumtopic', 'name': 'unhideGeneralForumTopic', 'description': "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.", 'html_description': "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
", 'rst_description': "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns :code:`True` on success.", 'annotations': [{'type': 'Integer or String', 'required': True, 'description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)', 'html_description': 'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) | ', 'rst_description': 'Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n', 'name': 'chat_id', 'parsed_type': {'type': 'union', 'items': [{'type': 'std', 'name': 'int'}, {'type': 'std', 'name': 'str'}]}}], 'category': 'methods', 'returning': {'type': 'True', 'parsed_type': {'type': 'std', 'name': 'bool', 'value': True}, 'description': 'Returns True on success.'}, 'bases': ['TelegramMethod']}
+ Source: https://core.telegram.org/bots/api#unhidegeneralforumtopic
:param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)
:param request_timeout: Request timeout
”, “
”, “
”, “
”, “
”, or “
”. Dice can have values 1-6 for “