"description":"This object represents an incoming update.\nAt most one of the optional parameters can be present in any given update.",
"html_description":"<p>This <a href=\"#available-types\">object</a> represents an incoming update.<br/>\nAt most <strong>one</strong> of the optional parameters can be present in any given update.</p>",
"rst_description":"This `object <https://core.telegram.org/bots/api#available-types>`_ represents an incoming update.\n\nAt most **one** of the optional parameters can be present in any given update.",
"description":"The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.",
"html_description":"<td>The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using <a href=\"#setwebhook\">webhooks</a>, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.</td>",
"rst_description":"The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using `webhooks <https://core.telegram.org/bots/api#setwebhook>`_, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.\n",
"description":"New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.",
"html_description":"<td><em>Optional</em>. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.</td>",
"rst_description":"*Optional*. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.\n",
"description":"New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.",
"html_description":"<td><em>Optional</em>. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.</td>",
"rst_description":"*Optional*. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.\n",
"description":"The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot",
"html_description":"<td><em>Optional</em>. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot</td>",
"rst_description":"*Optional*. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot\n",
"description":"A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify \"message_reaction\" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.",
"html_description":"<td><em>Optional</em>. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify <code>\"message_reaction\"</code> in the list of <em>allowed_updates</em> to receive these updates. The update isn't received for reactions set by bots.</td>",
"rst_description":"*Optional*. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify :code:`\"message_reaction\"` in the list of *allowed_updates* to receive these updates. The update isn't received for reactions set by bots.\n",
"description":"Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify \"message_reaction_count\" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.",
"html_description":"<td><em>Optional</em>. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify <code>\"message_reaction_count\"</code> in the list of <em>allowed_updates</em> to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.</td>",
"rst_description":"*Optional*. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify :code:`\"message_reaction_count\"` in the list of *allowed_updates* to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.\n",
"html_description":"<td><em>Optional</em>. New incoming <a href=\"#inline-mode\">inline</a> query</td>",
"rst_description":"*Optional*. New incoming `inline <https://core.telegram.org/bots/api#inline-mode>`_ query\n",
"name":"inline_query",
"required":false
},
{
"type":"ChosenInlineResult",
"description":"The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.",
"html_description":"<td><em>Optional</em>. The result of an <a href=\"#inline-mode\">inline</a> query that was chosen by a user and sent to their chat partner. Please see our documentation on the <a href=\"/bots/inline#collecting-feedback\">feedback collecting</a> for details on how to enable these updates for your bot.</td>",
"rst_description":"*Optional*. The result of an `inline <https://core.telegram.org/bots/api#inline-mode>`_ query that was chosen by a user and sent to their chat partner. Please see our documentation on the `feedback collecting <https://core.telegram.org/bots/inline#collecting-feedback>`_ for details on how to enable these updates for your bot.\n",
"name":"chosen_inline_result",
"required":false
},
{
"type":"CallbackQuery",
"description":"New incoming callback query",
"html_description":"<td><em>Optional</em>. New incoming callback query</td>",
"rst_description":"*Optional*. New incoming callback query\n",
"name":"callback_query",
"required":false
},
{
"type":"ShippingQuery",
"description":"New incoming shipping query. Only for invoices with flexible price",
"html_description":"<td><em>Optional</em>. New incoming shipping query. Only for invoices with flexible price</td>",
"rst_description":"*Optional*. New incoming shipping query. Only for invoices with flexible price\n",
"name":"shipping_query",
"required":false
},
{
"type":"PreCheckoutQuery",
"description":"New incoming pre-checkout query. Contains full information about checkout",
"html_description":"<td><em>Optional</em>. New incoming pre-checkout query. Contains full information about checkout</td>",
"rst_description":"*Optional*. New incoming pre-checkout query. Contains full information about checkout\n",
"description":"New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot",
"html_description":"<td><em>Optional</em>. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot</td>",
"rst_description":"*Optional*. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot\n",
"description":"A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.",
"html_description":"<td><em>Optional</em>. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.</td>",
"rst_description":"*Optional*. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.\n",
"name":"poll_answer",
"required":false
},
{
"type":"ChatMemberUpdated",
"description":"The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.",
"html_description":"<td><em>Optional</em>. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.</td>",
"rst_description":"*Optional*. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.\n",
"description":"A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify \"chat_member\" in the list of allowed_updates to receive these updates.",
"html_description":"<td><em>Optional</em>. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify <code>\"chat_member\"</code> in the list of <em>allowed_updates</em> to receive these updates.</td>",
"rst_description":"*Optional*. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify :code:`\"chat_member\"` in the list of *allowed_updates* to receive these updates.\n",
"description":"A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.",
"html_description":"<td><em>Optional</em>. A request to join the chat has been sent. The bot must have the <em>can_invite_users</em> administrator right in the chat to receive these updates.</td>",
"rst_description":"*Optional*. A request to join the chat has been sent. The bot must have the *can_invite_users* administrator right in the chat to receive these updates.\n",
"description":"A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.",
"html_description":"<td><em>Optional</em>. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.</td>",
"rst_description":"*Optional*. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.\n",
"name":"chat_boost",
"required":false
},
{
"type":"ChatBoostRemoved",
"description":"A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.",
"html_description":"<td><em>Optional</em>. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.</td>",
"rst_description":"*Optional*. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.\n",
"description":"Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.\nNotes\n1. This method will not work if an outgoing webhook is set up.\n2. In order to avoid getting duplicate updates, recalculate offset after each server response.",
"html_description":"<p>Use this method to receive incoming updates using long polling (<a href=\"https://en.wikipedia.org/wiki/Push_technology#Long_polling\">wiki</a>). Returns an Array of <a href=\"#update\">Update</a> objects.</p><blockquote>\n<p><strong>Notes</strong><br/>\n<strong>1.</strong> This method will not work if an outgoing webhook is set up.<br/>\n<strong>2.</strong> In order to avoid getting duplicate updates, recalculate <em>offset</em> after each server response.</p>\n</blockquote>",
"rst_description":"Use this method to receive incoming updates using long polling (`wiki <https://en.wikipedia.org/wiki/Push_technology#Long_polling>`_). 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.",
"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 be forgotten.",
"html_description":"<td>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 <a href=\"#getupdates\">getUpdates</a> is called with an <em>offset</em> higher than its <em>update_id</em>. The negative offset can be specified to retrieve updates starting from <em>-offset</em> update from the end of the updates queue. All previous updates will be forgotten.</td>",
"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 be forgotten.\n",
"description":"Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
"html_description":"<td>Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.</td>",
"rst_description":"Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
"name":"limit"
},
{
"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":"<td>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.</td>",
"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",
"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, message_reaction, and message_reaction_count (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 getUpdates, so unwanted updates may be received for a short period of time.",
"html_description":"<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em>, <em>message_reaction</em>, and <em>message_reaction_count</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.</td>",
"rst_description":"A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"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*, *message_reaction*, and *message_reaction_count* (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 getUpdates, so unwanted updates may be received for a short period of time.\n",
"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 (a request with response HTTP status code different from 2XY), we will repeat the request and 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":"<p>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 <a href=\"#update\">Update</a>. In case of an unsuccessful request (a request with response <a href=\"https://en.wikipedia.org/wiki/List_of_HTTP_status_codes\">HTTP status code</a> different from <code>2XY</code>), we will repeat the request and give up after a reasonable amount of attempts. Returns <em>True</em> on success.</p><p>If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter <em>secret_token</em>. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.</p><blockquote>\n<p><strong>Notes</strong><br/>\n<strong>1.</strong> You will not be able to receive updates using <a href=\"#getupdates\">getUpdates</a> for as long as an outgoing webhook is set up.<br/>\n<strong>2.</strong> To use a self-signed certificate, you need to upload your <a href=\"/bots/self-signed\">public key certificate</a> using <em>certificate</em> parameter. Please upload as InputFile, sending a String will not work.<br/>\n<strong>3.</strong> Ports currently supported <em>for webhooks</em>: <strong>443, 80, 88, 8443</strong>.</p>\n<p>If you're having any trouble setting up webhooks, please check out this <a href=\"/bots/webhooks\">amazing guide to webhooks</a>.</p>\n</blockquote>",
"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 (a request with response `HTTP status code <https://en.wikipedia.org/wiki/List_of_HTTP_status_codes>`_ different from :code:`2XY`), we will repeat the request and 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 <https://core.telegram.org/bots/self-signed>`_ 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 <https://core.telegram.org/bots/webhooks>`_.",
"description":"HTTPS URL to send updates to. Use an empty string to remove webhook integration",
"html_description":"<td>HTTPS URL to send updates to. Use an empty string to remove webhook integration</td>",
"rst_description":"HTTPS URL to send updates to. Use an empty string to remove webhook integration\n",
"name":"url"
},
{
"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":"<td>Upload your public key certificate so that the root certificate in use can be checked. See our <a href=\"/bots/self-signed\">self-signed guide</a> for details.</td>",
"rst_description":"Upload your public key certificate so that the root certificate in use can be checked. See our `self-signed guide <https://core.telegram.org/bots/self-signed>`_ for details.\n",
"name":"certificate"
},
{
"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":"<td>The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS</td>",
"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"
},
{
"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":"<td>The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to <em>40</em>. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.</td>",
"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",
"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, message_reaction, and message_reaction_count (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":"<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em>, <em>message_reaction</em>, and <em>message_reaction_count</em> (default). If not specified, the previous setting will be used.<br/>\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.</td>",
"rst_description":"A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"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*, *message_reaction*, and *message_reaction_count* (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",
"description":"Pass True to drop all pending updates",
"html_description":"<td>Pass <em>True</em> to drop all pending updates</td>",
"rst_description":"Pass :code:`True` to drop all pending updates\n",
"name":"drop_pending_updates"
},
{
"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":"<td>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>, <code>a-z</code>, <code>0-9</code>, <code>_</code> and <code>-</code> are allowed. The header is useful to ensure that the request comes from a webhook set by you.</td>",
"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"
}
],
"category":"methods"
},
{
"anchor":"deletewebhook",
"name":"deleteWebhook",
"description":"Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.",
"html_description":"<p>Use this method to remove webhook integration if you decide to switch back to <a href=\"#getupdates\">getUpdates</a>. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to remove webhook integration if you decide to switch back to :class:`aiogram.methods.get_updates.GetUpdates`. Returns :code:`True` on success.",
"annotations":[
{
"type":"Boolean",
"required":false,
"description":"Pass True to drop all pending updates",
"html_description":"<td>Pass <em>True</em> to drop all pending updates</td>",
"rst_description":"Pass :code:`True` to drop all pending updates\n",
"name":"drop_pending_updates"
}
],
"category":"methods"
},
{
"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":"<p>Use this method to get current webhook status. Requires no parameters. On success, returns a <a href=\"#webhookinfo\">WebhookInfo</a> object. If the bot is using <a href=\"#getupdates\">getUpdates</a>, will return an object with the <em>url</em> field empty.</p>",
"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"
},
{
"anchor":"webhookinfo",
"name":"WebhookInfo",
"description":"Describes the current status of a webhook.",
"html_description":"<p>Describes the current status of a webhook.</p>",
"rst_description":"Describes the current status of a webhook.",
"annotations":[
{
"type":"String",
"description":"Webhook URL, may be empty if webhook is not set up",
"html_description":"<td>Webhook URL, may be empty if webhook is not set up</td>",
"rst_description":"Webhook URL, may be empty if webhook is not set up\n",
"name":"url",
"required":true
},
{
"type":"Boolean",
"description":"True, if a custom certificate was provided for webhook certificate checks",
"html_description":"<td><em>True</em>, if a custom certificate was provided for webhook certificate checks</td>",
"rst_description":":code:`True`, if a custom certificate was provided for webhook certificate checks\n",
"name":"has_custom_certificate",
"required":true
},
{
"type":"Integer",
"description":"Number of updates awaiting delivery",
"html_description":"<td>Number of updates awaiting delivery</td>",
"rst_description":"Number of updates awaiting delivery\n",
"name":"pending_update_count",
"required":true
},
{
"type":"String",
"description":"Currently used webhook IP address",
"html_description":"<td><em>Optional</em>. Currently used webhook IP address</td>",
"rst_description":"*Optional*. Currently used webhook IP address\n",
"name":"ip_address",
"required":false
},
{
"type":"Integer",
"description":"Unix time for the most recent error that happened when trying to deliver an update via webhook",
"html_description":"<td><em>Optional</em>. Unix time for the most recent error that happened when trying to deliver an update via webhook</td>",
"rst_description":"*Optional*. Unix time for the most recent error that happened when trying to deliver an update via webhook\n",
"name":"last_error_date",
"required":false
},
{
"type":"String",
"description":"Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook",
"html_description":"<td><em>Optional</em>. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook</td>",
"rst_description":"*Optional*. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook\n",
"name":"last_error_message",
"required":false
},
{
"type":"Integer",
"description":"Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters",
"html_description":"<td><em>Optional</em>. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters</td>",
"rst_description":"*Optional*. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters\n",
"name":"last_synchronization_error_date",
"required":false
},
{
"type":"Integer",
"description":"The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery",
"html_description":"<td><em>Optional</em>. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery</td>",
"rst_description":"*Optional*. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery\n",
"name":"max_connections",
"required":false
},
{
"type":"Array of String",
"description":"A list of update types the bot is subscribed to. Defaults to all update types except chat_member",
"html_description":"<td><em>Optional</em>. A list of update types the bot is subscribed to. Defaults to all update types except <em>chat_member</em></td>",
"rst_description":"*Optional*. A list of update types the bot is subscribed to. Defaults to all update types except *chat_member*\n",
"name":"allowed_updates",
"required":false
}
],
"category":"types"
}
],
"description":"There are two mutually exclusive ways of receiving updates for your bot - the getUpdates method on one hand and webhooks on the other. Incoming updates are stored on the server until the bot receives them either way, but they will not be kept longer than 24 hours.\nRegardless of which option you choose, you will receive JSON-serialized Update objects as a result."
},
{
"title":"Available types",
"anchor":"available-types",
"children":[
{
"anchor":"user",
"name":"User",
"description":"This object represents a Telegram user or bot.",
"html_description":"<p>This object represents a Telegram user or bot.</p>",
"rst_description":"This object represents a Telegram user or bot.",
"annotations":[
{
"type":"Integer",
"description":"Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td>Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"id",
"required":true
},
{
"type":"Boolean",
"description":"True, if this user is a bot",
"html_description":"<td><em>True</em>, if this user is a bot</td>",
"rst_description":":code:`True`, if this user is a bot\n",
"name":"is_bot",
"required":true
},
{
"type":"String",
"description":"User's or bot's first name",
"html_description":"<td>User's or bot's first name</td>",
"rst_description":"User's or bot's first name\n",
"name":"first_name",
"required":true
},
{
"type":"String",
"description":"User's or bot's last name",
"html_description":"<td><em>Optional</em>. User's or bot's last name</td>",
"rst_description":"*Optional*. User's or bot's last name\n",
"name":"last_name",
"required":false
},
{
"type":"String",
"description":"User's or bot's username",
"html_description":"<td><em>Optional</em>. User's or bot's username</td>",
"rst_description":"*Optional*. User's or bot's username\n",
"name":"username",
"required":false
},
{
"type":"String",
"description":"IETF language tag of the user's language",
"html_description":"<td><em>Optional</em>. <a href=\"https://en.wikipedia.org/wiki/IETF_language_tag\">IETF language tag</a> of the user's language</td>",
"rst_description":"*Optional*. `IETF language tag <https://en.wikipedia.org/wiki/IETF_language_tag>`_ of the user's language\n",
"name":"language_code",
"required":false
},
{
"type":"True",
"description":"True, if this user is a Telegram Premium user",
"html_description":"<td><em>Optional</em>. <em>True</em>, if this user is a Telegram Premium user</td>",
"rst_description":"*Optional*. :code:`True`, if this user is a Telegram Premium user\n",
"name":"is_premium",
"required":false
},
{
"type":"True",
"description":"True, if this user added the bot to the attachment menu",
"html_description":"<td><em>Optional</em>. <em>True</em>, if this user added the bot to the attachment menu</td>",
"rst_description":"*Optional*. :code:`True`, if this user added the bot to the attachment menu\n",
"name":"added_to_attachment_menu",
"required":false
},
{
"type":"Boolean",
"description":"True, if the bot can be invited to groups. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can be invited to groups. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can be invited to groups. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"name":"can_join_groups",
"required":false
},
{
"type":"Boolean",
"description":"True, if privacy mode is disabled for the bot. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if <a href=\"/bots/features#privacy-mode\">privacy mode</a> is disabled for the bot. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if `privacy mode <https://core.telegram.org/bots/features#privacy-mode>`_ is disabled for the bot. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"name":"can_read_all_group_messages",
"required":false
},
{
"type":"Boolean",
"description":"True, if the bot supports inline queries. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot supports inline queries. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if the bot supports inline queries. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"description":"True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"description":"True, if the bot has forum topic mode enabled in private chats. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot has forum topic mode enabled in private chats. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if the bot has forum topic mode enabled in private chats. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"description":"True, if the bot allows users to create and delete topics in private chats. Returned only in getMe.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot allows users to create and delete topics in private chats. Returned only in <a href=\"#getme\">getMe</a>.</td>",
"rst_description":"*Optional*. :code:`True`, if the bot allows users to create and delete topics in private chats. Returned only in :class:`aiogram.methods.get_me.GetMe`.\n",
"html_description":"<p>This object represents a chat.</p>",
"rst_description":"This object represents a chat.",
"annotations":[
{
"type":"Integer",
"description":"Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td>Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"description":"Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description":"<td>Type of the chat, can be either “private”, “group”, “supergroup” or “channel”</td>",
"rst_description":"Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"description":"Title, for supergroups, channels and group chats",
"html_description":"<td><em>Optional</em>. Title, for supergroups, channels and group chats</td>",
"rst_description":"*Optional*. Title, for supergroups, channels and group chats\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Username, for private chats, supergroups and channels if available",
"html_description":"<td><em>Optional</em>. Username, for private chats, supergroups and channels if available</td>",
"rst_description":"*Optional*. Username, for private chats, supergroups and channels if available\n",
"name":"username",
"required":false
},
{
"type":"String",
"description":"First name of the other party in a private chat",
"html_description":"<td><em>Optional</em>. First name of the other party in a private chat</td>",
"rst_description":"*Optional*. First name of the other party in a private chat\n",
"name":"first_name",
"required":false
},
{
"type":"String",
"description":"Last name of the other party in a private chat",
"html_description":"<td><em>Optional</em>. Last name of the other party in a private chat</td>",
"rst_description":"*Optional*. Last name of the other party in a private chat\n",
"name":"last_name",
"required":false
},
{
"type":"True",
"description":"True, if the supergroup chat is a forum (has topics enabled)",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the supergroup chat is a forum (has <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups\">topics</a> enabled)</td>",
"rst_description":"*Optional*. :code:`True`, if the supergroup chat is a forum (has `topics <https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups>`_ enabled)\n",
"description":"This object contains full information about a chat.",
"html_description":"<p>This object contains full information about a chat.</p>",
"rst_description":"This object contains full information about a chat.",
"annotations":[
{
"type":"Integer",
"description":"Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td>Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'",
"html_description":"<td>Type of the chat, can be either “private”, “group”, “supergroup” or “channel”</td>",
"rst_description":"Type of the chat, can be either 'private', 'group', 'supergroup' or 'channel'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Title, for supergroups, channels and group chats",
"html_description":"<td><em>Optional</em>. Title, for supergroups, channels and group chats</td>",
"rst_description":"*Optional*. Title, for supergroups, channels and group chats\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Username, for private chats, supergroups and channels if available",
"html_description":"<td><em>Optional</em>. Username, for private chats, supergroups and channels if available</td>",
"rst_description":"*Optional*. Username, for private chats, supergroups and channels if available\n",
"name":"username",
"required":false
},
{
"type":"String",
"description":"First name of the other party in a private chat",
"html_description":"<td><em>Optional</em>. First name of the other party in a private chat</td>",
"rst_description":"*Optional*. First name of the other party in a private chat\n",
"name":"first_name",
"required":false
},
{
"type":"String",
"description":"Last name of the other party in a private chat",
"html_description":"<td><em>Optional</em>. Last name of the other party in a private chat</td>",
"rst_description":"*Optional*. Last name of the other party in a private chat\n",
"name":"last_name",
"required":false
},
{
"type":"True",
"description":"True, if the supergroup chat is a forum (has topics enabled)",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the supergroup chat is a forum (has <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups\">topics</a> enabled)</td>",
"rst_description":"*Optional*. :code:`True`, if the supergroup chat is a forum (has `topics <https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups>`_ enabled)\n",
"description":"Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.",
"html_description":"<td>Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See <a href=\"#accent-colors\">accent colors</a> for more details.</td>",
"rst_description":"Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See `accent colors <https://core.telegram.org/bots/api#accent-colors>`_ for more details.\n",
"name":"accent_color_id",
"required":true
},
{
"type":"Integer",
"description":"The maximum number of reactions that can be set on a message in the chat",
"html_description":"<td>The maximum number of reactions that can be set on a message in the chat</td>",
"rst_description":"The maximum number of reactions that can be set on a message in the chat\n",
"description":"If non-empty, the list of all active chat usernames; for private chats, supergroups and channels",
"html_description":"<td><em>Optional</em>. If non-empty, the list of all <a href=\"https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames\">active chat usernames</a>; for private chats, supergroups and channels</td>",
"rst_description":"*Optional*. If non-empty, the list of all `active chat usernames <https://telegram.org/blog/topics-in-groups-collectible-usernames#collectible-usernames>`_; for private chats, supergroups and channels\n",
"description":"List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.",
"html_description":"<td><em>Optional</em>. List of available reactions allowed in the chat. If omitted, then all <a href=\"#reactiontypeemoji\">emoji reactions</a> are allowed.</td>",
"rst_description":"*Optional*. List of available reactions allowed in the chat. If omitted, then all `emoji reactions <https://core.telegram.org/bots/api#reactiontypeemoji>`_ are allowed.\n",
"description":"Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background",
"html_description":"<td><em>Optional</em>. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background</td>",
"rst_description":"*Optional*. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background\n",
"description":"Identifier of the accent color for the chat's profile background. See profile accent colors for more details.",
"html_description":"<td><em>Optional</em>. Identifier of the accent color for the chat's profile background. See <a href=\"#profile-accent-colors\">profile accent colors</a> for more details.</td>",
"rst_description":"*Optional*. Identifier of the accent color for the chat's profile background. See `profile accent colors <https://core.telegram.org/bots/api#profile-accent-colors>`_ for more details.\n",
"description":"Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any",
"html_description":"<td><em>Optional</em>. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any</td>",
"rst_description":"*Optional*. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any\n",
"description":"True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user",
"html_description":"<td><em>Optional</em>. <em>True</em>, if privacy settings of the other party in the private chat allows to use <code>tg://user?id=<user_id></code> links only in chats with the user</td>",
"rst_description":"*Optional*. :code:`True`, if privacy settings of the other party in the private chat allows to use :code:`tg://user?id=<user_id>` links only in chats with the user\n",
"description":"True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the privacy settings of the other party restrict sending voice and video note messages in the private chat</td>",
"rst_description":"*Optional*. :code:`True`, if the privacy settings of the other party restrict sending voice and video note messages in the private chat\n",
"description":"True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators",
"html_description":"<td><em>Optional</em>. <em>True</em>, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators</td>",
"rst_description":"*Optional*. :code:`True`, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators\n",
"description":"True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.</td>",
"rst_description":"*Optional*. :code:`True`, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.\n",
"description":"For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds",
"html_description":"<td><em>Optional</em>. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds</td>",
"rst_description":"*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds\n",
"description":"For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions",
"html_description":"<td><em>Optional</em>. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions</td>",
"rst_description":"*Optional*. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions\n",
"description":"True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.</td>",
"rst_description":"*Optional*. :code:`True`, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.\n",
"description":"True, if new chat members will have access to old messages; available only to chat administrators",
"html_description":"<td><em>Optional</em>. <em>True</em>, if new chat members will have access to old messages; available only to chat administrators</td>",
"rst_description":"*Optional*. :code:`True`, if new chat members will have access to old messages; available only to chat administrators\n",
"description":"For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.",
"html_description":"<td><em>Optional</em>. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.</td>",
"rst_description":"*Optional*. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.\n",
"description":"Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td><em>Optional</em>. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"*Optional*. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.\n",
"description":"The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews",
"html_description":"<td><em>Optional</em>. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews</td>",
"rst_description":"*Optional*. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews\n",
"name":"unique_gift_colors",
"required":false
},
{
"type":"Integer",
"description":"The number of Telegram Stars a general user have to pay to send a message to the chat",
"html_description":"<td><em>Optional</em>. The number of Telegram Stars a general user have to pay to send a message to the chat</td>",
"rst_description":"*Optional*. The number of Telegram Stars a general user have to pay to send a message to the chat\n",
"description":"Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent",
"html_description":"<td>Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent</td>",
"rst_description":"Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent\n",
"description":"Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only",
"html_description":"<td><em>Optional</em>. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only</td>",
"rst_description":"*Optional*. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only\n",
"description":"Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats",
"html_description":"<td><em>Optional</em>. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats</td>",
"rst_description":"*Optional*. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats\n",
"description":"Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.",
"html_description":"<td><em>Optional</em>. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field <em>from</em> contains a fake sender user in non-channel chats.</td>",
"rst_description":"*Optional*. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field *from* contains a fake sender user in non-channel chats.\n",
"description":"The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.",
"html_description":"<td><em>Optional</em>. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.</td>",
"rst_description":"*Optional*. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.\n",
"description":"Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.",
"html_description":"<td><em>Optional</em>. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.</td>",
"rst_description":"*Optional*. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.\n",
"description":"True, if the message is sent to a topic in a forum supergroup or a private chat with the bot",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the message is sent to a topic in a forum supergroup or a private chat with the bot</td>",
"rst_description":"*Optional*. :code:`True`, if the message is sent to a topic in a forum supergroup or a private chat with the bot\n",
"description":"True, if the message is a channel post that was automatically forwarded to the connected discussion group",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the message is a channel post that was automatically forwarded to the connected discussion group</td>",
"rst_description":"*Optional*. :code:`True`, if the message is a channel post that was automatically forwarded to the connected discussion group\n",
"description":"For replies in the same chat and message thread, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. For replies in the same chat and message thread, the original message. Note that the <a href=\"#message\">Message</a> object in this field will not contain further <em>reply_to_message</em> fields even if it itself is a reply.</td>",
"rst_description":"*Optional*. For replies in the same chat and message thread, the original message. Note that the :class:`aiogram.types.message.Message` object in this field will not contain further *reply_to_message* fields even if it itself is a reply.\n",
"description":"Information about the message that is being replied to, which may come from another chat or forum topic",
"html_description":"<td><em>Optional</em>. Information about the message that is being replied to, which may come from another chat or forum topic</td>",
"rst_description":"*Optional*. Information about the message that is being replied to, which may come from another chat or forum topic\n",
"name":"external_reply",
"required":false
},
{
"type":"TextQuote",
"description":"For replies that quote part of the original message, the quoted part of the message",
"html_description":"<td><em>Optional</em>. For replies that quote part of the original message, the quoted part of the message</td>",
"rst_description":"*Optional*. For replies that quote part of the original message, the quoted part of the message\n",
"description":"True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message</td>",
"rst_description":"*Optional*. :code:`True`, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message\n",
"description":"True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.</td>",
"rst_description":"*Optional*. :code:`True`, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.\n",
"description":"Signature of the post author for messages in channels, or the custom title of an anonymous group administrator",
"html_description":"<td><em>Optional</em>. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator</td>",
"rst_description":"*Optional*. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator\n",
"description":"Options used for link preview generation for the message, if it is a text message and link preview options were changed",
"html_description":"<td><em>Optional</em>. Options used for link preview generation for the message, if it is a text message and link preview options were changed</td>",
"rst_description":"*Optional*. Options used for link preview generation for the message, if it is a text message and link preview options were changed\n",
"description":"Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.",
"html_description":"<td><em>Optional</em>. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.</td>",
"rst_description":"*Optional*. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.\n",
"description":"Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set",
"html_description":"<td><em>Optional</em>. Message is an animation, information about the animation. For backward compatibility, when this field is set, the <em>document</em> field will also be set</td>",
"rst_description":"*Optional*. Message is an animation, information about the animation. For backward compatibility, when this field is set, the *document* field will also be set\n",
"name":"animation",
"required":false
},
{
"type":"Audio",
"description":"Message is an audio file, information about the file",
"html_description":"<td><em>Optional</em>. Message is an audio file, information about the file</td>",
"rst_description":"*Optional*. Message is an audio file, information about the file\n",
"name":"audio",
"required":false
},
{
"type":"Document",
"description":"Message is a general file, information about the file",
"html_description":"<td><em>Optional</em>. Message is a general file, information about the file</td>",
"rst_description":"*Optional*. Message is a general file, information about the file\n",
"description":"Message is a video, information about the video",
"html_description":"<td><em>Optional</em>. Message is a video, information about the video</td>",
"rst_description":"*Optional*. Message is a video, information about the video\n",
"name":"video",
"required":false
},
{
"type":"VideoNote",
"description":"Message is a video note, information about the video message",
"html_description":"<td><em>Optional</em>. Message is a <a href=\"https://telegram.org/blog/video-messages-and-telescope\">video note</a>, information about the video message</td>",
"rst_description":"*Optional*. Message is a `video note <https://telegram.org/blog/video-messages-and-telescope>`_, information about the video message\n",
"name":"video_note",
"required":false
},
{
"type":"Voice",
"description":"Message is a voice message, information about the file",
"html_description":"<td><em>Optional</em>. Message is a voice message, information about the file</td>",
"rst_description":"*Optional*. Message is a voice message, information about the file\n",
"description":"For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption",
"html_description":"<td><em>Optional</em>. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption</td>",
"rst_description":"*Optional*. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption\n",
"description":"Message is a shared contact, information about the contact",
"html_description":"<td><em>Optional</em>. Message is a shared contact, information about the contact</td>",
"rst_description":"*Optional*. Message is a shared contact, information about the contact\n",
"name":"contact",
"required":false
},
{
"type":"Dice",
"description":"Message is a dice with random value",
"html_description":"<td><em>Optional</em>. Message is a dice with random value</td>",
"rst_description":"*Optional*. Message is a dice with random value\n",
"name":"dice",
"required":false
},
{
"type":"Game",
"description":"Message is a game, information about the game.",
"html_description":"<td><em>Optional</em>. Message is a game, information about the game. <a href=\"#games\">More about games »</a></td>",
"rst_description":"*Optional*. Message is a game, information about the game. `More about games » <https://core.telegram.org/bots/api#games>`_\n",
"name":"game",
"required":false
},
{
"type":"Poll",
"description":"Message is a native poll, information about the poll",
"html_description":"<td><em>Optional</em>. Message is a native poll, information about the poll</td>",
"rst_description":"*Optional*. Message is a native poll, information about the poll\n",
"name":"poll",
"required":false
},
{
"type":"Venue",
"description":"Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set",
"html_description":"<td><em>Optional</em>. Message is a venue, information about the venue. For backward compatibility, when this field is set, the <em>location</em> field will also be set</td>",
"rst_description":"*Optional*. Message is a venue, information about the venue. For backward compatibility, when this field is set, the *location* field will also be set\n",
"name":"venue",
"required":false
},
{
"type":"Location",
"description":"Message is a shared location, information about the location",
"html_description":"<td><em>Optional</em>. Message is a shared location, information about the location</td>",
"rst_description":"*Optional*. Message is a shared location, information about the location\n",
"name":"location",
"required":false
},
{
"type":"Array of User",
"description":"New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)",
"html_description":"<td><em>Optional</em>. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)</td>",
"rst_description":"*Optional*. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)\n",
"name":"new_chat_members",
"required":false
},
{
"type":"User",
"description":"A member was removed from the group, information about them (this member may be the bot itself)",
"html_description":"<td><em>Optional</em>. A member was removed from the group, information about them (this member may be the bot itself)</td>",
"rst_description":"*Optional*. A member was removed from the group, information about them (this member may be the bot itself)\n",
"description":"A chat title was changed to this value",
"html_description":"<td><em>Optional</em>. A chat title was changed to this value</td>",
"rst_description":"*Optional*. A chat title was changed to this value\n",
"name":"new_chat_title",
"required":false
},
{
"type":"Array of PhotoSize",
"description":"A chat photo was change to this value",
"html_description":"<td><em>Optional</em>. A chat photo was change to this value</td>",
"rst_description":"*Optional*. A chat photo was change to this value\n",
"name":"new_chat_photo",
"required":false
},
{
"type":"True",
"description":"Service message: the chat photo was deleted",
"html_description":"<td><em>Optional</em>. Service message: the chat photo was deleted</td>",
"rst_description":"*Optional*. Service message: the chat photo was deleted\n",
"name":"delete_chat_photo",
"required":false
},
{
"type":"True",
"description":"Service message: the group has been created",
"html_description":"<td><em>Optional</em>. Service message: the group has been created</td>",
"rst_description":"*Optional*. Service message: the group has been created\n",
"name":"group_chat_created",
"required":false
},
{
"type":"True",
"description":"Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.",
"html_description":"<td><em>Optional</em>. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.</td>",
"rst_description":"*Optional*. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.\n",
"name":"supergroup_chat_created",
"required":false
},
{
"type":"True",
"description":"Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.",
"html_description":"<td><em>Optional</em>. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.</td>",
"rst_description":"*Optional*. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.\n",
"name":"channel_chat_created",
"required":false
},
{
"type":"MessageAutoDeleteTimerChanged",
"description":"Service message: auto-delete timer settings changed in the chat",
"html_description":"<td><em>Optional</em>. Service message: auto-delete timer settings changed in the chat</td>",
"rst_description":"*Optional*. Service message: auto-delete timer settings changed in the chat\n",
"name":"message_auto_delete_timer_changed",
"required":false
},
{
"type":"Integer",
"description":"The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td><em>Optional</em>. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"*Optional*. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"migrate_to_chat_id",
"required":false
},
{
"type":"Integer",
"description":"The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td><em>Optional</em>. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"*Optional*. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"description":"Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Specified message was pinned. Note that the <a href=\"#message\">Message</a> object in this field will not contain further <em>reply_to_message</em> fields even if it itself is a reply.</td>",
"rst_description":"*Optional*. Specified message was pinned. Note that the :class:`aiogram.types.message.Message` object in this field will not contain further *reply_to_message* fields even if it itself is a reply.\n",
"description":"Message is an invoice for a payment, information about the invoice.",
"html_description":"<td><em>Optional</em>. Message is an invoice for a <a href=\"#payments\">payment</a>, information about the invoice. <a href=\"#payments\">More about payments »</a></td>",
"rst_description":"*Optional*. Message is an invoice for a `payment <https://core.telegram.org/bots/api#payments>`_, information about the invoice. `More about payments » <https://core.telegram.org/bots/api#payments>`_\n",
"name":"invoice",
"required":false
},
{
"type":"SuccessfulPayment",
"description":"Message is a service message about a successful payment, information about the payment.",
"html_description":"<td><em>Optional</em>. Message is a service message about a successful payment, information about the payment. <a href=\"#payments\">More about payments »</a></td>",
"rst_description":"*Optional*. Message is a service message about a successful payment, information about the payment. `More about payments » <https://core.telegram.org/bots/api#payments>`_\n",
"description":"Message is a service message about a refunded payment, information about the payment.",
"html_description":"<td><em>Optional</em>. Message is a service message about a refunded payment, information about the payment. <a href=\"#payments\">More about payments »</a></td>",
"rst_description":"*Optional*. Message is a service message about a refunded payment, information about the payment. `More about payments » <https://core.telegram.org/bots/api#payments>`_\n",
"description":"The domain name of the website on which the user has logged in.",
"html_description":"<td><em>Optional</em>. The domain name of the website on which the user has logged in. <a href=\"/widgets/login\">More about Telegram Login »</a></td>",
"rst_description":"*Optional*. The domain name of the website on which the user has logged in. `More about Telegram Login » <https://core.telegram.org/widgets/login>`_\n",
"description":"Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess",
"html_description":"<td><em>Optional</em>. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description":"*Optional*. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"description":"Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.",
"html_description":"<td><em>Optional</em>. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.</td>",
"rst_description":"*Optional*. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.\n",
"description":"Service message: some tasks in a checklist were marked as done or not done",
"html_description":"<td><em>Optional</em>. Service message: some tasks in a checklist were marked as done or not done</td>",
"rst_description":"*Optional*. Service message: some tasks in a checklist were marked as done or not done\n",
"name":"checklist_tasks_done",
"required":false
},
{
"type":"ChecklistTasksAdded",
"description":"Service message: tasks were added to a checklist",
"html_description":"<td><em>Optional</em>. Service message: tasks were added to a checklist</td>",
"rst_description":"*Optional*. Service message: tasks were added to a checklist\n",
"name":"checklist_tasks_added",
"required":false
},
{
"type":"DirectMessagePriceChanged",
"description":"Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed",
"html_description":"<td><em>Optional</em>. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed</td>",
"rst_description":"*Optional*. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed\n",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message. <code>login_url</code> buttons are represented as ordinary <code>url</code> buttons.</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message. :code:`login_url` buttons are represented as ordinary :code:`url` buttons.\n",
"description":"Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent",
"html_description":"<td>Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent</td>",
"rst_description":"Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent\n",
"description":"This object describes a message that was deleted or is otherwise inaccessible to the bot.",
"html_description":"<p>This object describes a message that was deleted or is otherwise inaccessible to the bot.</p>",
"rst_description":"This object describes a message that was deleted or is otherwise inaccessible to the bot.",
"annotations":[
{
"type":"Chat",
"description":"Chat the message belonged to",
"html_description":"<td>Chat the message belonged to</td>",
"rst_description":"Chat the message belonged to\n",
"name":"chat",
"required":true
},
{
"type":"Integer",
"description":"Unique message identifier inside the chat",
"html_description":"<td>Unique message identifier inside the chat</td>",
"rst_description":"Unique message identifier inside the chat\n",
"name":"message_id",
"required":true
},
{
"type":"Integer",
"description":"Always 0. The field can be used to differentiate regular and inaccessible messages.",
"html_description":"<td>Always 0. The field can be used to differentiate regular and inaccessible messages.</td>",
"rst_description":"Always 0. The field can be used to differentiate regular and inaccessible messages.\n",
"name":"date",
"required":true
}
],
"category":"types"
},
{
"anchor":"maybeinaccessiblemessage",
"name":"MaybeInaccessibleMessage",
"description":"This object describes a message that can be inaccessible to the bot. It can be one of\n - Message\n - InaccessibleMessage",
"html_description":"<p>This object describes a message that can be inaccessible to the bot. It can be one of</p><ul>\n<li><a href=\"#message\">Message</a></li>\n<li><a href=\"#inaccessiblemessage\">InaccessibleMessage</a></li>\n</ul>",
"rst_description":"This object describes a message that can be inaccessible to the bot. It can be one of\n\n - :class:`aiogram.types.message.Message`\n - :class:`aiogram.types.inaccessible_message.InaccessibleMessage`",
"description":"Offset in UTF-16 code units to the start of the entity",
"html_description":"<td>Offset in <a href=\"/api/entities#entity-length\">UTF-16 code units</a> to the start of the entity</td>",
"rst_description":"Offset in `UTF-16 code units <https://core.telegram.org/api/entities#entity-length>`_ to the start of the entity\n",
"name":"offset",
"required":true
},
{
"type":"Integer",
"description":"Length of the entity in UTF-16 code units",
"html_description":"<td>Length of the entity in <a href=\"/api/entities#entity-length\">UTF-16 code units</a></td>",
"rst_description":"Length of the entity in `UTF-16 code units <https://core.telegram.org/api/entities#entity-length>`_\n",
"name":"length",
"required":true
},
{
"type":"String",
"description":"For 'text_link' only, URL that will be opened after user taps on the text",
"html_description":"<td><em>Optional</em>. For “text_link” only, URL that will be opened after user taps on the text</td>",
"rst_description":"*Optional*. For 'text_link' only, URL that will be opened after user taps on the text\n",
"name":"url",
"required":false
},
{
"type":"User",
"description":"For 'text_mention' only, the mentioned user",
"html_description":"<td><em>Optional</em>. For “text_mention” only, the mentioned user</td>",
"rst_description":"*Optional*. For 'text_mention' only, the mentioned user\n",
"name":"user",
"required":false
},
{
"type":"String",
"description":"For 'pre' only, the programming language of the entity text",
"html_description":"<td><em>Optional</em>. For “pre” only, the programming language of the entity text</td>",
"rst_description":"*Optional*. For 'pre' only, the programming language of the entity text\n",
"name":"language",
"required":false
},
{
"type":"String",
"description":"For 'custom_emoji' only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker",
"html_description":"<td><em>Optional</em>. For “custom_emoji” only, unique identifier of the custom emoji. Use <a href=\"#getcustomemojistickers\">getCustomEmojiStickers</a> to get full information about the sticker</td>",
"rst_description":"*Optional*. For 'custom_emoji' only, unique identifier of the custom emoji. Use :class:`aiogram.methods.get_custom_emoji_stickers.GetCustomEmojiStickers` to get full information about the sticker\n",
"description":"For 'date_time' only, the Unix time associated with the entity",
"html_description":"<td><em>Optional</em>. For “date_time” only, the Unix time associated with the entity</td>",
"rst_description":"*Optional*. For 'date_time' only, the Unix time associated with the entity\n",
"name":"unix_time",
"required":false
},
{
"type":"String",
"description":"For 'date_time' only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.",
"html_description":"<td><em>Optional</em>. For “date_time” only, the string that defines the formatting of the date and time. See <a href=\"#date-time-entity-formatting\">date-time entity formatting</a> for more details.</td>",
"rst_description":"*Optional*. For 'date_time' only, the string that defines the formatting of the date and time. See `date-time entity formatting <https://core.telegram.org/bots/api#date-time-entity-formatting>`_ for more details.\n",
"description":"Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes.",
"html_description":"<td><em>Optional</em>. Special entities that appear in the quote. Currently, only <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities are kept in quotes.</td>",
"rst_description":"*Optional*. Special entities that appear in the quote. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities are kept in quotes.\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.</td>",
"rst_description":"*Optional*. :code:`True`, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.\n",
"description":"This object contains information about a message that is being replied to, which may come from another chat or forum topic.",
"html_description":"<p>This object contains information about a message that is being replied to, which may come from another chat or forum topic.</p>",
"rst_description":"This object contains information about a message that is being replied to, which may come from another chat or forum topic.",
"description":"Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.",
"html_description":"<td><em>Optional</em>. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.</td>",
"rst_description":"*Optional*. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.\n",
"description":"Message is a video, information about the video",
"html_description":"<td><em>Optional</em>. Message is a video, information about the video</td>",
"rst_description":"*Optional*. Message is a video, information about the video\n",
"name":"video",
"required":false
},
{
"type":"VideoNote",
"description":"Message is a video note, information about the video message",
"html_description":"<td><em>Optional</em>. Message is a <a href=\"https://telegram.org/blog/video-messages-and-telescope\">video note</a>, information about the video message</td>",
"rst_description":"*Optional*. Message is a `video note <https://telegram.org/blog/video-messages-and-telescope>`_, information about the video message\n",
"name":"video_note",
"required":false
},
{
"type":"Voice",
"description":"Message is a voice message, information about the file",
"html_description":"<td><em>Optional</em>. Message is a voice message, information about the file</td>",
"rst_description":"*Optional*. Message is a voice message, information about the file\n",
"name":"voice",
"required":false
},
{
"type":"True",
"description":"True, if the message media is covered by a spoiler animation",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the message media is covered by a spoiler animation</td>",
"rst_description":"*Optional*. :code:`True`, if the message media is covered by a spoiler animation\n",
"description":"Message is a shared contact, information about the contact",
"html_description":"<td><em>Optional</em>. Message is a shared contact, information about the contact</td>",
"rst_description":"*Optional*. Message is a shared contact, information about the contact\n",
"name":"contact",
"required":false
},
{
"type":"Dice",
"description":"Message is a dice with random value",
"html_description":"<td><em>Optional</em>. Message is a dice with random value</td>",
"rst_description":"*Optional*. Message is a dice with random value\n",
"name":"dice",
"required":false
},
{
"type":"Game",
"description":"Message is a game, information about the game.",
"html_description":"<td><em>Optional</em>. Message is a game, information about the game. <a href=\"#games\">More about games »</a></td>",
"rst_description":"*Optional*. Message is a game, information about the game. `More about games » <https://core.telegram.org/bots/api#games>`_\n",
"name":"game",
"required":false
},
{
"type":"Giveaway",
"description":"Message is a scheduled giveaway, information about the giveaway",
"html_description":"<td><em>Optional</em>. Message is a scheduled giveaway, information about the giveaway</td>",
"rst_description":"*Optional*. Message is a scheduled giveaway, information about the giveaway\n",
"name":"giveaway",
"required":false
},
{
"type":"GiveawayWinners",
"description":"A giveaway with public winners was completed",
"html_description":"<td><em>Optional</em>. A giveaway with public winners was completed</td>",
"rst_description":"*Optional*. A giveaway with public winners was completed\n",
"name":"giveaway_winners",
"required":false
},
{
"type":"Invoice",
"description":"Message is an invoice for a payment, information about the invoice.",
"html_description":"<td><em>Optional</em>. Message is an invoice for a <a href=\"#payments\">payment</a>, information about the invoice. <a href=\"#payments\">More about payments »</a></td>",
"rst_description":"*Optional*. Message is an invoice for a `payment <https://core.telegram.org/bots/api#payments>`_, information about the invoice. `More about payments » <https://core.telegram.org/bots/api#payments>`_\n",
"name":"invoice",
"required":false
},
{
"type":"Location",
"description":"Message is a shared location, information about the location",
"html_description":"<td><em>Optional</em>. Message is a shared location, information about the location</td>",
"rst_description":"*Optional*. Message is a shared location, information about the location\n",
"name":"location",
"required":false
},
{
"type":"Poll",
"description":"Message is a native poll, information about the poll",
"html_description":"<td><em>Optional</em>. Message is a native poll, information about the poll</td>",
"rst_description":"*Optional*. Message is a native poll, information about the poll\n",
"name":"poll",
"required":false
},
{
"type":"Venue",
"description":"Message is a venue, information about the venue",
"html_description":"<td><em>Optional</em>. Message is a venue, information about the venue</td>",
"rst_description":"*Optional*. Message is a venue, information about the venue\n",
"name":"venue",
"required":false
}
],
"category":"types"
},
{
"anchor":"replyparameters",
"name":"ReplyParameters",
"description":"Describes reply parameters for the message that is being sent.",
"html_description":"<p>Describes reply parameters for the message that is being sent.</p>",
"rst_description":"Describes reply parameters for the message that is being sent.",
"annotations":[
{
"type":"Integer",
"description":"Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified",
"html_description":"<td>Identifier of the message that will be replied to in the current chat, or in the chat <em>chat_id</em> if it is specified</td>",
"rst_description":"Identifier of the message that will be replied to in the current chat, or in the chat *chat_id* if it is specified\n",
"description":"If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.",
"html_description":"<td><em>Optional</em>. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format <code>@channelusername</code>). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.</td>",
"rst_description":"*Optional*. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format :code:`@channelusername`). Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.\n",
"description":"Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the message should be sent even if the specified message to be replied to is not found. Always <em>False</em> for replies in another chat or forum topic. Always <em>True</em> for messages sent on behalf of a business account.</td>",
"rst_description":"*Optional*. Pass :code:`True` if the message should be sent even if the specified message to be replied to is not found. Always :code:`False` for replies in another chat or forum topic. Always :code:`True` for messages sent on behalf of a business account.\n",
"description":"Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message.",
"html_description":"<td><em>Optional</em>. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities. The message will fail to send if the quote isn't found in the original message.</td>",
"rst_description":"*Optional*. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities. The message will fail to send if the quote isn't found in the original message.\n",
"name":"quote",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the quote. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the quote. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the quote. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"quote_parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.",
"html_description":"<td><em>Optional</em>. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of <em>quote_parse_mode</em>.</td>",
"rst_description":"*Optional*. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of *quote_parse_mode*.\n",
"name":"quote_entities",
"required":false
},
{
"type":"Integer",
"description":"Position of the quote in the original message in UTF-16 code units",
"html_description":"<td><em>Optional</em>. Position of the quote in the original message in UTF-16 code units</td>",
"rst_description":"*Optional*. Position of the quote in the original message in UTF-16 code units\n",
"description":"This object describes the origin of a message. It can be one of\n - MessageOriginUser\n - MessageOriginHiddenUser\n - MessageOriginChat\n - MessageOriginChannel",
"html_description":"<p>This object describes the origin of a message. It can be one of</p><ul>\n<li><a href=\"#messageoriginuser\">MessageOriginUser</a></li>\n<li><a href=\"#messageoriginhiddenuser\">MessageOriginHiddenUser</a></li>\n<li><a href=\"#messageoriginchat\">MessageOriginChat</a></li>\n<li><a href=\"#messageoriginchannel\">MessageOriginChannel</a></li>\n</ul>",
"rst_description":"This object describes the origin of a message. It can be one of\n\n - :class:`aiogram.types.message_origin_user.MessageOriginUser`\n - :class:`aiogram.types.message_origin_hidden_user.MessageOriginHiddenUser`\n - :class:`aiogram.types.message_origin_chat.MessageOriginChat`\n - :class:`aiogram.types.message_origin_channel.MessageOriginChannel`",
"annotations":[],
"category":"types"
},
{
"anchor":"messageoriginuser",
"name":"MessageOriginUser",
"description":"The message was originally sent by a known user.",
"html_description":"<p>The message was originally sent by a known user.</p>",
"rst_description":"The message was originally sent by a known user.",
"annotations":[
{
"type":"String",
"description":"Type of the message origin, always 'user'",
"html_description":"<td>Type of the message origin, always “user”</td>",
"rst_description":"Type of the message origin, always 'user'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Date the message was sent originally in Unix time",
"html_description":"<td>Date the message was sent originally in Unix time</td>",
"rst_description":"Date the message was sent originally in Unix time\n",
"name":"date",
"required":true
},
{
"type":"User",
"description":"User that sent the message originally",
"html_description":"<td>User that sent the message originally</td>",
"rst_description":"User that sent the message originally\n",
"name":"sender_user",
"required":true
}
],
"category":"types"
},
{
"anchor":"messageoriginhiddenuser",
"name":"MessageOriginHiddenUser",
"description":"The message was originally sent by an unknown user.",
"html_description":"<p>The message was originally sent by an unknown user.</p>",
"rst_description":"The message was originally sent by an unknown user.",
"annotations":[
{
"type":"String",
"description":"Type of the message origin, always 'hidden_user'",
"html_description":"<td>Type of the message origin, always “hidden_user”</td>",
"rst_description":"Type of the message origin, always 'hidden_user'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Date the message was sent originally in Unix time",
"html_description":"<td>Date the message was sent originally in Unix time</td>",
"rst_description":"Date the message was sent originally in Unix time\n",
"name":"date",
"required":true
},
{
"type":"String",
"description":"Name of the user that sent the message originally",
"html_description":"<td>Name of the user that sent the message originally</td>",
"rst_description":"Name of the user that sent the message originally\n",
"name":"sender_user_name",
"required":true
}
],
"category":"types"
},
{
"anchor":"messageoriginchat",
"name":"MessageOriginChat",
"description":"The message was originally sent on behalf of a chat to a group chat.",
"html_description":"<p>The message was originally sent on behalf of a chat to a group chat.</p>",
"rst_description":"The message was originally sent on behalf of a chat to a group chat.",
"annotations":[
{
"type":"String",
"description":"Type of the message origin, always 'chat'",
"html_description":"<td>Type of the message origin, always “chat”</td>",
"rst_description":"Type of the message origin, always 'chat'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Date the message was sent originally in Unix time",
"html_description":"<td>Date the message was sent originally in Unix time</td>",
"rst_description":"Date the message was sent originally in Unix time\n",
"name":"date",
"required":true
},
{
"type":"Chat",
"description":"Chat that sent the message originally",
"html_description":"<td>Chat that sent the message originally</td>",
"rst_description":"Chat that sent the message originally\n",
"name":"sender_chat",
"required":true
},
{
"type":"String",
"description":"For messages originally sent by an anonymous chat administrator, original message author signature",
"html_description":"<td><em>Optional</em>. For messages originally sent by an anonymous chat administrator, original message author signature</td>",
"rst_description":"*Optional*. For messages originally sent by an anonymous chat administrator, original message author signature\n",
"name":"author_signature",
"required":false
}
],
"category":"types"
},
{
"anchor":"messageoriginchannel",
"name":"MessageOriginChannel",
"description":"The message was originally sent to a channel chat.",
"html_description":"<p>The message was originally sent to a channel chat.</p>",
"rst_description":"The message was originally sent to a channel chat.",
"annotations":[
{
"type":"String",
"description":"Type of the message origin, always 'channel'",
"html_description":"<td>Type of the message origin, always “channel”</td>",
"rst_description":"Type of the message origin, always 'channel'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Date the message was sent originally in Unix time",
"html_description":"<td>Date the message was sent originally in Unix time</td>",
"rst_description":"Date the message was sent originally in Unix time\n",
"name":"date",
"required":true
},
{
"type":"Chat",
"description":"Channel chat to which the message was originally sent",
"html_description":"<td>Channel chat to which the message was originally sent</td>",
"rst_description":"Channel chat to which the message was originally sent\n",
"name":"chat",
"required":true
},
{
"type":"Integer",
"description":"Unique message identifier inside the chat",
"html_description":"<td>Unique message identifier inside the chat</td>",
"rst_description":"Unique message identifier inside the chat\n",
"name":"message_id",
"required":true
},
{
"type":"String",
"description":"Signature of the original post author",
"html_description":"<td><em>Optional</em>. Signature of the original post author</td>",
"rst_description":"*Optional*. Signature of the original post author\n",
"name":"author_signature",
"required":false
}
],
"category":"types"
},
{
"anchor":"photosize",
"name":"PhotoSize",
"description":"This object represents one size of a photo or a file / sticker thumbnail.",
"html_description":"<p>This object represents one size of a photo or a <a href=\"#document\">file</a> / <a href=\"#sticker\">sticker</a> thumbnail.</p>",
"rst_description":"This object represents one size of a photo or a `file <https://core.telegram.org/bots/api#document>`_ / :class:`aiogram.methods.sticker.Sticker` thumbnail.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"file_unique_id",
"required":true
},
{
"type":"Integer",
"description":"Photo width",
"html_description":"<td>Photo width</td>",
"rst_description":"Photo width\n",
"name":"width",
"required":true
},
{
"type":"Integer",
"description":"Photo height",
"html_description":"<td>Photo height</td>",
"rst_description":"Photo height\n",
"name":"height",
"required":true
},
{
"type":"Integer",
"description":"File size in bytes",
"html_description":"<td><em>Optional</em>. File size in bytes</td>",
"rst_description":"*Optional*. File size in bytes\n",
"name":"file_size",
"required":false
}
],
"category":"types"
},
{
"anchor":"animation",
"name":"Animation",
"description":"This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"html_description":"<p>This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).</p>",
"rst_description":"This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name":"file_size",
"required":false
}
],
"category":"types"
},
{
"anchor":"audio",
"name":"Audio",
"description":"This object represents an audio file to be treated as music by the Telegram clients.",
"html_description":"<p>This object represents an audio file to be treated as music by the Telegram clients.</p>",
"rst_description":"This object represents an audio file to be treated as music by the Telegram clients.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name":"file_size",
"required":false
},
{
"type":"PhotoSize",
"description":"Thumbnail of the album cover to which the music file belongs",
"html_description":"<td><em>Optional</em>. Thumbnail of the album cover to which the music file belongs</td>",
"rst_description":"*Optional*. Thumbnail of the album cover to which the music file belongs\n",
"description":"This object represents a general file (as opposed to photos, voice messages and audio files).",
"html_description":"<p>This object represents a general file (as opposed to <a href=\"#photosize\">photos</a>, <a href=\"#voice\">voice messages</a> and <a href=\"#audio\">audio files</a>).</p>",
"rst_description":"This object represents a general file (as opposed to `photos <https://core.telegram.org/bots/api#photosize>`_, `voice messages <https://core.telegram.org/bots/api#voice>`_ and `audio files <https://core.telegram.org/bots/api#audio>`_).",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"description":"This object represents a video file of a specific quality.",
"html_description":"<p>This object represents a video file of a specific quality.</p>",
"rst_description":"This object represents a video file of a specific quality.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"file_unique_id",
"required":true
},
{
"type":"Integer",
"description":"Video width",
"html_description":"<td>Video width</td>",
"rst_description":"Video width\n",
"name":"width",
"required":true
},
{
"type":"Integer",
"description":"Video height",
"html_description":"<td>Video height</td>",
"rst_description":"Video height\n",
"name":"height",
"required":true
},
{
"type":"String",
"description":"Codec that was used to encode the video, for example, 'h264', 'h265', or 'av01'",
"html_description":"<td>Codec that was used to encode the video, for example, “h264”, “h265”, or “av01”</td>",
"rst_description":"Codec that was used to encode the video, for example, 'h264', 'h265', or 'av01'\n",
"name":"codec",
"required":true
},
{
"type":"Integer",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"description":"This object represents a video file.",
"html_description":"<p>This object represents a video file.</p>",
"rst_description":"This object represents a video file.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name":"file_size",
"required":false
}
],
"category":"types"
},
{
"anchor":"videonote",
"name":"VideoNote",
"description":"This object represents a video message (available in Telegram apps as of v.4.0).",
"html_description":"<p>This object represents a <a href=\"https://telegram.org/blog/video-messages-and-telescope\">video message</a> (available in Telegram apps as of <a href=\"https://telegram.org/blog/video-messages-and-telescope\">v.4.0</a>).</p>",
"rst_description":"This object represents a `video message <https://telegram.org/blog/video-messages-and-telescope>`_ (available in Telegram apps as of `v.4.0 <https://telegram.org/blog/video-messages-and-telescope>`_).",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"html_description":"<td><em>Optional</em>. File size in bytes</td>",
"rst_description":"*Optional*. File size in bytes\n",
"name":"file_size",
"required":false
}
],
"category":"types"
},
{
"anchor":"voice",
"name":"Voice",
"description":"This object represents a voice note.",
"html_description":"<p>This object represents a voice note.</p>",
"rst_description":"This object represents a voice note.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"description":"Describes the paid media added to a message.",
"html_description":"<p>Describes the paid media added to a message.</p>",
"rst_description":"Describes the paid media added to a message.",
"annotations":[
{
"type":"Integer",
"description":"The number of Telegram Stars that must be paid to buy access to the media",
"html_description":"<td>The number of Telegram Stars that must be paid to buy access to the media</td>",
"rst_description":"The number of Telegram Stars that must be paid to buy access to the media\n",
"name":"star_count",
"required":true
},
{
"type":"Array of PaidMedia",
"description":"Information about the paid media",
"html_description":"<td>Information about the paid media</td>",
"rst_description":"Information about the paid media\n",
"name":"paid_media",
"required":true
}
],
"category":"types"
},
{
"anchor":"paidmedia",
"name":"PaidMedia",
"description":"This object describes paid media. Currently, it can be one of\n - PaidMediaPreview\n - PaidMediaPhoto\n - PaidMediaVideo",
"html_description":"<p>This object describes paid media. Currently, it can be one of</p><ul>\n<li><a href=\"#paidmediapreview\">PaidMediaPreview</a></li>\n<li><a href=\"#paidmediaphoto\">PaidMediaPhoto</a></li>\n<li><a href=\"#paidmediavideo\">PaidMediaVideo</a></li>\n</ul>",
"rst_description":"This object describes paid media. Currently, it can be one of\n\n - :class:`aiogram.types.paid_media_preview.PaidMediaPreview`\n - :class:`aiogram.types.paid_media_photo.PaidMediaPhoto`\n - :class:`aiogram.types.paid_media_video.PaidMediaVideo`",
"annotations":[],
"category":"types"
},
{
"anchor":"paidmediapreview",
"name":"PaidMediaPreview",
"description":"The paid media isn't available before the payment.",
"html_description":"<p>The paid media isn't available before the payment.</p>",
"rst_description":"The paid media isn't available before the payment.",
"annotations":[
{
"type":"String",
"description":"Type of the paid media, always 'preview'",
"html_description":"<td>Type of the paid media, always “preview”</td>",
"rst_description":"Type of the paid media, always 'preview'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Media width as defined by the sender",
"html_description":"<td><em>Optional</em>. Media width as defined by the sender</td>",
"rst_description":"*Optional*. Media width as defined by the sender\n",
"name":"width",
"required":false
},
{
"type":"Integer",
"description":"Media height as defined by the sender",
"html_description":"<td><em>Optional</em>. Media height as defined by the sender</td>",
"rst_description":"*Optional*. Media height as defined by the sender\n",
"name":"height",
"required":false
},
{
"type":"Integer",
"description":"Duration of the media in seconds as defined by the sender",
"html_description":"<td><em>Optional</em>. Duration of the media in seconds as defined by the sender</td>",
"rst_description":"*Optional*. Duration of the media in seconds as defined by the sender\n",
"name":"duration",
"required":false
}
],
"category":"types"
},
{
"anchor":"paidmediaphoto",
"name":"PaidMediaPhoto",
"description":"The paid media is a photo.",
"html_description":"<p>The paid media is a photo.</p>",
"rst_description":"The paid media is a photo.",
"annotations":[
{
"type":"String",
"description":"Type of the paid media, always 'photo'",
"html_description":"<td>Type of the paid media, always “photo”</td>",
"rst_description":"Type of the paid media, always 'photo'\n",
"name":"type",
"required":true
},
{
"type":"Array of PhotoSize",
"description":"The photo",
"html_description":"<td>The photo</td>",
"rst_description":"The photo\n",
"name":"photo",
"required":true
}
],
"category":"types"
},
{
"anchor":"paidmediavideo",
"name":"PaidMediaVideo",
"description":"The paid media is a video.",
"html_description":"<p>The paid media is a video.</p>",
"rst_description":"The paid media is a video.",
"annotations":[
{
"type":"String",
"description":"Type of the paid media, always 'video'",
"html_description":"<td>Type of the paid media, always “video”</td>",
"rst_description":"Type of the paid media, always 'video'\n",
"html_description":"<td>Contact's first name</td>",
"rst_description":"Contact's first name\n",
"name":"first_name",
"required":true
},
{
"type":"String",
"description":"Contact's last name",
"html_description":"<td><em>Optional</em>. Contact's last name</td>",
"rst_description":"*Optional*. Contact's last name\n",
"name":"last_name",
"required":false
},
{
"type":"Integer",
"description":"Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td><em>Optional</em>. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"*Optional*. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"user_id",
"required":false
},
{
"type":"String",
"description":"Additional data about the contact in the form of a vCard",
"html_description":"<td><em>Optional</em>. Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a></td>",
"rst_description":"*Optional*. Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_\n",
"name":"vcard",
"required":false
}
],
"category":"types"
},
{
"anchor":"dice",
"name":"Dice",
"description":"This object represents an animated emoji that displays a random value.",
"html_description":"<p>This object represents an animated emoji that displays a random value.</p>",
"rst_description":"This object represents an animated emoji that displays a random value.",
"annotations":[
{
"type":"String",
"description":"Emoji on which the dice throw animation is based",
"html_description":"<td>Emoji on which the dice throw animation is based</td>",
"rst_description":"Emoji on which the dice throw animation is based\n",
"name":"emoji",
"required":true
},
{
"type":"Integer",
"description":"Value of the dice, 1-6 for '', '' and '' base emoji, 1-5 for '' and '' base emoji, 1-64 for '' base emoji",
"html_description":"<td>Value of the dice, 1-6 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"🎲\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"🎯\"/>” and “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"🎳\"/>” base emoji, 1-5 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"🏀\"/>” and “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"⚽\"/>” base emoji, 1-64 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"🎰\"/>” base emoji</td>",
"rst_description":"Value of the dice, 1-6 for '🎲', '🎯' and '🎳' base emoji, 1-5 for '🏀' and '⚽' base emoji, 1-64 for '🎰' base emoji\n",
"name":"value",
"required":true
}
],
"category":"types"
},
{
"anchor":"polloption",
"name":"PollOption",
"description":"This object contains information about one answer option in a poll.",
"html_description":"<p>This object contains information about one answer option in a poll.</p>",
"rst_description":"This object contains information about one answer option in a poll.",
"description":"Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts",
"html_description":"<td><em>Optional</em>. Special entities that appear in the option <em>text</em>. Currently, only custom emoji entities are allowed in poll option texts</td>",
"rst_description":"*Optional*. Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts\n",
"description":"Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Currently, only custom emoji entities are allowed</td>",
"rst_description":"*Optional*. Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed\n",
"name":"text_parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode",
"html_description":"<td><em>Optional</em>. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of <em>text_parse_mode</em></td>",
"rst_description":"*Optional*. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of *text_parse_mode*\n",
"description":"Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions",
"html_description":"<td><em>Optional</em>. Special entities that appear in the <em>question</em>. Currently, only custom emoji entities are allowed in poll questions</td>",
"rst_description":"*Optional*. Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions\n",
"html_description":"<td>List of poll options</td>",
"rst_description":"List of poll options\n",
"name":"options",
"required":true
},
{
"type":"Integer",
"description":"Total number of users that voted in the poll",
"html_description":"<td>Total number of users that voted in the poll</td>",
"rst_description":"Total number of users that voted in the poll\n",
"name":"total_voter_count",
"required":true
},
{
"type":"Boolean",
"description":"True, if the poll is closed",
"html_description":"<td><em>True</em>, if the poll is closed</td>",
"rst_description":":code:`True`, if the poll is closed\n",
"name":"is_closed",
"required":true
},
{
"type":"Boolean",
"description":"True, if the poll is anonymous",
"html_description":"<td><em>True</em>, if the poll is anonymous</td>",
"rst_description":":code:`True`, if the poll is anonymous\n",
"name":"is_anonymous",
"required":true
},
{
"type":"String",
"description":"Poll type, currently can be 'regular' or 'quiz'",
"html_description":"<td>Poll type, currently can be “regular” or “quiz”</td>",
"rst_description":"Poll type, currently can be 'regular' or 'quiz'\n",
"name":"type",
"required":true
},
{
"type":"Boolean",
"description":"True, if the poll allows multiple answers",
"html_description":"<td><em>True</em>, if the poll allows multiple answers</td>",
"rst_description":":code:`True`, if the poll allows multiple answers\n",
"name":"allows_multiple_answers",
"required":true
},
{
"type":"Integer",
"description":"0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.",
"html_description":"<td><em>Optional</em>. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.</td>",
"rst_description":"*Optional*. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.\n",
"name":"correct_option_id",
"required":false
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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</td>",
"rst_description":"*Optional*. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters\n",
"name":"explanation",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"Special entities like usernames, URLs, bot commands, etc. that appear in the explanation",
"html_description":"<td><em>Optional</em>. Special entities like usernames, URLs, bot commands, etc. that appear in the <em>explanation</em></td>",
"rst_description":"*Optional*. Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation*\n",
"name":"explanation_entities",
"required":false
},
{
"type":"Integer",
"description":"Amount of time in seconds the poll will be active after creation",
"html_description":"<td><em>Optional</em>. Amount of time in seconds the poll will be active after creation</td>",
"rst_description":"*Optional*. Amount of time in seconds the poll will be active after creation\n",
"name":"open_period",
"required":false
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when the poll will be automatically closed",
"html_description":"<td><em>Optional</em>. Point in time (Unix timestamp) when the poll will be automatically closed</td>",
"rst_description":"*Optional*. Point in time (Unix timestamp) when the poll will be automatically closed\n",
"description":"Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed",
"html_description":"<td><em>Optional</em>. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed</td>",
"rst_description":"*Optional*. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed\n",
"name":"completion_date",
"required":false
}
],
"category":"types"
},
{
"anchor":"checklist",
"name":"Checklist",
"description":"Describes a checklist.",
"html_description":"<p>Describes a checklist.</p>",
"rst_description":"Describes a checklist.",
"annotations":[
{
"type":"String",
"description":"Title of the checklist",
"html_description":"<td>Title of the checklist</td>",
"rst_description":"Title of the checklist\n",
"name":"title",
"required":true
},
{
"type":"Array of MessageEntity",
"description":"Special entities that appear in the checklist title",
"html_description":"<td><em>Optional</em>. Special entities that appear in the checklist title</td>",
"rst_description":"*Optional*. Special entities that appear in the checklist title\n",
"name":"title_entities",
"required":false
},
{
"type":"Array of ChecklistTask",
"description":"List of tasks in the checklist",
"html_description":"<td>List of tasks in the checklist</td>",
"rst_description":"List of tasks in the checklist\n",
"name":"tasks",
"required":true
},
{
"type":"True",
"description":"True, if users other than the creator of the list can add tasks to the list",
"html_description":"<td><em>Optional</em>. <em>True</em>, if users other than the creator of the list can add tasks to the list</td>",
"rst_description":"*Optional*. :code:`True`, if users other than the creator of the list can add tasks to the list\n",
"name":"others_can_add_tasks",
"required":false
},
{
"type":"True",
"description":"True, if users other than the creator of the list can mark tasks as done or not done",
"html_description":"<td><em>Optional</em>. <em>True</em>, if users other than the creator of the list can mark tasks as done or not done</td>",
"rst_description":"*Optional*. :code:`True`, if users other than the creator of the list can mark tasks as done or not done\n",
"name":"others_can_mark_tasks_as_done",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputchecklisttask",
"name":"InputChecklistTask",
"description":"Describes a task to add to a checklist.",
"html_description":"<p>Describes a task to add to a checklist.</p>",
"rst_description":"Describes a task to add to a checklist.",
"annotations":[
{
"type":"Integer",
"description":"Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist",
"html_description":"<td>Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist</td>",
"rst_description":"Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Text of the task; 1-100 characters after entities parsing",
"html_description":"<td>Text of the task; 1-100 characters after entities parsing</td>",
"rst_description":"Text of the task; 1-100 characters after entities parsing\n",
"name":"text",
"required":true
},
{
"type":"String",
"description":"Mode for parsing entities in the text. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the text. See <a href=\"https://core.telegram.org/bots/api#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities are allowed.</td>",
"rst_description":"*Optional*. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities are allowed.\n",
"name":"text_entities",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputchecklist",
"name":"InputChecklist",
"description":"Describes a checklist to create.",
"html_description":"<p>Describes a checklist to create.</p>",
"rst_description":"Describes a checklist to create.",
"annotations":[
{
"type":"String",
"description":"Title of the checklist; 1-255 characters after entities parsing",
"html_description":"<td>Title of the checklist; 1-255 characters after entities parsing</td>",
"rst_description":"Title of the checklist; 1-255 characters after entities parsing\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Mode for parsing entities in the title. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the title. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the title. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only <em>bold</em>, <em>italic</em>, <em>underline</em>, <em>strikethrough</em>, <em>spoiler</em>, and <em>custom_emoji</em> entities are allowed.</td>",
"rst_description":"*Optional*. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only *bold*, *italic*, *underline*, *strikethrough*, *spoiler*, and *custom_emoji* entities are allowed.\n",
"name":"title_entities",
"required":false
},
{
"type":"Array of InputChecklistTask",
"description":"List of 1-30 tasks in the checklist",
"html_description":"<td>List of 1-30 tasks in the checklist</td>",
"rst_description":"List of 1-30 tasks in the checklist\n",
"name":"tasks",
"required":true
},
{
"type":"Boolean",
"description":"Pass True if other users can add tasks to the checklist",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if other users can add tasks to the checklist</td>",
"rst_description":"*Optional*. Pass :code:`True` if other users can add tasks to the checklist\n",
"description":"Pass True if other users can mark tasks as done or not done in the checklist",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if other users can mark tasks as done or not done in the checklist</td>",
"rst_description":"*Optional*. Pass :code:`True` if other users can mark tasks as done or not done in the checklist\n",
"name":"others_can_mark_tasks_as_done",
"required":false
}
],
"category":"types"
},
{
"anchor":"checklisttasksdone",
"name":"ChecklistTasksDone",
"description":"Describes a service message about checklist tasks marked as done or not done.",
"html_description":"<p>Describes a service message about checklist tasks marked as done or not done.</p>",
"rst_description":"Describes a service message about checklist tasks marked as done or not done.",
"annotations":[
{
"type":"Message",
"description":"Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the checklist whose tasks were marked as done or not done. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the checklist whose tasks were marked as done or not done. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"description":"Identifiers of the tasks that were marked as done",
"html_description":"<td><em>Optional</em>. Identifiers of the tasks that were marked as done</td>",
"rst_description":"*Optional*. Identifiers of the tasks that were marked as done\n",
"name":"marked_as_done_task_ids",
"required":false
},
{
"type":"Array of Integer",
"description":"Identifiers of the tasks that were marked as not done",
"html_description":"<td><em>Optional</em>. Identifiers of the tasks that were marked as not done</td>",
"rst_description":"*Optional*. Identifiers of the tasks that were marked as not done\n",
"name":"marked_as_not_done_task_ids",
"required":false
}
],
"category":"types"
},
{
"anchor":"checklisttasksadded",
"name":"ChecklistTasksAdded",
"description":"Describes a service message about tasks added to a checklist.",
"html_description":"<p>Describes a service message about tasks added to a checklist.</p>",
"rst_description":"Describes a service message about tasks added to a checklist.",
"annotations":[
{
"type":"Message",
"description":"Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the checklist to which the tasks were added. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the checklist to which the tasks were added. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"description":"The radius of uncertainty for the location, measured in meters; 0-1500",
"html_description":"<td><em>Optional</em>. The radius of uncertainty for the location, measured in meters; 0-1500</td>",
"rst_description":"*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500\n",
"name":"horizontal_accuracy",
"required":false
},
{
"type":"Integer",
"description":"Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.",
"html_description":"<td><em>Optional</em>. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.</td>",
"rst_description":"*Optional*. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.\n",
"name":"live_period",
"required":false
},
{
"type":"Integer",
"description":"The direction in which user is moving, in degrees; 1-360. For active live locations only.",
"html_description":"<td><em>Optional</em>. The direction in which user is moving, in degrees; 1-360. For active live locations only.</td>",
"rst_description":"*Optional*. The direction in which user is moving, in degrees; 1-360. For active live locations only.\n",
"name":"heading",
"required":false
},
{
"type":"Integer",
"description":"The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.",
"html_description":"<td><em>Optional</em>. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.</td>",
"rst_description":"*Optional*. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.\n",
"name":"proximity_alert_radius",
"required":false
}
],
"category":"types"
},
{
"anchor":"venue",
"name":"Venue",
"description":"This object represents a venue.",
"html_description":"<p>This object represents a venue.</p>",
"rst_description":"This object represents a venue.",
"annotations":[
{
"type":"Location",
"description":"Venue location. Can't be a live location",
"html_description":"<td>Venue location. Can't be a live location</td>",
"rst_description":"Venue location. Can't be a live location\n",
"name":"location",
"required":true
},
{
"type":"String",
"description":"Name of the venue",
"html_description":"<td>Name of the venue</td>",
"rst_description":"Name of the venue\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Address of the venue",
"html_description":"<td>Address of the venue</td>",
"rst_description":"Address of the venue\n",
"name":"address",
"required":true
},
{
"type":"String",
"description":"Foursquare identifier of the venue",
"html_description":"<td><em>Optional</em>. Foursquare identifier of the venue</td>",
"rst_description":"*Optional*. Foursquare identifier of the venue\n",
"name":"foursquare_id",
"required":false
},
{
"type":"String",
"description":"Foursquare type of the venue. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)",
"html_description":"<td><em>Optional</em>. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)</td>",
"rst_description":"*Optional*. Foursquare type of the venue. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)\n",
"name":"foursquare_type",
"required":false
},
{
"type":"String",
"description":"Google Places identifier of the venue",
"html_description":"<td><em>Optional</em>. Google Places identifier of the venue</td>",
"rst_description":"*Optional*. Google Places identifier of the venue\n",
"name":"google_place_id",
"required":false
},
{
"type":"String",
"description":"Google Places type of the venue. (See supported types.)",
"html_description":"<td><em>Optional</em>. Google Places type of the venue. (See <a href=\"https://developers.google.com/places/web-service/supported_types\">supported types</a>.)</td>",
"rst_description":"*Optional*. Google Places type of the venue. (See `supported types <https://developers.google.com/places/web-service/supported_types>`_.)\n",
"name":"google_place_type",
"required":false
}
],
"category":"types"
},
{
"anchor":"webappdata",
"name":"WebAppData",
"description":"Describes data sent from a Web App to the bot.",
"html_description":"<p>Describes data sent from a <a href=\"/bots/webapps\">Web App</a> to the bot.</p>",
"rst_description":"Describes data sent from a `Web App <https://core.telegram.org/bots/webapps>`_ to the bot.",
"annotations":[
{
"type":"String",
"description":"The data. Be aware that a bad client can send arbitrary data in this field.",
"html_description":"<td>The data. Be aware that a bad client can send arbitrary data in this field.</td>",
"rst_description":"The data. Be aware that a bad client can send arbitrary data in this field.\n",
"name":"data",
"required":true
},
{
"type":"String",
"description":"Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.",
"html_description":"<td>Text of the <em>web_app</em> keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.</td>",
"rst_description":"Text of the *web_app* keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.\n",
"name":"button_text",
"required":true
}
],
"category":"types"
},
{
"anchor":"proximityalerttriggered",
"name":"ProximityAlertTriggered",
"description":"This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.",
"html_description":"<p>This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.</p>",
"rst_description":"This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.",
"annotations":[
{
"type":"User",
"description":"User that triggered the alert",
"html_description":"<td>User that triggered the alert</td>",
"rst_description":"User that triggered the alert\n",
"name":"traveler",
"required":true
},
{
"type":"User",
"description":"User that set the alert",
"html_description":"<td>User that set the alert</td>",
"rst_description":"User that set the alert\n",
"name":"watcher",
"required":true
},
{
"type":"Integer",
"description":"The distance between the users",
"html_description":"<td>The distance between the users</td>",
"rst_description":"The distance between the users\n",
"name":"distance",
"required":true
}
],
"category":"types"
},
{
"anchor":"messageautodeletetimerchanged",
"name":"MessageAutoDeleteTimerChanged",
"description":"This object represents a service message about a change in auto-delete timer settings.",
"html_description":"<p>This object represents a service message about a change in auto-delete timer settings.</p>",
"rst_description":"This object represents a service message about a change in auto-delete timer settings.",
"annotations":[
{
"type":"Integer",
"description":"New auto-delete time for messages in the chat; in seconds",
"html_description":"<td>New auto-delete time for messages in the chat; in seconds</td>",
"rst_description":"New auto-delete time for messages in the chat; in seconds\n",
"description":"This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n - BackgroundFillSolid\n - BackgroundFillGradient\n - BackgroundFillFreeformGradient",
"html_description":"<p>This object describes the way a background is filled based on the selected colors. Currently, it can be one of</p><ul>\n<li><a href=\"#backgroundfillsolid\">BackgroundFillSolid</a></li>\n<li><a href=\"#backgroundfillgradient\">BackgroundFillGradient</a></li>\n<li><a href=\"#backgroundfillfreeformgradient\">BackgroundFillFreeformGradient</a></li>\n</ul>",
"rst_description":"This object describes the way a background is filled based on the selected colors. Currently, it can be one of\n\n - :class:`aiogram.types.background_fill_solid.BackgroundFillSolid`\n - :class:`aiogram.types.background_fill_gradient.BackgroundFillGradient`\n - :class:`aiogram.types.background_fill_freeform_gradient.BackgroundFillFreeformGradient`",
"annotations":[],
"category":"types"
},
{
"anchor":"backgroundfillsolid",
"name":"BackgroundFillSolid",
"description":"The background is filled using the selected color.",
"html_description":"<p>The background is filled using the selected color.</p>",
"rst_description":"The background is filled using the selected color.",
"annotations":[
{
"type":"String",
"description":"Type of the background fill, always 'solid'",
"html_description":"<td>Type of the background fill, always “solid”</td>",
"rst_description":"Type of the background fill, always 'solid'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"The color of the background fill in the RGB24 format",
"html_description":"<td>The color of the background fill in the RGB24 format</td>",
"rst_description":"The color of the background fill in the RGB24 format\n",
"name":"color",
"required":true
}
],
"category":"types"
},
{
"anchor":"backgroundfillgradient",
"name":"BackgroundFillGradient",
"description":"The background is a gradient fill.",
"html_description":"<p>The background is a gradient fill.</p>",
"rst_description":"The background is a gradient fill.",
"annotations":[
{
"type":"String",
"description":"Type of the background fill, always 'gradient'",
"html_description":"<td>Type of the background fill, always “gradient”</td>",
"rst_description":"Type of the background fill, always 'gradient'\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Top color of the gradient in the RGB24 format",
"html_description":"<td>Top color of the gradient in the RGB24 format</td>",
"rst_description":"Top color of the gradient in the RGB24 format\n",
"name":"top_color",
"required":true
},
{
"type":"Integer",
"description":"Bottom color of the gradient in the RGB24 format",
"html_description":"<td>Bottom color of the gradient in the RGB24 format</td>",
"rst_description":"Bottom color of the gradient in the RGB24 format\n",
"name":"bottom_color",
"required":true
},
{
"type":"Integer",
"description":"Clockwise rotation angle of the background fill in degrees; 0-359",
"html_description":"<td>Clockwise rotation angle of the background fill in degrees; 0-359</td>",
"rst_description":"Clockwise rotation angle of the background fill in degrees; 0-359\n",
"name":"rotation_angle",
"required":true
}
],
"category":"types"
},
{
"anchor":"backgroundfillfreeformgradient",
"name":"BackgroundFillFreeformGradient",
"description":"The background is a freeform gradient that rotates after every message in the chat.",
"html_description":"<p>The background is a freeform gradient that rotates after every message in the chat.</p>",
"rst_description":"The background is a freeform gradient that rotates after every message in the chat.",
"annotations":[
{
"type":"String",
"description":"Type of the background fill, always 'freeform_gradient'",
"html_description":"<td>Type of the background fill, always “freeform_gradient”</td>",
"rst_description":"Type of the background fill, always 'freeform_gradient'\n",
"name":"type",
"required":true
},
{
"type":"Array of Integer",
"description":"A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format",
"html_description":"<td>A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format</td>",
"rst_description":"A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format\n",
"name":"colors",
"required":true
}
],
"category":"types"
},
{
"anchor":"backgroundtype",
"name":"BackgroundType",
"description":"This object describes the type of a background. Currently, it can be one of\n - BackgroundTypeFill\n - BackgroundTypeWallpaper\n - BackgroundTypePattern\n - BackgroundTypeChatTheme",
"html_description":"<p>This object describes the type of a background. Currently, it can be one of</p><ul>\n<li><a href=\"#backgroundtypefill\">BackgroundTypeFill</a></li>\n<li><a href=\"#backgroundtypewallpaper\">BackgroundTypeWallpaper</a></li>\n<li><a href=\"#backgroundtypepattern\">BackgroundTypePattern</a></li>\n<li><a href=\"#backgroundtypechattheme\">BackgroundTypeChatTheme</a></li>\n</ul>",
"rst_description":"This object describes the type of a background. Currently, it can be one of\n\n - :class:`aiogram.types.background_type_fill.BackgroundTypeFill`\n - :class:`aiogram.types.background_type_wallpaper.BackgroundTypeWallpaper`\n - :class:`aiogram.types.background_type_pattern.BackgroundTypePattern`\n - :class:`aiogram.types.background_type_chat_theme.BackgroundTypeChatTheme`",
"annotations":[],
"category":"types"
},
{
"anchor":"backgroundtypefill",
"name":"BackgroundTypeFill",
"description":"The background is automatically filled based on the selected colors.",
"html_description":"<p>The background is automatically filled based on the selected colors.</p>",
"rst_description":"The background is automatically filled based on the selected colors.",
"annotations":[
{
"type":"String",
"description":"Type of the background, always 'fill'",
"html_description":"<td>Type of the background, always “fill”</td>",
"rst_description":"Type of the background, always 'fill'\n",
"description":"Dimming of the background in dark themes, as a percentage; 0-100",
"html_description":"<td>Dimming of the background in dark themes, as a percentage; 0-100</td>",
"rst_description":"Dimming of the background in dark themes, as a percentage; 0-100\n",
"name":"dark_theme_dimming",
"required":true
}
],
"category":"types"
},
{
"anchor":"backgroundtypewallpaper",
"name":"BackgroundTypeWallpaper",
"description":"The background is a wallpaper in the JPEG format.",
"html_description":"<p>The background is a wallpaper in the JPEG format.</p>",
"rst_description":"The background is a wallpaper in the JPEG format.",
"annotations":[
{
"type":"String",
"description":"Type of the background, always 'wallpaper'",
"html_description":"<td>Type of the background, always “wallpaper”</td>",
"rst_description":"Type of the background, always 'wallpaper'\n",
"name":"type",
"required":true
},
{
"type":"Document",
"description":"Document with the wallpaper",
"html_description":"<td>Document with the wallpaper</td>",
"rst_description":"Document with the wallpaper\n",
"name":"document",
"required":true
},
{
"type":"Integer",
"description":"Dimming of the background in dark themes, as a percentage; 0-100",
"html_description":"<td>Dimming of the background in dark themes, as a percentage; 0-100</td>",
"rst_description":"Dimming of the background in dark themes, as a percentage; 0-100\n",
"name":"dark_theme_dimming",
"required":true
},
{
"type":"True",
"description":"True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12</td>",
"rst_description":"*Optional*. :code:`True`, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12\n",
"name":"is_blurred",
"required":false
},
{
"type":"True",
"description":"True, if the background moves slightly when the device is tilted",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the background moves slightly when the device is tilted</td>",
"rst_description":"*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
"description":"The background is a .PNG or .TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
"html_description":"<p>The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.</p>",
"rst_description":"The background is a .PNG or .TGV (gzipped subset of SVG with MIME type 'application/x-tgwallpattern') pattern to be combined with the background fill chosen by the user.",
"description":"Type of the background, always 'pattern'",
"html_description":"<td>Type of the background, always “pattern”</td>",
"rst_description":"Type of the background, always 'pattern'\n",
"name":"type",
"required":true
},
{
"type":"Document",
"description":"Document with the pattern",
"html_description":"<td>Document with the pattern</td>",
"rst_description":"Document with the pattern\n",
"name":"document",
"required":true
},
{
"type":"BackgroundFill",
"description":"The background fill that is combined with the pattern",
"html_description":"<td>The background fill that is combined with the pattern</td>",
"rst_description":"The background fill that is combined with the pattern\n",
"name":"fill",
"required":true
},
{
"type":"Integer",
"description":"Intensity of the pattern when it is shown above the filled background; 0-100",
"html_description":"<td>Intensity of the pattern when it is shown above the filled background; 0-100</td>",
"rst_description":"Intensity of the pattern when it is shown above the filled background; 0-100\n",
"name":"intensity",
"required":true
},
{
"type":"True",
"description":"True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only</td>",
"rst_description":"*Optional*. :code:`True`, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only\n",
"name":"is_inverted",
"required":false
},
{
"type":"True",
"description":"True, if the background moves slightly when the device is tilted",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the background moves slightly when the device is tilted</td>",
"rst_description":"*Optional*. :code:`True`, if the background moves slightly when the device is tilted\n",
"name":"is_moving",
"required":false
}
],
"category":"types"
},
{
"anchor":"backgroundtypechattheme",
"name":"BackgroundTypeChatTheme",
"description":"The background is taken directly from a built-in chat theme.",
"html_description":"<p>The background is taken directly from a built-in chat theme.</p>",
"rst_description":"The background is taken directly from a built-in chat theme.",
"annotations":[
{
"type":"String",
"description":"Type of the background, always 'chat_theme'",
"html_description":"<td>Type of the background, always “chat_theme”</td>",
"rst_description":"Type of the background, always 'chat_theme'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Name of the chat theme, which is usually an emoji",
"html_description":"<td>Name of the chat theme, which is usually an emoji</td>",
"rst_description":"Name of the chat theme, which is usually an emoji\n",
"name":"theme_name",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatbackground",
"name":"ChatBackground",
"description":"This object represents a chat background.",
"html_description":"<p>This object represents a chat background.</p>",
"rst_description":"This object represents a chat background.",
"annotations":[
{
"type":"BackgroundType",
"description":"Type of the background",
"html_description":"<td>Type of the background</td>",
"description":"True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot</td>",
"rst_description":"*Optional*. :code:`True`, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot\n",
"description":"This object represents a service message about an edited forum topic.",
"html_description":"<p>This object represents a service message about an edited forum topic.</p>",
"rst_description":"This object represents a service message about an edited forum topic.",
"annotations":[
{
"type":"String",
"description":"New name of the topic, if it was edited",
"html_description":"<td><em>Optional</em>. New name of the topic, if it was edited</td>",
"rst_description":"*Optional*. New name of the topic, if it was edited\n",
"name":"name",
"required":false
},
{
"type":"String",
"description":"New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed",
"html_description":"<td><em>Optional</em>. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed</td>",
"rst_description":"*Optional*. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed\n",
"description":"This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.",
"html_description":"<p>This object contains information about a user that was shared with the bot using a <a href=\"#keyboardbuttonrequestusers\">KeyboardButtonRequestUsers</a> button.</p>",
"rst_description":"This object contains information about a user that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_users.KeyboardButtonRequestUsers` button.",
"description":"Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.",
"html_description":"<td>Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.</td>",
"rst_description":"Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.\n",
"name":"user_id",
"required":true
},
{
"type":"String",
"description":"First name of the user, if the name was requested by the bot",
"html_description":"<td><em>Optional</em>. First name of the user, if the name was requested by the bot</td>",
"rst_description":"*Optional*. First name of the user, if the name was requested by the bot\n",
"name":"first_name",
"required":false
},
{
"type":"String",
"description":"Last name of the user, if the name was requested by the bot",
"html_description":"<td><em>Optional</em>. Last name of the user, if the name was requested by the bot</td>",
"rst_description":"*Optional*. Last name of the user, if the name was requested by the bot\n",
"name":"last_name",
"required":false
},
{
"type":"String",
"description":"Username of the user, if the username was requested by the bot",
"html_description":"<td><em>Optional</em>. Username of the user, if the username was requested by the bot</td>",
"rst_description":"*Optional*. Username of the user, if the username was requested by the bot\n",
"name":"username",
"required":false
},
{
"type":"Array of PhotoSize",
"description":"Available sizes of the chat photo, if the photo was requested by the bot",
"html_description":"<td><em>Optional</em>. Available sizes of the chat photo, if the photo was requested by the bot</td>",
"rst_description":"*Optional*. Available sizes of the chat photo, if the photo was requested by the bot\n",
"description":"This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.",
"html_description":"<p>This object contains information about the users whose identifiers were shared with the bot using a <a href=\"#keyboardbuttonrequestusers\">KeyboardButtonRequestUsers</a> button.</p>",
"rst_description":"This object contains information about the users whose identifiers were shared with the bot using a :class:`aiogram.types.keyboard_button_request_users.KeyboardButtonRequestUsers` button.",
"annotations":[
{
"type":"Integer",
"description":"Identifier of the request",
"html_description":"<td>Identifier of the request</td>",
"description":"This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.",
"html_description":"<p>This object contains information about a chat that was shared with the bot using a <a href=\"#keyboardbuttonrequestchat\">KeyboardButtonRequestChat</a> button.</p>",
"rst_description":"This object contains information about a chat that was shared with the bot using a :class:`aiogram.types.keyboard_button_request_chat.KeyboardButtonRequestChat` button.",
"description":"Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.",
"html_description":"<td>Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.</td>",
"rst_description":"Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.\n",
"description":"This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.",
"html_description":"<p>This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a>.</p>",
"rst_description":"This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_.",
"annotations":[
{
"type":"Boolean",
"description":"True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the access was granted after the user accepted an explicit request from a Web App sent by the method <a href=\"/bots/webapps#initializing-mini-apps\">requestWriteAccess</a></td>",
"rst_description":"*Optional*. :code:`True`, if the access was granted after the user accepted an explicit request from a Web App sent by the method `requestWriteAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"description":"Describes a service message about a change in the price of paid messages within a chat.",
"html_description":"<p>Describes a service message about a change in the price of paid messages within a chat.</p>",
"rst_description":"Describes a service message about a change in the price of paid messages within a chat.",
"annotations":[
{
"type":"Integer",
"description":"The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message",
"html_description":"<td>The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message</td>",
"rst_description":"The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message\n",
"description":"Describes a service message about a change in the price of direct messages sent to a channel chat.",
"html_description":"<p>Describes a service message about a change in the price of direct messages sent to a channel chat.</p>",
"rst_description":"Describes a service message about a change in the price of direct messages sent to a channel chat.",
"annotations":[
{
"type":"Boolean",
"description":"True, if direct messages are enabled for the channel chat; false otherwise",
"html_description":"<td><em>True</em>, if direct messages are enabled for the channel chat; false otherwise</td>",
"rst_description":":code:`True`, if direct messages are enabled for the channel chat; false otherwise\n",
"name":"are_direct_messages_enabled",
"required":true
},
{
"type":"Integer",
"description":"The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.",
"html_description":"<td><em>Optional</em>. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.</td>",
"rst_description":"*Optional*. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.\n",
"description":"Describes a service message about the approval of a suggested post.",
"html_description":"<p>Describes a service message about the approval of a suggested post.</p>",
"rst_description":"Describes a service message about the approval of a suggested post.",
"annotations":[
{
"type":"Message",
"description":"Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the suggested post. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the suggested post. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name":"suggested_post_message",
"required":false
},
{
"type":"SuggestedPostPrice",
"description":"Amount paid for the post",
"html_description":"<td><em>Optional</em>. Amount paid for the post</td>",
"rst_description":"*Optional*. Amount paid for the post\n",
"name":"price",
"required":false
},
{
"type":"Integer",
"description":"Date when the post will be published",
"html_description":"<td>Date when the post will be published</td>",
"rst_description":"Date when the post will be published\n",
"name":"send_date",
"required":true
}
],
"category":"types"
},
{
"anchor":"suggestedpostapprovalfailed",
"name":"SuggestedPostApprovalFailed",
"description":"Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.",
"html_description":"<p>Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.</p>",
"rst_description":"Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.",
"annotations":[
{
"type":"Message",
"description":"Message containing the suggested post whose approval has failed. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the suggested post whose approval has failed. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the suggested post whose approval has failed. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name":"suggested_post_message",
"required":false
},
{
"type":"SuggestedPostPrice",
"description":"Expected price of the post",
"html_description":"<td>Expected price of the post</td>",
"rst_description":"Expected price of the post\n",
"name":"price",
"required":true
}
],
"category":"types"
},
{
"anchor":"suggestedpostdeclined",
"name":"SuggestedPostDeclined",
"description":"Describes a service message about the rejection of a suggested post.",
"html_description":"<p>Describes a service message about the rejection of a suggested post.</p>",
"rst_description":"Describes a service message about the rejection of a suggested post.",
"annotations":[
{
"type":"Message",
"description":"Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the suggested post. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the suggested post. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name":"suggested_post_message",
"required":false
},
{
"type":"String",
"description":"Comment with which the post was declined",
"html_description":"<td><em>Optional</em>. Comment with which the post was declined</td>",
"rst_description":"*Optional*. Comment with which the post was declined\n",
"name":"comment",
"required":false
}
],
"category":"types"
},
{
"anchor":"suggestedpostpaid",
"name":"SuggestedPostPaid",
"description":"Describes a service message about a successful payment for a suggested post.",
"html_description":"<p>Describes a service message about a successful payment for a suggested post.</p>",
"rst_description":"Describes a service message about a successful payment for a suggested post.",
"annotations":[
{
"type":"Message",
"description":"Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the suggested post. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the suggested post. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name":"suggested_post_message",
"required":false
},
{
"type":"String",
"description":"Currency in which the payment was made. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins",
"html_description":"<td>Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins</td>",
"rst_description":"Currency in which the payment was made. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins\n",
"name":"currency",
"required":true
},
{
"type":"Integer",
"description":"The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only",
"html_description":"<td><em>Optional</em>. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only</td>",
"rst_description":"*Optional*. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only\n",
"name":"amount",
"required":false
},
{
"type":"StarAmount",
"description":"The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only",
"html_description":"<td><em>Optional</em>. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only</td>",
"rst_description":"*Optional*. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only\n",
"name":"star_amount",
"required":false
}
],
"category":"types"
},
{
"anchor":"suggestedpostrefunded",
"name":"SuggestedPostRefunded",
"description":"Describes a service message about a payment refund for a suggested post.",
"html_description":"<p>Describes a service message about a payment refund for a suggested post.</p>",
"rst_description":"Describes a service message about a payment refund for a suggested post.",
"annotations":[
{
"type":"Message",
"description":"Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.",
"html_description":"<td><em>Optional</em>. Message containing the suggested post. Note that the <a href=\"#message\">Message</a> object in this field will not contain the <em>reply_to_message</em> field even if it itself is a reply.</td>",
"rst_description":"*Optional*. Message containing the suggested post. Note that the :class:`aiogram.types.message.Message` object in this field will not contain the *reply_to_message* field even if it itself is a reply.\n",
"name":"suggested_post_message",
"required":false
},
{
"type":"String",
"description":"Reason for the refund. Currently, one of 'post_deleted' if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or 'payment_refunded' if the payer refunded their payment.",
"html_description":"<td>Reason for the refund. Currently, one of “post_deleted” if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or “payment_refunded” if the payer refunded their payment.</td>",
"rst_description":"Reason for the refund. Currently, one of 'post_deleted' if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or 'payment_refunded' if the payer refunded their payment.\n",
"description":"This object represents a message about a scheduled giveaway.",
"html_description":"<p>This object represents a message about a scheduled giveaway.</p>",
"rst_description":"This object represents a message about a scheduled giveaway.",
"annotations":[
{
"type":"Array of Chat",
"description":"The list of chats which the user must join to participate in the giveaway",
"html_description":"<td>The list of chats which the user must join to participate in the giveaway</td>",
"rst_description":"The list of chats which the user must join to participate in the giveaway\n",
"name":"chats",
"required":true
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when winners of the giveaway will be selected",
"html_description":"<td>Point in time (Unix timestamp) when winners of the giveaway will be selected</td>",
"rst_description":"Point in time (Unix timestamp) when winners of the giveaway will be selected\n",
"name":"winners_selection_date",
"required":true
},
{
"type":"Integer",
"description":"The number of users which are supposed to be selected as winners of the giveaway",
"html_description":"<td>The number of users which are supposed to be selected as winners of the giveaway</td>",
"rst_description":"The number of users which are supposed to be selected as winners of the giveaway\n",
"name":"winner_count",
"required":true
},
{
"type":"True",
"description":"True, if only users who join the chats after the giveaway started should be eligible to win",
"html_description":"<td><em>Optional</em>. <em>True</em>, if only users who join the chats after the giveaway started should be eligible to win</td>",
"rst_description":"*Optional*. :code:`True`, if only users who join the chats after the giveaway started should be eligible to win\n",
"name":"only_new_members",
"required":false
},
{
"type":"True",
"description":"True, if the list of giveaway winners will be visible to everyone",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the list of giveaway winners will be visible to everyone</td>",
"rst_description":"*Optional*. :code:`True`, if the list of giveaway winners will be visible to everyone\n",
"name":"has_public_winners",
"required":false
},
{
"type":"String",
"description":"Description of additional giveaway prize",
"html_description":"<td><em>Optional</em>. Description of additional giveaway prize</td>",
"rst_description":"*Optional*. Description of additional giveaway prize\n",
"name":"prize_description",
"required":false
},
{
"type":"Array of String",
"description":"A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.",
"html_description":"<td><em>Optional</em>. A list of two-letter <a href=\"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</a> country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.</td>",
"rst_description":"*Optional*. A list of two-letter `ISO 3166-1 alpha-2 <https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`_ country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.\n",
"description":"The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
"html_description":"<td><em>Optional</em>. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only</td>",
"rst_description":"*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
"name":"prize_star_count",
"required":false
},
{
"type":"Integer",
"description":"The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only",
"html_description":"<td><em>Optional</em>. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only</td>",
"rst_description":"*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only\n",
"description":"The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only",
"html_description":"<td><em>Optional</em>. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only</td>",
"rst_description":"*Optional*. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only\n",
"name":"prize_star_count",
"required":false
},
{
"type":"Integer",
"description":"The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only",
"html_description":"<td><em>Optional</em>. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only</td>",
"rst_description":"*Optional*. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only\n",
"html_description":"<td><em>Optional</em>. Number of undistributed prizes</td>",
"rst_description":"*Optional*. Number of undistributed prizes\n",
"name":"unclaimed_prize_count",
"required":false
},
{
"type":"True",
"description":"True, if only users who had joined the chats after the giveaway started were eligible to win",
"html_description":"<td><em>Optional</em>. <em>True</em>, if only users who had joined the chats after the giveaway started were eligible to win</td>",
"rst_description":"*Optional*. :code:`True`, if only users who had joined the chats after the giveaway started were eligible to win\n",
"name":"only_new_members",
"required":false
},
{
"type":"True",
"description":"True, if the giveaway was canceled because the payment for it was refunded",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the giveaway was canceled because the payment for it was refunded</td>",
"rst_description":"*Optional*. :code:`True`, if the giveaway was canceled because the payment for it was refunded\n",
"name":"was_refunded",
"required":false
},
{
"type":"String",
"description":"Description of additional giveaway prize",
"html_description":"<td><em>Optional</em>. Description of additional giveaway prize</td>",
"rst_description":"*Optional*. Description of additional giveaway prize\n",
"description":"True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.</td>",
"rst_description":"*Optional*. :code:`True`, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.\n",
"description":"True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview</td>",
"rst_description":"*Optional*. :code:`True`, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview\n",
"description":"True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview</td>",
"rst_description":"*Optional*. :code:`True`, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview\n",
"description":"True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text</td>",
"rst_description":"*Optional*. :code:`True`, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text\n",
"description":"Currency in which the post will be paid. Currently, must be one of 'XTR' for Telegram Stars or 'TON' for toncoins",
"html_description":"<td>Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins</td>",
"rst_description":"Currency in which the post will be paid. Currently, must be one of 'XTR' for Telegram Stars or 'TON' for toncoins\n",
"name":"currency",
"required":true
},
{
"type":"Integer",
"description":"The amount of the currency that will be paid for the post in the smallest units of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.",
"html_description":"<td>The amount of the currency that will be paid for the post in the <em>smallest units</em> of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.</td>",
"rst_description":"The amount of the currency that will be paid for the post in the *smallest units* of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.\n",
"name":"amount",
"required":true
}
],
"category":"types"
},
{
"anchor":"suggestedpostinfo",
"name":"SuggestedPostInfo",
"description":"Contains information about a suggested post.",
"html_description":"<p>Contains information about a suggested post.</p>",
"rst_description":"Contains information about a suggested post.",
"annotations":[
{
"type":"String",
"description":"State of the suggested post. Currently, it can be one of 'pending', 'approved', 'declined'.",
"html_description":"<td>State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.</td>",
"rst_description":"State of the suggested post. Currently, it can be one of 'pending', 'approved', 'declined'.\n",
"name":"state",
"required":true
},
{
"type":"SuggestedPostPrice",
"description":"Proposed price of the post. If the field is omitted, then the post is unpaid.",
"html_description":"<td><em>Optional</em>. Proposed price of the post. If the field is omitted, then the post is unpaid.</td>",
"rst_description":"*Optional*. Proposed price of the post. If the field is omitted, then the post is unpaid.\n",
"name":"price",
"required":false
},
{
"type":"Integer",
"description":"Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.",
"html_description":"<td><em>Optional</em>. Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.</td>",
"rst_description":"*Optional*. Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.\n",
"name":"send_date",
"required":false
}
],
"category":"types"
},
{
"anchor":"suggestedpostparameters",
"name":"SuggestedPostParameters",
"description":"Contains parameters of a post that is being suggested by the bot.",
"html_description":"<p>Contains parameters of a post that is being suggested by the bot.</p>",
"rst_description":"Contains parameters of a post that is being suggested by the bot.",
"annotations":[
{
"type":"SuggestedPostPrice",
"description":"Proposed price for the post. If the field is omitted, then the post is unpaid.",
"html_description":"<td><em>Optional</em>. Proposed price for the post. If the field is omitted, then the post is unpaid.</td>",
"rst_description":"*Optional*. Proposed price for the post. If the field is omitted, then the post is unpaid.\n",
"name":"price",
"required":false
},
{
"type":"Integer",
"description":"Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.",
"html_description":"<td><em>Optional</em>. Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.</td>",
"rst_description":"*Optional*. Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.\n",
"name":"send_date",
"required":false
}
],
"category":"types"
},
{
"anchor":"directmessagestopic",
"name":"DirectMessagesTopic",
"description":"Describes a topic of a direct messages chat.",
"html_description":"<p>Describes a topic of a direct messages chat.</p>",
"rst_description":"Describes a topic of a direct messages chat.",
"description":"Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td>Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"description":"This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.\nThe maximum file size to download is 20 MB",
"html_description":"<p>This object represents a file ready to be downloaded. The file can be downloaded via the link <code>https://api.telegram.org/file/bot<token>/<file_path></code>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling <a href=\"#getfile\">getFile</a>.</p><blockquote>\n<p>The maximum file size to download is 20 MB</p>\n</blockquote>",
"rst_description":"This object represents a file ready to be downloaded. The file can be downloaded via the link :code:`https://api.telegram.org/file/bot<token>/<file_path>`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling :class:`aiogram.methods.get_file.GetFile`.\n\n The maximum file size to download is 20 MB",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"file_unique_id",
"required":true
},
{
"type":"Integer",
"description":"File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.",
"html_description":"<td><em>Optional</em>. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.</td>",
"rst_description":"*Optional*. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.\n",
"name":"file_size",
"required":false
},
{
"type":"String",
"description":"File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.",
"html_description":"<td><em>Optional</em>. File path. Use <code>https://api.telegram.org/file/bot<token>/<file_path></code> to get the file.</td>",
"rst_description":"*Optional*. File path. Use :code:`https://api.telegram.org/file/bot<token>/<file_path>` to get the file.\n",
"name":"file_path",
"required":false
}
],
"category":"types"
},
{
"anchor":"webappinfo",
"name":"WebAppInfo",
"description":"Describes a Web App.",
"html_description":"<p>Describes a <a href=\"/bots/webapps\">Web App</a>.</p>",
"rst_description":"Describes a `Web App <https://core.telegram.org/bots/webapps>`_.",
"annotations":[
{
"type":"String",
"description":"An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps",
"html_description":"<td>An HTTPS URL of a Web App to be opened with additional data as specified in <a href=\"/bots/webapps#initializing-mini-apps\">Initializing Web Apps</a></td>",
"rst_description":"An HTTPS URL of a Web App to be opened with additional data as specified in `Initializing Web Apps <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_\n",
"description":"This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"html_description":"<p>This object represents a <a href=\"/bots/features#keyboards\">custom keyboard</a> with reply options (see <a href=\"/bots/features#keyboards\">Introduction to bots</a> for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.</p>",
"rst_description":"This object represents a `custom keyboard <https://core.telegram.org/bots/features#keyboards>`_ with reply options (see `Introduction to bots <https://core.telegram.org/bots/features#keyboards>`_ for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"description":"Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.",
"html_description":"<td><em>Optional</em>. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to <em>false</em>, in which case the custom keyboard can be hidden and opened with a keyboard icon.</td>",
"rst_description":"*Optional*. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to *false*, in which case the custom keyboard can be hidden and opened with a keyboard icon.\n",
"description":"Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.",
"html_description":"<td><em>Optional</em>. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to <em>false</em>, in which case the custom keyboard is always of the same height as the app's standard keyboard.</td>",
"rst_description":"*Optional*. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to *false*, in which case the custom keyboard is always of the same height as the app's standard keyboard.\n",
"name":"resize_keyboard",
"required":false
},
{
"type":"Boolean",
"description":"Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.",
"html_description":"<td><em>Optional</em>. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to <em>false</em>.</td>",
"rst_description":"*Optional*. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to *false*.\n",
"name":"one_time_keyboard",
"required":false
},
{
"type":"String",
"description":"The placeholder to be shown in the input field when the keyboard is active; 1-64 characters",
"html_description":"<td><em>Optional</em>. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters</td>",
"rst_description":"*Optional*. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters\n",
"description":"Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.\n\nExample: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.",
"html_description":"<td><em>Optional</em>. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the <em>text</em> of the <a href=\"#message\">Message</a> object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.<br/>\n<br/>\n<em>Example:</em> A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.</td>",
"rst_description":"*Optional*. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the *text* of the :class:`aiogram.types.message.Message` object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.\n\n\n\n*Example:* A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.\n",
"description":"This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.",
"html_description":"<p>This object represents one button of the reply keyboard. At most one of the fields other than <em>text</em>, <em>icon_custom_emoji_id</em>, and <em>style</em> must be used to specify the type of the button. For simple text buttons, <em>String</em> can be used instead of this object to specify the button text.</p>",
"rst_description":"This object represents one button of the reply keyboard. At most one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button. For simple text buttons, *String* can be used instead of this object to specify the button text.",
"description":"Text of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed",
"html_description":"<td>Text of the button. If none of the fields other than <em>text</em>, <em>icon_custom_emoji_id</em>, and <em>style</em> are used, it will be sent as a message when the button is pressed</td>",
"rst_description":"Text of the button. If none of the fields other than *text*, *icon_custom_emoji_id*, and *style* are used, it will be sent as a message when the button is pressed\n",
"description":"Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.",
"html_description":"<td><em>Optional</em>. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on <a href=\"https://fragment.com\">Fragment</a> or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.</td>",
"rst_description":"*Optional*. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on `Fragment <https://fragment.com>`_ or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.\n",
"name":"icon_custom_emoji_id",
"required":false
},
{
"type":"String",
"description":"Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.",
"html_description":"<td><em>Optional</em>. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.</td>",
"rst_description":"*Optional*. Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.\n",
"description":"If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a 'users_shared' service message. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.</td>",
"rst_description":"*Optional*. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a 'users_shared' service message. Available in private chats only.\n",
"description":"If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.</td>",
"rst_description":"*Optional*. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a 'chat_shared' service message. Available in private chats only.\n",
"description":"If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If <em>True</em>, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.</td>",
"rst_description":"*Optional*. If :code:`True`, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.\n",
"name":"request_contact",
"required":false
},
{
"type":"Boolean",
"description":"If True, the user's current location will be sent when the button is pressed. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If <em>True</em>, the user's current location will be sent when the button is pressed. Available in private chats only.</td>",
"rst_description":"*Optional*. If :code:`True`, the user's current location will be sent when the button is pressed. Available in private chats only.\n",
"name":"request_location",
"required":false
},
{
"type":"KeyboardButtonPollType",
"description":"If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.</td>",
"rst_description":"*Optional*. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.\n",
"name":"request_poll",
"required":false
},
{
"type":"WebAppInfo",
"description":"If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a 'web_app_data' service message. Available in private chats only.",
"html_description":"<td><em>Optional</em>. If specified, the described <a href=\"/bots/webapps\">Web App</a> will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.</td>",
"rst_description":"*Optional*. If specified, the described `Web App <https://core.telegram.org/bots/webapps>`_ will be launched when the button is pressed. The Web App will be able to send a 'web_app_data' service message. Available in private chats only.\n",
"description":"This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed.",
"html_description":"<p>This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. <a href=\"/bots/features#chat-and-user-selection\">More about requesting users »</a></p>",
"rst_description":"This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. `More about requesting users » <https://core.telegram.org/bots/features#chat-and-user-selection>`_",
"description":"Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message",
"html_description":"<td>Signed 32-bit identifier of the request that will be received back in the <a href=\"#usersshared\">UsersShared</a> object. Must be unique within the message</td>",
"rst_description":"Signed 32-bit identifier of the request that will be received back in the :class:`aiogram.types.users_shared.UsersShared` object. Must be unique within the message\n",
"description":"Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request bots, pass <em>False</em> to request regular users. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request bots, pass :code:`False` to request regular users. If not specified, no additional restrictions are applied.\n",
"description":"Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request premium users, pass <em>False</em> to request non-premium users. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request premium users, pass :code:`False` to request non-premium users. If not specified, no additional restrictions are applied.\n",
"description":"This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate..",
"html_description":"<p>This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. <a href=\"/bots/features#chat-and-user-selection\">More about requesting chats »</a>.</p>",
"rst_description":"This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. `More about requesting chats » <https://core.telegram.org/bots/features#chat-and-user-selection>`_.",
"description":"Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message",
"html_description":"<td>Signed 32-bit identifier of the request, which will be received back in the <a href=\"#chatshared\">ChatShared</a> object. Must be unique within the message</td>",
"rst_description":"Signed 32-bit identifier of the request, which will be received back in the :class:`aiogram.types.chat_shared.ChatShared` object. Must be unique within the message\n",
"name":"request_id",
"required":true
},
{
"type":"Boolean",
"description":"Pass True to request a channel chat, pass False to request a group or a supergroup chat.",
"html_description":"<td>Pass <em>True</em> to request a channel chat, pass <em>False</em> to request a group or a supergroup chat.</td>",
"rst_description":"Pass :code:`True` to request a channel chat, pass :code:`False` to request a group or a supergroup chat.\n",
"name":"chat_is_channel",
"required":true
},
{
"type":"Boolean",
"description":"Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request a forum supergroup, pass <em>False</em> to request a non-forum chat. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request a forum supergroup, pass :code:`False` to request a non-forum chat. If not specified, no additional restrictions are applied.\n",
"name":"chat_is_forum",
"required":false
},
{
"type":"Boolean",
"description":"Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request a supergroup or a channel with a username, pass <em>False</em> to request a chat without a username. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request a supergroup or a channel with a username, pass :code:`False` to request a chat without a username. If not specified, no additional restrictions are applied.\n",
"name":"chat_has_username",
"required":false
},
{
"type":"Boolean",
"description":"Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request a chat owned by the user. Otherwise, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request a chat owned by the user. Otherwise, no additional restrictions are applied.\n",
"name":"chat_is_created",
"required":false
},
{
"type":"ChatAdministratorRights",
"description":"A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of <em>bot_administrator_rights</em>. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of *bot_administrator_rights*. If not specified, no additional restrictions are applied.\n",
"name":"user_administrator_rights",
"required":false
},
{
"type":"ChatAdministratorRights",
"description":"A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of <em>user_administrator_rights</em>. If not specified, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of *user_administrator_rights*. If not specified, no additional restrictions are applied.\n",
"name":"bot_administrator_rights",
"required":false
},
{
"type":"Boolean",
"description":"Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.\n",
"description":"This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.",
"html_description":"<p>This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.</p>",
"rst_description":"This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.",
"annotations":[
{
"type":"String",
"description":"If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.",
"html_description":"<td><em>Optional</em>. If <em>quiz</em> is passed, the user will be allowed to create only polls in the quiz mode. If <em>regular</em> is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.</td>",
"rst_description":"*Optional*. If *quiz* is passed, the user will be allowed to create only polls in the quiz mode. If *regular* is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.\n",
"description":"Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"html_description":"<p>Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see <a href=\"#replykeyboardmarkup\">ReplyKeyboardMarkup</a>). Not supported in channels and for messages sent on behalf of a Telegram Business account.</p>",
"rst_description":"Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`). Not supported in channels and for messages sent on behalf of a Telegram Business account.",
"description":"Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)",
"html_description":"<td>Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use <em>one_time_keyboard</em> in <a href=\"#replykeyboardmarkup\">ReplyKeyboardMarkup</a>)</td>",
"rst_description":"Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use *one_time_keyboard* in :class:`aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup`)\n",
"description":"Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.\n\nExample: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.",
"html_description":"<td><em>Optional</em>. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the <em>text</em> of the <a href=\"#message\">Message</a> object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.<br/>\n<br/>\n<em>Example:</em> A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.</td>",
"rst_description":"*Optional*. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the *text* of the :class:`aiogram.types.message.Message` object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.\n\n\n\n*Example:* A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.\n",
"description":"This object represents an inline keyboard that appears right next to the message it belongs to.",
"html_description":"<p>This object represents an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a> that appears right next to the message it belongs to.</p>",
"rst_description":"This object represents an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ that appears right next to the message it belongs to.",
"description":"Array of button rows, each represented by an Array of InlineKeyboardButton objects",
"html_description":"<td>Array of button rows, each represented by an Array of <a href=\"#inlinekeyboardbutton\">InlineKeyboardButton</a> objects</td>",
"rst_description":"Array of button rows, each represented by an Array of :class:`aiogram.types.inline_keyboard_button.InlineKeyboardButton` objects\n",
"description":"This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.",
"html_description":"<p>This object represents one button of an inline keyboard. Exactly one of the fields other than <em>text</em>, <em>icon_custom_emoji_id</em>, and <em>style</em> must be used to specify the type of the button.</p>",
"rst_description":"This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button.",
"description":"Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.",
"html_description":"<td><em>Optional</em>. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on <a href=\"https://fragment.com\">Fragment</a> or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.</td>",
"rst_description":"*Optional*. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on `Fragment <https://fragment.com>`_ or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.\n",
"name":"icon_custom_emoji_id",
"required":false
},
{
"type":"String",
"description":"Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.",
"html_description":"<td><em>Optional</em>. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.</td>",
"rst_description":"*Optional*. Style of the button. Must be one of 'danger' (red), 'success' (green) or 'primary' (blue). If omitted, then an app-specific style is used.\n",
"description":"HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.",
"html_description":"<td><em>Optional</em>. HTTP or tg:// URL to be opened when the button is pressed. Links <code>tg://user?id=<user_id></code> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.</td>",
"rst_description":"*Optional*. HTTP or tg:// URL to be opened when the button is pressed. Links :code:`tg://user?id=<user_id>` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.\n",
"description":"Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes",
"html_description":"<td><em>Optional</em>. Data to be sent in a <a href=\"#callbackquery\">callback query</a> to the bot when the button is pressed, 1-64 bytes</td>",
"rst_description":"*Optional*. Data to be sent in a `callback query <https://core.telegram.org/bots/api#callbackquery>`_ to the bot when the button is pressed, 1-64 bytes\n",
"description":"Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.",
"html_description":"<td><em>Optional</em>. Description of the <a href=\"/bots/webapps\">Web App</a> that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method <a href=\"#answerwebappquery\">answerWebAppQuery</a>. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.</td>",
"rst_description":"*Optional*. Description of the `Web App <https://core.telegram.org/bots/webapps>`_ that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.\n",
"description":"An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.",
"html_description":"<td><em>Optional</em>. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the <a href=\"/widgets/login\">Telegram Login Widget</a>.</td>",
"rst_description":"*Optional*. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the `Telegram Login Widget <https://core.telegram.org/widgets/login>`_.\n",
"description":"If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
"html_description":"<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.</td>",
"rst_description":"*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"description":"If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
"html_description":"<td><em>Optional</em>. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.<br/>\n<br/>\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.</td>",
"rst_description":"*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.\n\n\n\nThis offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"description":"If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.",
"html_description":"<td><em>Optional</em>. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.</td>",
"rst_description":"*Optional*. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a Telegram Business account.\n",
"description":"Description of the game that will be launched when the user presses the button.\n\nNOTE: This type of button must always be the first button in the first row.",
"html_description":"<td><em>Optional</em>. Description of the game that will be launched when the user presses the button.<br/>\n<br/>\n<strong>NOTE:</strong> This type of button <strong>must</strong> always be the first button in the first row.</td>",
"rst_description":"*Optional*. Description of the game that will be launched when the user presses the button.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row.\n",
"description":"Specify True, to send a Pay button. Substrings '' and 'XTR' in the buttons's text will be replaced with a Telegram Star icon.\n\nNOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.",
"html_description":"<td><em>Optional</em>. Specify <em>True</em>, to send a <a href=\"#payments\">Pay button</a>. Substrings “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E2AD90.png\" width=\"20\" height=\"20\" alt=\"⭐\"/>” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.<br/>\n<br/>\n<strong>NOTE:</strong> This type of button <strong>must</strong> always be the first button in the first row and can only be used in invoice messages.</td>",
"rst_description":"*Optional*. Specify :code:`True`, to send a `Pay button <https://core.telegram.org/bots/api#payments>`_. Substrings '⭐' and 'XTR' in the buttons's text will be replaced with a Telegram Star icon.\n\n\n\n**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.\n",
"description":"This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:\nTelegram apps support these buttons as of version 5.7.\nSample bot: @discussbot",
"html_description":"<p>This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the <a href=\"/widgets/login\">Telegram Login Widget</a> when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:</p><p>Telegram apps support these buttons as of <a href=\"https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots\">version 5.7</a>.</p><blockquote>\n<p>Sample bot: <a href=\"https://t.me/discussbot\">@discussbot</a></p>\n</blockquote>",
"rst_description":"This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the `Telegram Login Widget <https://core.telegram.org/widgets/login>`_ when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:\nTelegram apps support these buttons as of `version 5.7 <https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots>`_.\n\n Sample bot: `@discussbot <https://t.me/discussbot>`_",
"annotations":[
{
"type":"String",
"description":"An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.\n\nNOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.",
"html_description":"<td>An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in <a href=\"/widgets/login#receiving-authorization-data\">Receiving authorization data</a>.<br/>\n<br/>\n<strong>NOTE:</strong> You <strong>must</strong> always check the hash of the received data to verify the authentication and the integrity of the data as described in <a href=\"/widgets/login#checking-authorization\">Checking authorization</a>.</td>",
"rst_description":"An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in `Receiving authorization data <https://core.telegram.org/widgets/login#receiving-authorization-data>`_.\n\n\n\n**NOTE:** You **must** always check the hash of the received data to verify the authentication and the integrity of the data as described in `Checking authorization <https://core.telegram.org/widgets/login#checking-authorization>`_.\n",
"name":"url",
"required":true
},
{
"type":"String",
"description":"New text of the button in forwarded messages.",
"html_description":"<td><em>Optional</em>. New text of the button in forwarded messages.</td>",
"rst_description":"*Optional*. New text of the button in forwarded messages.\n",
"name":"forward_text",
"required":false
},
{
"type":"String",
"description":"Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.",
"html_description":"<td><em>Optional</em>. Username of a bot, which will be used for user authorization. See <a href=\"/widgets/login#setting-up-a-bot\">Setting up a bot</a> for more details. If not specified, the current bot's username will be assumed. The <em>url</em>'s domain must be the same as the domain linked with the bot. See <a href=\"/widgets/login#linking-your-domain-to-the-bot\">Linking your domain to the bot</a> for more details.</td>",
"rst_description":"*Optional*. Username of a bot, which will be used for user authorization. See `Setting up a bot <https://core.telegram.org/widgets/login#setting-up-a-bot>`_ for more details. If not specified, the current bot's username will be assumed. The *url*'s domain must be the same as the domain linked with the bot. See `Linking your domain to the bot <https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot>`_ for more details.\n",
"name":"bot_username",
"required":false
},
{
"type":"Boolean",
"description":"Pass True to request the permission for your bot to send messages to the user.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> to request the permission for your bot to send messages to the user.</td>",
"rst_description":"*Optional*. Pass :code:`True` to request the permission for your bot to send messages to the user.\n",
"description":"This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.",
"html_description":"<p>This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.</p>",
"rst_description":"This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.",
"annotations":[
{
"type":"String",
"description":"The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted",
"html_description":"<td><em>Optional</em>. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted</td>",
"rst_description":"*Optional*. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted\n",
"name":"query",
"required":false
},
{
"type":"Boolean",
"description":"True, if private chats with users can be chosen",
"description":"This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.\nNOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).",
"html_description":"<p>This object represents an incoming callback query from a callback button in an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If the button that originated the query was attached to a message sent by the bot, the field <em>message</em> will be present. If the button was attached to a message sent via the bot (in <a href=\"#inline-mode\">inline mode</a>), the field <em>inline_message_id</em> will be present. Exactly one of the fields <em>data</em> or <em>game_short_name</em> will be present.</p><blockquote>\n<p><strong>NOTE:</strong> After the user presses a callback button, Telegram clients will display a progress bar until you call <a href=\"#answercallbackquery\">answerCallbackQuery</a>. It is, therefore, necessary to react by calling <a href=\"#answercallbackquery\">answerCallbackQuery</a> even if no notification to the user is needed (e.g., without specifying any of the optional parameters).</p>\n</blockquote>",
"rst_description":"This object represents an incoming callback query from a callback button in an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If the button that originated the query was attached to a message sent by the bot, the field *message* will be present. If the button was attached to a message sent via the bot (in `inline mode <https://core.telegram.org/bots/api#inline-mode>`_), the field *inline_message_id* will be present. Exactly one of the fields *data* or *game_short_name* will be present.\n\n **NOTE:** After the user presses a callback button, Telegram clients will display a progress bar until you call :class:`aiogram.methods.answer_callback_query.AnswerCallbackQuery`. It is, therefore, necessary to react by calling :class:`aiogram.methods.answer_callback_query.AnswerCallbackQuery` even if no notification to the user is needed (e.g., without specifying any of the optional parameters).",
"annotations":[
{
"type":"String",
"description":"Unique identifier for this query",
"html_description":"<td>Unique identifier for this query</td>",
"rst_description":"Unique identifier for this query\n",
"description":"Identifier of the message sent via the bot in inline mode, that originated the query.",
"html_description":"<td><em>Optional</em>. Identifier of the message sent via the bot in inline mode, that originated the query.</td>",
"rst_description":"*Optional*. Identifier of the message sent via the bot in inline mode, that originated the query.\n",
"name":"inline_message_id",
"required":false
},
{
"type":"String",
"description":"Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.",
"html_description":"<td>Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in <a href=\"#games\">games</a>.</td>",
"rst_description":"Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in :class:`aiogram.methods.games.Games`.\n",
"name":"chat_instance",
"required":true
},
{
"type":"String",
"description":"Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.",
"html_description":"<td><em>Optional</em>. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.</td>",
"rst_description":"*Optional*. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.\n",
"name":"data",
"required":false
},
{
"type":"String",
"description":"Short name of a Game to be returned, serves as the unique identifier for the game",
"html_description":"<td><em>Optional</em>. Short name of a <a href=\"#games\">Game</a> to be returned, serves as the unique identifier for the game</td>",
"rst_description":"*Optional*. Short name of a `Game <https://core.telegram.org/bots/api#games>`_ to be returned, serves as the unique identifier for the game\n",
"description":"Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.\nExample: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n\nExplain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\nGuide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\nThe last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"html_description":"<p>Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice <a href=\"/bots/features#privacy-mode\">privacy mode</a>. Not supported in channels and for messages sent on behalf of a Telegram Business account.</p><blockquote>\n<p><strong>Example:</strong> A <a href=\"https://t.me/PollBot\">poll bot</a> for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:</p>\n<ul>\n<li>Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.</li>\n<li>Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.</li>\n</ul>\n<p>The last option is definitely more attractive. And if you use <a href=\"#forcereply\">ForceReply</a> in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.</p>\n</blockquote>",
"rst_description":"Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice `privacy mode <https://core.telegram.org/bots/features#privacy-mode>`_. Not supported in channels and for messages sent on behalf of a Telegram Business account.\n\n **Example:** A `poll bot <https://t.me/PollBot>`_ for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:\n \n - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.\n - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.\n \n The last option is definitely more attractive. And if you use :class:`aiogram.types.force_reply.ForceReply` in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.",
"description":"Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.",
"html_description":"<td><em>Optional</em>. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the <em>text</em> of the <a href=\"#message\">Message</a> object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.</td>",
"rst_description":"*Optional*. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the *text* of the :class:`aiogram.types.message.Message` object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.\n",
"description":"This object represents a chat photo.",
"html_description":"<p>This object represents a chat photo.</p>",
"rst_description":"This object represents a chat photo.",
"annotations":[
{
"type":"String",
"description":"File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.",
"html_description":"<td>File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.</td>",
"rst_description":"File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.\n",
"name":"small_file_id",
"required":true
},
{
"type":"String",
"description":"Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"small_file_unique_id",
"required":true
},
{
"type":"String",
"description":"File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.",
"html_description":"<td>File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.</td>",
"rst_description":"File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.\n",
"name":"big_file_id",
"required":true
},
{
"type":"String",
"description":"Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"big_file_unique_id",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatinvitelink",
"name":"ChatInviteLink",
"description":"Represents an invite link for a chat.",
"html_description":"<p>Represents an invite link for a chat.</p>",
"rst_description":"Represents an invite link for a chat.",
"annotations":[
{
"type":"String",
"description":"The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with '…'.",
"html_description":"<td>The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.</td>",
"rst_description":"The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with '…'.\n",
"name":"invite_link",
"required":true
},
{
"type":"User",
"description":"Creator of the link",
"html_description":"<td>Creator of the link</td>",
"rst_description":"Creator of the link\n",
"name":"creator",
"required":true
},
{
"type":"Boolean",
"description":"True, if users joining the chat via the link need to be approved by chat administrators",
"html_description":"<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators</td>",
"rst_description":":code:`True`, if users joining the chat via the link need to be approved by chat administrators\n",
"name":"creates_join_request",
"required":true
},
{
"type":"Boolean",
"description":"True, if the link is primary",
"html_description":"<td><em>True</em>, if the link is primary</td>",
"rst_description":":code:`True`, if the link is primary\n",
"name":"is_primary",
"required":true
},
{
"type":"Boolean",
"description":"True, if the link is revoked",
"html_description":"<td><em>True</em>, if the link is revoked</td>",
"rst_description":":code:`True`, if the link is revoked\n",
"name":"is_revoked",
"required":true
},
{
"type":"String",
"description":"Invite link name",
"html_description":"<td><em>Optional</em>. Invite link name</td>",
"rst_description":"*Optional*. Invite link name\n",
"name":"name",
"required":false
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when the link will expire or has been expired",
"html_description":"<td><em>Optional</em>. Point in time (Unix timestamp) when the link will expire or has been expired</td>",
"rst_description":"*Optional*. Point in time (Unix timestamp) when the link will expire or has been expired\n",
"name":"expire_date",
"required":false
},
{
"type":"Integer",
"description":"The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"html_description":"<td><em>Optional</em>. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999</td>",
"rst_description":"*Optional*. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999\n",
"name":"member_limit",
"required":false
},
{
"type":"Integer",
"description":"Number of pending join requests created using this link",
"html_description":"<td><em>Optional</em>. Number of pending join requests created using this link</td>",
"rst_description":"*Optional*. Number of pending join requests created using this link\n",
"description":"The number of seconds the subscription will be active for before the next payment",
"html_description":"<td><em>Optional</em>. The number of seconds the subscription will be active for before the next payment</td>",
"rst_description":"*Optional*. The number of seconds the subscription will be active for before the next payment\n",
"name":"subscription_period",
"required":false
},
{
"type":"Integer",
"description":"The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link",
"html_description":"<td><em>Optional</em>. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link</td>",
"rst_description":"*Optional*. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link\n",
"description":"True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description":"<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description":":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"description":"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 the user)",
"html_description":"<td><em>True</em>, 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 the user)</td>",
"rst_description":":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 the user)\n",
"description":"True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description":"<td><em>True</em>, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description":":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"description":"True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"description":"True, if the administrator can edit messages of other users and can pin messages; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can edit messages of other users and can pin messages; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; for channels only\n",
"description":"True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"description":"True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
"description":"True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
"description":"This object represents changes in the status of a chat member.",
"html_description":"<p>This object represents changes in the status of a chat member.</p>",
"rst_description":"This object represents changes in the status of a chat member.",
"annotations":[
{
"type":"Chat",
"description":"Chat the user belongs to",
"html_description":"<td>Chat the user belongs to</td>",
"rst_description":"Chat the user belongs to\n",
"name":"chat",
"required":true
},
{
"type":"User",
"description":"Performer of the action, which resulted in the change",
"html_description":"<td>Performer of the action, which resulted in the change</td>",
"rst_description":"Performer of the action, which resulted in the change\n",
"name":"from",
"required":true
},
{
"type":"Integer",
"description":"Date the change was done in Unix time",
"html_description":"<td>Date the change was done in Unix time</td>",
"rst_description":"Date the change was done in Unix time\n",
"name":"date",
"required":true
},
{
"type":"ChatMember",
"description":"Previous information about the chat member",
"html_description":"<td>Previous information about the chat member</td>",
"rst_description":"Previous information about the chat member\n",
"name":"old_chat_member",
"required":true
},
{
"type":"ChatMember",
"description":"New information about the chat member",
"html_description":"<td>New information about the chat member</td>",
"rst_description":"New information about the chat member\n",
"name":"new_chat_member",
"required":true
},
{
"type":"ChatInviteLink",
"description":"Chat invite link, which was used by the user to join the chat; for joining by invite link events only.",
"html_description":"<td><em>Optional</em>. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.</td>",
"rst_description":"*Optional*. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.\n",
"description":"True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator</td>",
"rst_description":"*Optional*. :code:`True`, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator\n",
"description":"This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:\n - ChatMemberOwner\n - ChatMemberAdministrator\n - ChatMemberMember\n - ChatMemberRestricted\n - ChatMemberLeft\n - ChatMemberBanned",
"html_description":"<p>This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:</p><ul>\n<li><a href=\"#chatmemberowner\">ChatMemberOwner</a></li>\n<li><a href=\"#chatmemberadministrator\">ChatMemberAdministrator</a></li>\n<li><a href=\"#chatmembermember\">ChatMemberMember</a></li>\n<li><a href=\"#chatmemberrestricted\">ChatMemberRestricted</a></li>\n<li><a href=\"#chatmemberleft\">ChatMemberLeft</a></li>\n<li><a href=\"#chatmemberbanned\">ChatMemberBanned</a></li>\n</ul>",
"rst_description":"This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:\n\n - :class:`aiogram.types.chat_member_owner.ChatMemberOwner`\n - :class:`aiogram.types.chat_member_administrator.ChatMemberAdministrator`\n - :class:`aiogram.types.chat_member_member.ChatMemberMember`\n - :class:`aiogram.types.chat_member_restricted.ChatMemberRestricted`\n - :class:`aiogram.types.chat_member_left.ChatMemberLeft`\n - :class:`aiogram.types.chat_member_banned.ChatMemberBanned`",
"annotations":[],
"category":"types"
},
{
"anchor":"chatmemberowner",
"name":"ChatMemberOwner",
"description":"Represents a chat member that owns the chat and has all administrator privileges.",
"html_description":"<p>Represents a <a href=\"#chatmember\">chat member</a> that owns the chat and has all administrator privileges.</p>",
"rst_description":"Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that owns the chat and has all administrator privileges.",
"annotations":[
{
"type":"String",
"description":"The member's status in the chat, always 'creator'",
"html_description":"<td>The member's status in the chat, always “creator”</td>",
"rst_description":"The member's status in the chat, always 'creator'\n",
"name":"status",
"required":true
},
{
"type":"User",
"description":"Information about the user",
"html_description":"<td>Information about the user</td>",
"rst_description":"Information about the user\n",
"name":"user",
"required":true
},
{
"type":"Boolean",
"description":"True, if the user's presence in the chat is hidden",
"html_description":"<td><em>True</em>, if the user's presence in the chat is hidden</td>",
"rst_description":":code:`True`, if the user's presence in the chat is hidden\n",
"name":"is_anonymous",
"required":true
},
{
"type":"String",
"description":"Custom title for this user",
"html_description":"<td><em>Optional</em>. Custom title for this user</td>",
"rst_description":"*Optional*. Custom title for this user\n",
"name":"custom_title",
"required":false
}
],
"category":"types"
},
{
"anchor":"chatmemberadministrator",
"name":"ChatMemberAdministrator",
"description":"Represents a chat member that has some additional privileges.",
"html_description":"<p>Represents a <a href=\"#chatmember\">chat member</a> that has some additional privileges.</p>",
"rst_description":"Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that has some additional privileges.",
"annotations":[
{
"type":"String",
"description":"The member's status in the chat, always 'administrator'",
"html_description":"<td>The member's status in the chat, always “administrator”</td>",
"rst_description":"The member's status in the chat, always 'administrator'\n",
"name":"status",
"required":true
},
{
"type":"User",
"description":"Information about the user",
"html_description":"<td>Information about the user</td>",
"rst_description":"Information about the user\n",
"name":"user",
"required":true
},
{
"type":"Boolean",
"description":"True, if the bot is allowed to edit administrator privileges of that user",
"html_description":"<td><em>True</em>, if the bot is allowed to edit administrator privileges of that user</td>",
"rst_description":":code:`True`, if the bot is allowed to edit administrator privileges of that user\n",
"name":"can_be_edited",
"required":true
},
{
"type":"Boolean",
"description":"True, if the user's presence in the chat is hidden",
"html_description":"<td><em>True</em>, if the user's presence in the chat is hidden</td>",
"rst_description":":code:`True`, if the user's presence in the chat is hidden\n",
"description":"True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description":"<td><em>True</em>, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description":":code:`True`, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"description":"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 the user)",
"html_description":"<td><em>True</em>, 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 the user)</td>",
"rst_description":":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 the user)\n",
"description":"True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description":"<td><em>True</em>, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description":":code:`True`, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"description":"True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"description":"True, if the administrator can edit messages of other users and can pin messages; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can edit messages of other users and can pin messages; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can edit messages of other users and can pin messages; for channels only\n",
"description":"True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
"description":"True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only\n",
"description":"True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.</td>",
"rst_description":"*Optional*. :code:`True`, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.\n",
"description":"Represents a chat member that is under certain restrictions in the chat. Supergroups only.",
"html_description":"<p>Represents a <a href=\"#chatmember\">chat member</a> that is under certain restrictions in the chat. Supergroups only.</p>",
"rst_description":"Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that is under certain restrictions in the chat. Supergroups only.",
"annotations":[
{
"type":"String",
"description":"The member's status in the chat, always 'restricted'",
"html_description":"<td>The member's status in the chat, always “restricted”</td>",
"rst_description":"The member's status in the chat, always 'restricted'\n",
"description":"True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues",
"html_description":"<td><em>True</em>, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues</td>",
"rst_description":":code:`True`, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues\n",
"description":"Represents a chat member that isn't currently a member of the chat, but may join it themselves.",
"html_description":"<p>Represents a <a href=\"#chatmember\">chat member</a> that isn't currently a member of the chat, but may join it themselves.</p>",
"rst_description":"Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that isn't currently a member of the chat, but may join it themselves.",
"annotations":[
{
"type":"String",
"description":"The member's status in the chat, always 'left'",
"html_description":"<td>The member's status in the chat, always “left”</td>",
"rst_description":"The member's status in the chat, always 'left'\n",
"name":"status",
"required":true
},
{
"type":"User",
"description":"Information about the user",
"html_description":"<td>Information about the user</td>",
"rst_description":"Information about the user\n",
"name":"user",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatmemberbanned",
"name":"ChatMemberBanned",
"description":"Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.",
"html_description":"<p>Represents a <a href=\"#chatmember\">chat member</a> that was banned in the chat and can't return to the chat or view chat messages.</p>",
"rst_description":"Represents a `chat member <https://core.telegram.org/bots/api#chatmember>`_ that was banned in the chat and can't return to the chat or view chat messages.",
"annotations":[
{
"type":"String",
"description":"The member's status in the chat, always 'kicked'",
"html_description":"<td>The member's status in the chat, always “kicked”</td>",
"rst_description":"The member's status in the chat, always 'kicked'\n",
"name":"status",
"required":true
},
{
"type":"User",
"description":"Information about the user",
"html_description":"<td>Information about the user</td>",
"description":"Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.",
"html_description":"<td>Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.</td>",
"rst_description":"Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.\n",
"description":"True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues\n",
"description":"True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups\n",
"name":"can_change_info",
"required":false
},
{
"type":"Boolean",
"description":"True, if the user is allowed to invite new users to the chat",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to invite new users to the chat</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to invite new users to the chat\n",
"name":"can_invite_users",
"required":false
},
{
"type":"Boolean",
"description":"True, if the user is allowed to pin messages. Ignored in public supergroups",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to pin messages. Ignored in public supergroups</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to pin messages. Ignored in public supergroups\n",
"name":"can_pin_messages",
"required":false
},
{
"type":"Boolean",
"description":"True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages</td>",
"rst_description":"*Optional*. :code:`True`, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages\n",
"description":"The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60",
"html_description":"<td>The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60</td>",
"rst_description":"The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60\n",
"name":"opening_minute",
"required":true
},
{
"type":"Integer",
"description":"The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60",
"html_description":"<td>The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60</td>",
"rst_description":"The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60\n",
"description":"This object describes the rating of a user based on their Telegram Star spendings.",
"html_description":"<p>This object describes the rating of a user based on their Telegram Star spendings.</p>",
"rst_description":"This object describes the rating of a user based on their Telegram Star spendings.",
"annotations":[
{
"type":"Integer",
"description":"Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.",
"html_description":"<td>Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.</td>",
"rst_description":"Current level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.\n",
"name":"level",
"required":true
},
{
"type":"Integer",
"description":"Numerical value of the user's rating; the higher the rating, the better",
"html_description":"<td>Numerical value of the user's rating; the higher the rating, the better</td>",
"rst_description":"Numerical value of the user's rating; the higher the rating, the better\n",
"name":"rating",
"required":true
},
{
"type":"Integer",
"description":"The rating value required to get the current level",
"html_description":"<td>The rating value required to get the current level</td>",
"rst_description":"The rating value required to get the current level\n",
"name":"current_level_rating",
"required":true
},
{
"type":"Integer",
"description":"The rating value required to get to the next level; omitted if the maximum level was reached",
"html_description":"<td><em>Optional</em>. The rating value required to get to the next level; omitted if the maximum level was reached</td>",
"rst_description":"*Optional*. The rating value required to get to the next level; omitted if the maximum level was reached\n",
"description":"Describes the position of a clickable area within a story.",
"html_description":"<p>Describes the position of a clickable area within a story.</p>",
"rst_description":"Describes the position of a clickable area within a story.",
"annotations":[
{
"type":"Float",
"description":"The abscissa of the area's center, as a percentage of the media width",
"html_description":"<td>The abscissa of the area's center, as a percentage of the media width</td>",
"rst_description":"The abscissa of the area's center, as a percentage of the media width\n",
"name":"x_percentage",
"required":true
},
{
"type":"Float",
"description":"The ordinate of the area's center, as a percentage of the media height",
"html_description":"<td>The ordinate of the area's center, as a percentage of the media height</td>",
"rst_description":"The ordinate of the area's center, as a percentage of the media height\n",
"name":"y_percentage",
"required":true
},
{
"type":"Float",
"description":"The width of the area's rectangle, as a percentage of the media width",
"html_description":"<td>The width of the area's rectangle, as a percentage of the media width</td>",
"rst_description":"The width of the area's rectangle, as a percentage of the media width\n",
"name":"width_percentage",
"required":true
},
{
"type":"Float",
"description":"The height of the area's rectangle, as a percentage of the media height",
"html_description":"<td>The height of the area's rectangle, as a percentage of the media height</td>",
"rst_description":"The height of the area's rectangle, as a percentage of the media height\n",
"name":"height_percentage",
"required":true
},
{
"type":"Float",
"description":"The clockwise rotation angle of the rectangle, in degrees; 0-360",
"html_description":"<td>The clockwise rotation angle of the rectangle, in degrees; 0-360</td>",
"rst_description":"The clockwise rotation angle of the rectangle, in degrees; 0-360\n",
"name":"rotation_angle",
"required":true
},
{
"type":"Float",
"description":"The radius of the rectangle corner rounding, as a percentage of the media width",
"html_description":"<td>The radius of the rectangle corner rounding, as a percentage of the media width</td>",
"rst_description":"The radius of the rectangle corner rounding, as a percentage of the media width\n",
"name":"corner_radius_percentage",
"required":true
}
],
"category":"types"
},
{
"anchor":"locationaddress",
"name":"LocationAddress",
"description":"Describes the physical address of a location.",
"html_description":"<p>Describes the physical address of a location.</p>",
"rst_description":"Describes the physical address of a location.",
"annotations":[
{
"type":"String",
"description":"The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located",
"html_description":"<td>The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located</td>",
"rst_description":"The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located\n",
"name":"country_code",
"required":true
},
{
"type":"String",
"description":"State of the location",
"html_description":"<td><em>Optional</em>. State of the location</td>",
"rst_description":"*Optional*. State of the location\n",
"name":"state",
"required":false
},
{
"type":"String",
"description":"City of the location",
"html_description":"<td><em>Optional</em>. City of the location</td>",
"rst_description":"*Optional*. City of the location\n",
"name":"city",
"required":false
},
{
"type":"String",
"description":"Street address of the location",
"html_description":"<td><em>Optional</em>. Street address of the location</td>",
"rst_description":"*Optional*. Street address of the location\n",
"name":"street",
"required":false
}
],
"category":"types"
},
{
"anchor":"storyareatype",
"name":"StoryAreaType",
"description":"Describes the type of a clickable area on a story. Currently, it can be one of\n - StoryAreaTypeLocation\n - StoryAreaTypeSuggestedReaction\n - StoryAreaTypeLink\n - StoryAreaTypeWeather\n - StoryAreaTypeUniqueGift",
"html_description":"<p>Describes the type of a clickable area on a story. Currently, it can be one of</p><ul>\n<li><a href=\"#storyareatypelocation\">StoryAreaTypeLocation</a></li>\n<li><a href=\"#storyareatypesuggestedreaction\">StoryAreaTypeSuggestedReaction</a></li>\n<li><a href=\"#storyareatypelink\">StoryAreaTypeLink</a></li>\n<li><a href=\"#storyareatypeweather\">StoryAreaTypeWeather</a></li>\n<li><a href=\"#storyareatypeuniquegift\">StoryAreaTypeUniqueGift</a></li>\n</ul>",
"rst_description":"Describes the type of a clickable area on a story. Currently, it can be one of\n\n - :class:`aiogram.types.story_area_type_location.StoryAreaTypeLocation`\n - :class:`aiogram.types.story_area_type_suggested_reaction.StoryAreaTypeSuggestedReaction`\n - :class:`aiogram.types.story_area_type_link.StoryAreaTypeLink`\n - :class:`aiogram.types.story_area_type_weather.StoryAreaTypeWeather`\n - :class:`aiogram.types.story_area_type_unique_gift.StoryAreaTypeUniqueGift`",
"annotations":[],
"category":"types"
},
{
"anchor":"storyareatypelocation",
"name":"StoryAreaTypeLocation",
"description":"Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.",
"html_description":"<p>Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.</p>",
"rst_description":"Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.",
"annotations":[
{
"type":"String",
"description":"Type of the area, always 'location'",
"html_description":"<td>Type of the area, always “location”</td>",
"rst_description":"Type of the area, always 'location'\n",
"name":"type",
"required":true
},
{
"type":"Float",
"description":"Location latitude in degrees",
"html_description":"<td>Location latitude in degrees</td>",
"rst_description":"Location latitude in degrees\n",
"name":"latitude",
"required":true
},
{
"type":"Float",
"description":"Location longitude in degrees",
"html_description":"<td>Location longitude in degrees</td>",
"rst_description":"Location longitude in degrees\n",
"name":"longitude",
"required":true
},
{
"type":"LocationAddress",
"description":"Address of the location",
"html_description":"<td><em>Optional</em>. Address of the location</td>",
"rst_description":"*Optional*. Address of the location\n",
"name":"address",
"required":false
}
],
"category":"types"
},
{
"anchor":"storyareatypesuggestedreaction",
"name":"StoryAreaTypeSuggestedReaction",
"description":"Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.",
"html_description":"<p>Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.</p>",
"rst_description":"Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.",
"annotations":[
{
"type":"String",
"description":"Type of the area, always 'suggested_reaction'",
"html_description":"<td>Type of the area, always “suggested_reaction”</td>",
"rst_description":"Type of the area, always 'suggested_reaction'\n",
"name":"type",
"required":true
},
{
"type":"ReactionType",
"description":"Type of the reaction",
"html_description":"<td>Type of the reaction</td>",
"rst_description":"Type of the reaction\n",
"name":"reaction_type",
"required":true
},
{
"type":"Boolean",
"description":"Pass True if the reaction area has a dark background",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the reaction area has a dark background</td>",
"rst_description":"*Optional*. Pass :code:`True` if the reaction area has a dark background\n",
"name":"is_dark",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if reaction area corner is flipped",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if reaction area corner is flipped</td>",
"rst_description":"*Optional*. Pass :code:`True` if reaction area corner is flipped\n",
"name":"is_flipped",
"required":false
}
],
"category":"types"
},
{
"anchor":"storyareatypelink",
"name":"StoryAreaTypeLink",
"description":"Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.",
"html_description":"<p>Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.</p>",
"rst_description":"Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.",
"annotations":[
{
"type":"String",
"description":"Type of the area, always 'link'",
"html_description":"<td>Type of the area, always “link”</td>",
"rst_description":"Type of the area, always 'link'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"HTTP or tg:// URL to be opened when the area is clicked",
"html_description":"<td>HTTP or tg:// URL to be opened when the area is clicked</td>",
"rst_description":"HTTP or tg:// URL to be opened when the area is clicked\n",
"name":"url",
"required":true
}
],
"category":"types"
},
{
"anchor":"storyareatypeweather",
"name":"StoryAreaTypeWeather",
"description":"Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.",
"html_description":"<p>Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.</p>",
"rst_description":"Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.",
"annotations":[
{
"type":"String",
"description":"Type of the area, always 'weather'",
"html_description":"<td>Type of the area, always “weather”</td>",
"rst_description":"Type of the area, always 'weather'\n",
"name":"type",
"required":true
},
{
"type":"Float",
"description":"Temperature, in degree Celsius",
"html_description":"<td>Temperature, in degree Celsius</td>",
"rst_description":"Temperature, in degree Celsius\n",
"name":"temperature",
"required":true
},
{
"type":"String",
"description":"Emoji representing the weather",
"html_description":"<td>Emoji representing the weather</td>",
"rst_description":"Emoji representing the weather\n",
"name":"emoji",
"required":true
},
{
"type":"Integer",
"description":"A color of the area background in the ARGB format",
"html_description":"<td>A color of the area background in the ARGB format</td>",
"rst_description":"A color of the area background in the ARGB format\n",
"name":"background_color",
"required":true
}
],
"category":"types"
},
{
"anchor":"storyareatypeuniquegift",
"name":"StoryAreaTypeUniqueGift",
"description":"Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.",
"html_description":"<p>Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.</p>",
"rst_description":"Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.",
"annotations":[
{
"type":"String",
"description":"Type of the area, always 'unique_gift'",
"html_description":"<td>Type of the area, always “unique_gift”</td>",
"rst_description":"Type of the area, always 'unique_gift'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique name of the gift",
"html_description":"<td>Unique name of the gift</td>",
"rst_description":"Unique name of the gift\n",
"name":"name",
"required":true
}
],
"category":"types"
},
{
"anchor":"storyarea",
"name":"StoryArea",
"description":"Describes a clickable area on a story media.",
"html_description":"<p>Describes a clickable area on a story media.</p>",
"rst_description":"Describes a clickable area on a story media.",
"annotations":[
{
"type":"StoryAreaPosition",
"description":"Position of the area",
"html_description":"<td>Position of the area</td>",
"description":"This object describes the type of a reaction. Currently, it can be one of\n - ReactionTypeEmoji\n - ReactionTypeCustomEmoji\n - ReactionTypePaid",
"html_description":"<p>This object describes the type of a reaction. Currently, it can be one of</p><ul>\n<li><a href=\"#reactiontypeemoji\">ReactionTypeEmoji</a></li>\n<li><a href=\"#reactiontypecustomemoji\">ReactionTypeCustomEmoji</a></li>\n<li><a href=\"#reactiontypepaid\">ReactionTypePaid</a></li>\n</ul>",
"rst_description":"This object describes the type of a reaction. Currently, it can be one of\n\n - :class:`aiogram.types.reaction_type_emoji.ReactionTypeEmoji`\n - :class:`aiogram.types.reaction_type_custom_emoji.ReactionTypeCustomEmoji`\n - :class:`aiogram.types.reaction_type_paid.ReactionTypePaid`",
"description":"True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot</td>",
"rst_description":"*Optional*. :code:`True`, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot\n",
"name":"is_name_implicit",
"required":false
}
],
"category":"types"
},
{
"anchor":"giftbackground",
"name":"GiftBackground",
"description":"This object describes the background of a gift.",
"html_description":"<p>This object describes the background of a gift.</p>",
"rst_description":"This object describes the background of a gift.",
"annotations":[
{
"type":"Integer",
"description":"Center color of the background in RGB format",
"html_description":"<td>Center color of the background in RGB format</td>",
"rst_description":"Center color of the background in RGB format\n",
"name":"center_color",
"required":true
},
{
"type":"Integer",
"description":"Edge color of the background in RGB format",
"html_description":"<td>Edge color of the background in RGB format</td>",
"rst_description":"Edge color of the background in RGB format\n",
"name":"edge_color",
"required":true
},
{
"type":"Integer",
"description":"Text color of the background in RGB format",
"html_description":"<td>Text color of the background in RGB format</td>",
"rst_description":"Text color of the background in RGB format\n",
"description":"Rarity of the model if it is a crafted model. Currently, can be 'uncommon', 'rare', 'epic', or 'legendary'.",
"html_description":"<td><em>Optional</em>. Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”.</td>",
"rst_description":"*Optional*. Rarity of the model if it is a crafted model. Currently, can be 'uncommon', 'rare', 'epic', or 'legendary'.\n",
"description":"This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.",
"html_description":"<p>This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.</p>",
"rst_description":"This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.",
"annotations":[
{
"type":"String",
"description":"Custom emoji identifier of the unique gift's model",
"html_description":"<td>Custom emoji identifier of the unique gift's model</td>",
"rst_description":"Custom emoji identifier of the unique gift's model\n",
"name":"model_custom_emoji_id",
"required":true
},
{
"type":"String",
"description":"Custom emoji identifier of the unique gift's symbol",
"html_description":"<td>Custom emoji identifier of the unique gift's symbol</td>",
"rst_description":"Custom emoji identifier of the unique gift's symbol\n",
"name":"symbol_custom_emoji_id",
"required":true
},
{
"type":"Integer",
"description":"Main color used in light themes; RGB format",
"html_description":"<td>Main color used in light themes; RGB format</td>",
"rst_description":"Main color used in light themes; RGB format\n",
"name":"light_theme_main_color",
"required":true
},
{
"type":"Array of Integer",
"description":"List of 1-3 additional colors used in light themes; RGB format",
"html_description":"<td>List of 1-3 additional colors used in light themes; RGB format</td>",
"rst_description":"List of 1-3 additional colors used in light themes; RGB format\n",
"name":"light_theme_other_colors",
"required":true
},
{
"type":"Integer",
"description":"Main color used in dark themes; RGB format",
"html_description":"<td>Main color used in dark themes; RGB format</td>",
"rst_description":"Main color used in dark themes; RGB format\n",
"name":"dark_theme_main_color",
"required":true
},
{
"type":"Array of Integer",
"description":"List of 1-3 additional colors used in dark themes; RGB format",
"html_description":"<td>List of 1-3 additional colors used in dark themes; RGB format</td>",
"rst_description":"List of 1-3 additional colors used in dark themes; RGB format\n",
"description":"True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers</td>",
"rst_description":"*Optional*. :code:`True`, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers\n",
"description":"True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
"rst_description":"*Optional*. :code:`True`, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
"name":"is_from_blockchain",
"required":false
},
{
"type":"UniqueGiftColors",
"description":"The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only",
"html_description":"<td><em>Optional</em>. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only</td>",
"rst_description":"*Optional*. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only\n",
"description":"Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
"html_description":"<td><em>Optional</em>. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts</td>",
"rst_description":"*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts\n",
"name":"owned_gift_id",
"required":false
},
{
"type":"Integer",
"description":"Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible",
"html_description":"<td><em>Optional</em>. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible</td>",
"rst_description":"*Optional*. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description":"*Optional*. :code:`True`, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"description":"Unique number reserved for this gift when upgraded. See the number field in UniqueGift",
"html_description":"<td><em>Optional</em>. Unique number reserved for this gift when upgraded. See the <em>number</em> field in <a href=\"#uniquegift\">UniqueGift</a></td>",
"rst_description":"*Optional*. Unique number reserved for this gift when upgraded. See the *number* field in :class:`aiogram.types.unique_gift.UniqueGift`\n",
"description":"Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, 'resale' for gifts bought from other users, 'gifted_upgrade' for upgrades purchased after the gift was sent, or 'offer' for gifts bought or sold through gift purchase offers",
"html_description":"<td>Origin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers</td>",
"rst_description":"Origin of the gift. Currently, either 'upgrade' for gifts upgraded from regular gifts, 'transfer' for gifts transferred from other users or channels, 'resale' for gifts bought from other users, 'gifted_upgrade' for upgrades purchased after the gift was sent, or 'offer' for gifts bought or sold through gift purchase offers\n",
"description":"For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins.",
"html_description":"<td><em>Optional</em>. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.</td>",
"rst_description":"*Optional*. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of 'XTR' for Telegram Stars or 'TON' for toncoins.\n",
"description":"For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins",
"html_description":"<td><em>Optional</em>. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins</td>",
"rst_description":"*Optional*. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins\n",
"description":"Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts",
"html_description":"<td><em>Optional</em>. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts</td>",
"rst_description":"*Optional*. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts\n",
"name":"owned_gift_id",
"required":false
},
{
"type":"Integer",
"description":"Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift",
"html_description":"<td><em>Optional</em>. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift</td>",
"rst_description":"*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift\n",
"description":"Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now",
"html_description":"<td><em>Optional</em>. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now</td>",
"rst_description":"*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now\n",
"description":"This object describes a gift received and owned by a user or a chat. Currently, it can be one of\n - OwnedGiftRegular\n - OwnedGiftUnique",
"html_description":"<p>This object describes a gift received and owned by a user or a chat. Currently, it can be one of</p><ul>\n<li><a href=\"#ownedgiftregular\">OwnedGiftRegular</a></li>\n<li><a href=\"#ownedgiftunique\">OwnedGiftUnique</a></li>\n</ul>",
"rst_description":"This object describes a gift received and owned by a user or a chat. Currently, it can be one of\n\n - :class:`aiogram.types.owned_gift_regular.OwnedGiftRegular`\n - :class:`aiogram.types.owned_gift_unique.OwnedGiftUnique`",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them</td>",
"rst_description":"*Optional*. :code:`True`, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. :code:`True`, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. :code:`True`, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only\n",
"description":"Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only",
"html_description":"<td><em>Optional</em>. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only\n",
"description":"True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. :code:`True`, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only\n",
"name":"is_upgrade_separate",
"required":false
},
{
"type":"Integer",
"description":"Unique number reserved for this gift when upgraded. See the number field in UniqueGift",
"html_description":"<td><em>Optional</em>. Unique number reserved for this gift when upgraded. See the <em>number</em> field in <a href=\"#uniquegift\">UniqueGift</a></td>",
"rst_description":"*Optional*. Unique number reserved for this gift when upgraded. See the *number* field in :class:`aiogram.types.unique_gift.UniqueGift`\n",
"description":"Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only",
"html_description":"<td><em>Optional</em>. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only\n",
"name":"owned_gift_id",
"required":false
},
{
"type":"User",
"description":"Sender of the gift if it is a known user",
"html_description":"<td><em>Optional</em>. Sender of the gift if it is a known user</td>",
"rst_description":"*Optional*. Sender of the gift if it is a known user\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. :code:`True`, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only</td>",
"rst_description":"*Optional*. :code:`True`, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only\n",
"description":"Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift",
"html_description":"<td><em>Optional</em>. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift</td>",
"rst_description":"*Optional*. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift\n",
"description":"Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now",
"html_description":"<td><em>Optional</em>. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now</td>",
"rst_description":"*Optional*. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now\n",
"description":"The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive",
"html_description":"<td><em>Optional</em>. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if <em>amount</em> is non-positive</td>",
"rst_description":"*Optional*. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if *amount* is non-positive\n",
"description":"This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:\n - BotCommandScopeDefault\n - BotCommandScopeAllPrivateChats\n - BotCommandScopeAllGroupChats\n - BotCommandScopeAllChatAdministrators\n - BotCommandScopeChat\n - BotCommandScopeChatAdministrators\n - BotCommandScopeChatMember",
"html_description":"<p>This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:</p><ul>\n<li><a href=\"#botcommandscopedefault\">BotCommandScopeDefault</a></li>\n<li><a href=\"#botcommandscopeallprivatechats\">BotCommandScopeAllPrivateChats</a></li>\n<li><a href=\"#botcommandscopeallgroupchats\">BotCommandScopeAllGroupChats</a></li>\n<li><a href=\"#botcommandscopeallchatadministrators\">BotCommandScopeAllChatAdministrators</a></li>\n<li><a href=\"#botcommandscopechat\">BotCommandScopeChat</a></li>\n<li><a href=\"#botcommandscopechatadministrators\">BotCommandScopeChatAdministrators</a></li>\n<li><a href=\"#botcommandscopechatmember\">BotCommandScopeChatMember</a></li>\n</ul>",
"rst_description":"This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:\n\n - :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`\n - :class:`aiogram.types.bot_command_scope_all_private_chats.BotCommandScopeAllPrivateChats`\n - :class:`aiogram.types.bot_command_scope_all_group_chats.BotCommandScopeAllGroupChats`\n - :class:`aiogram.types.bot_command_scope_all_chat_administrators.BotCommandScopeAllChatAdministrators`\n - :class:`aiogram.types.bot_command_scope_chat.BotCommandScopeChat`\n - :class:`aiogram.types.bot_command_scope_chat_administrators.BotCommandScopeChatAdministrators`\n - :class:`aiogram.types.bot_command_scope_chat_member.BotCommandScopeChatMember`",
"annotations":[],
"category":"types"
},
{
"anchor":"botcommandscopedefault",
"name":"BotCommandScopeDefault",
"description":"Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.",
"html_description":"<p>Represents the default <a href=\"#botcommandscope\">scope</a> of bot commands. Default commands are used if no commands with a <a href=\"#determining-list-of-commands\">narrower scope</a> are specified for the user.</p>",
"rst_description":"Represents the default `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands. Default commands are used if no commands with a `narrower scope <https://core.telegram.org/bots/api#determining-list-of-commands>`_ are specified for the user.",
"description":"Represents the scope of bot commands, covering all group and supergroup chats.",
"html_description":"<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all group and supergroup chats.</p>",
"rst_description":"Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all group and supergroup chats.",
"description":"Represents the scope of bot commands, covering all group and supergroup chat administrators.",
"html_description":"<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all group and supergroup chat administrators.</p>",
"rst_description":"Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all group and supergroup chat administrators.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>). Channel direct messages chats and channel chats aren't supported.</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"description":"Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.",
"html_description":"<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering all administrators of a specific group or supergroup chat.</p>",
"rst_description":"Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering all administrators of a specific group or supergroup chat.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>). Channel direct messages chats and channel chats aren't supported.</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"description":"Represents the scope of bot commands, covering a specific member of a group or supergroup chat.",
"html_description":"<p>Represents the <a href=\"#botcommandscope\">scope</a> of bot commands, covering a specific member of a group or supergroup chat.</p>",
"rst_description":"Represents the `scope <https://core.telegram.org/bots/api#botcommandscope>`_ of bot commands, covering a specific member of a group or supergroup chat.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel direct messages chats and channel chats aren't supported.",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>). Channel direct messages chats and channel chats aren't supported.</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel direct messages chats and channel chats aren't supported.\n",
"description":"This object represents the bot's short description.",
"html_description":"<p>This object represents the bot's short description.</p>",
"rst_description":"This object represents the bot's short description.",
"annotations":[
{
"type":"String",
"description":"The bot's short description",
"html_description":"<td>The bot's short description</td>",
"rst_description":"The bot's short description\n",
"name":"short_description",
"required":true
}
],
"category":"types"
},
{
"anchor":"menubutton",
"name":"MenuButton",
"description":"This object describes the bot's menu button in a private chat. It should be one of\n - MenuButtonCommands\n - MenuButtonWebApp\n - MenuButtonDefault\nIf a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.",
"html_description":"<p>This object describes the bot's menu button in a private chat. It should be one of</p><ul>\n<li><a href=\"#menubuttoncommands\">MenuButtonCommands</a></li>\n<li><a href=\"#menubuttonwebapp\">MenuButtonWebApp</a></li>\n<li><a href=\"#menubuttondefault\">MenuButtonDefault</a></li>\n</ul><p>If a menu button other than <a href=\"#menubuttondefault\">MenuButtonDefault</a> is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.</p>",
"rst_description":"This object describes the bot's menu button in a private chat. It should be one of\n\n - :class:`aiogram.types.menu_button_commands.MenuButtonCommands`\n - :class:`aiogram.types.menu_button_web_app.MenuButtonWebApp`\n - :class:`aiogram.types.menu_button_default.MenuButtonDefault`\n\nIf a menu button other than :class:`aiogram.types.menu_button_default.MenuButtonDefault` is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.",
"annotations":[],
"category":"types"
},
{
"anchor":"menubuttoncommands",
"name":"MenuButtonCommands",
"description":"Represents a menu button, which opens the bot's list of commands.",
"html_description":"<p>Represents a menu button, which opens the bot's list of commands.</p>",
"rst_description":"Represents a menu button, which opens the bot's list of commands.",
"annotations":[
{
"type":"String",
"description":"Type of the button, must be commands",
"html_description":"<td>Type of the button, must be <em>commands</em></td>",
"rst_description":"Type of the button, must be *commands*\n",
"name":"type",
"required":true
}
],
"category":"types"
},
{
"anchor":"menubuttonwebapp",
"name":"MenuButtonWebApp",
"description":"Represents a menu button, which launches a Web App.",
"html_description":"<p>Represents a menu button, which launches a <a href=\"/bots/webapps\">Web App</a>.</p>",
"rst_description":"Represents a menu button, which launches a `Web App <https://core.telegram.org/bots/webapps>`_.",
"annotations":[
{
"type":"String",
"description":"Type of the button, must be web_app",
"html_description":"<td>Type of the button, must be <em>web_app</em></td>",
"rst_description":"Type of the button, must be *web_app*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Text on the button",
"html_description":"<td>Text on the button</td>",
"rst_description":"Text on the button\n",
"name":"text",
"required":true
},
{
"type":"WebAppInfo",
"description":"Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.",
"html_description":"<td>Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method <a href=\"#answerwebappquery\">answerWebAppQuery</a>. Alternatively, a <code>t.me</code> link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.</td>",
"rst_description":"Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method :class:`aiogram.methods.answer_web_app_query.AnswerWebAppQuery`. Alternatively, a :code:`t.me` link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.\n",
"name":"web_app",
"required":true
}
],
"category":"types"
},
{
"anchor":"menubuttondefault",
"name":"MenuButtonDefault",
"description":"Describes that no specific value for the menu button was set.",
"html_description":"<p>Describes that no specific value for the menu button was set.</p>",
"rst_description":"Describes that no specific value for the menu button was set.",
"annotations":[
{
"type":"String",
"description":"Type of the button, must be default",
"html_description":"<td>Type of the button, must be <em>default</em></td>",
"rst_description":"Type of the button, must be *default*\n",
"name":"type",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatboostsource",
"name":"ChatBoostSource",
"description":"This object describes the source of a chat boost. It can be one of\n - ChatBoostSourcePremium\n - ChatBoostSourceGiftCode\n - ChatBoostSourceGiveaway",
"html_description":"<p>This object describes the source of a chat boost. It can be one of</p><ul>\n<li><a href=\"#chatboostsourcepremium\">ChatBoostSourcePremium</a></li>\n<li><a href=\"#chatboostsourcegiftcode\">ChatBoostSourceGiftCode</a></li>\n<li><a href=\"#chatboostsourcegiveaway\">ChatBoostSourceGiveaway</a></li>\n</ul>",
"rst_description":"This object describes the source of a chat boost. It can be one of\n\n - :class:`aiogram.types.chat_boost_source_premium.ChatBoostSourcePremium`\n - :class:`aiogram.types.chat_boost_source_gift_code.ChatBoostSourceGiftCode`\n - :class:`aiogram.types.chat_boost_source_giveaway.ChatBoostSourceGiveaway`",
"annotations":[],
"category":"types"
},
{
"anchor":"chatboostsourcepremium",
"name":"ChatBoostSourcePremium",
"description":"The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.",
"html_description":"<p>The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.</p>",
"rst_description":"The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.",
"annotations":[
{
"type":"String",
"description":"Source of the boost, always 'premium'",
"html_description":"<td>Source of the boost, always “premium”</td>",
"rst_description":"Source of the boost, always 'premium'\n",
"name":"source",
"required":true
},
{
"type":"User",
"description":"User that boosted the chat",
"html_description":"<td>User that boosted the chat</td>",
"rst_description":"User that boosted the chat\n",
"name":"user",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatboostsourcegiftcode",
"name":"ChatBoostSourceGiftCode",
"description":"The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
"html_description":"<p>The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.</p>",
"rst_description":"The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.",
"annotations":[
{
"type":"String",
"description":"Source of the boost, always 'gift_code'",
"html_description":"<td>Source of the boost, always “gift_code”</td>",
"rst_description":"Source of the boost, always 'gift_code'\n",
"name":"source",
"required":true
},
{
"type":"User",
"description":"User for which the gift code was created",
"html_description":"<td>User for which the gift code was created</td>",
"rst_description":"User for which the gift code was created\n",
"name":"user",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatboostsourcegiveaway",
"name":"ChatBoostSourceGiveaway",
"description":"The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.",
"html_description":"<p>The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and <em>prize_star_count</em> / 500 times for one year for Telegram Star giveaways.</p>",
"rst_description":"The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize_star_count* / 500 times for one year for Telegram Star giveaways.",
"annotations":[
{
"type":"String",
"description":"Source of the boost, always 'giveaway'",
"html_description":"<td>Source of the boost, always “giveaway”</td>",
"rst_description":"Source of the boost, always 'giveaway'\n",
"name":"source",
"required":true
},
{
"type":"Integer",
"description":"Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.",
"html_description":"<td>Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.</td>",
"rst_description":"Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.\n",
"name":"giveaway_message_id",
"required":true
},
{
"type":"User",
"description":"User that won the prize in the giveaway if any; for Telegram Premium giveaways only",
"html_description":"<td><em>Optional</em>. User that won the prize in the giveaway if any; for Telegram Premium giveaways only</td>",
"rst_description":"*Optional*. User that won the prize in the giveaway if any; for Telegram Premium giveaways only\n",
"name":"user",
"required":false
},
{
"type":"Integer",
"description":"The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only",
"html_description":"<td><em>Optional</em>. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only</td>",
"rst_description":"*Optional*. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only\n",
"name":"prize_star_count",
"required":false
},
{
"type":"True",
"description":"True, if the giveaway was completed, but there was no user to win the prize",
"description":"This object contains information about a chat boost.",
"html_description":"<p>This object contains information about a chat boost.</p>",
"rst_description":"This object contains information about a chat boost.",
"annotations":[
{
"type":"String",
"description":"Unique identifier of the boost",
"html_description":"<td>Unique identifier of the boost</td>",
"rst_description":"Unique identifier of the boost\n",
"name":"boost_id",
"required":true
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when the chat was boosted",
"html_description":"<td>Point in time (Unix timestamp) when the chat was boosted</td>",
"rst_description":"Point in time (Unix timestamp) when the chat was boosted\n",
"name":"add_date",
"required":true
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged",
"html_description":"<td>Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged</td>",
"rst_description":"Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged\n",
"name":"expiration_date",
"required":true
},
{
"type":"ChatBoostSource",
"description":"Source of the added boost",
"html_description":"<td>Source of the added boost</td>",
"rst_description":"Source of the added boost\n",
"name":"source",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatboostupdated",
"name":"ChatBoostUpdated",
"description":"This object represents a boost added to a chat or changed.",
"html_description":"<p>This object represents a boost added to a chat or changed.</p>",
"rst_description":"This object represents a boost added to a chat or changed.",
"annotations":[
{
"type":"Chat",
"description":"Chat which was boosted",
"html_description":"<td>Chat which was boosted</td>",
"rst_description":"Chat which was boosted\n",
"name":"chat",
"required":true
},
{
"type":"ChatBoost",
"description":"Information about the chat boost",
"html_description":"<td>Information about the chat boost</td>",
"rst_description":"Information about the chat boost\n",
"name":"boost",
"required":true
}
],
"category":"types"
},
{
"anchor":"chatboostremoved",
"name":"ChatBoostRemoved",
"description":"This object represents a boost removed from a chat.",
"html_description":"<p>This object represents a boost removed from a chat.</p>",
"rst_description":"This object represents a boost removed from a chat.",
"annotations":[
{
"type":"Chat",
"description":"Chat which was boosted",
"html_description":"<td>Chat which was boosted</td>",
"rst_description":"Chat which was boosted\n",
"name":"chat",
"required":true
},
{
"type":"String",
"description":"Unique identifier of the boost",
"html_description":"<td>Unique identifier of the boost</td>",
"rst_description":"Unique identifier of the boost\n",
"name":"boost_id",
"required":true
},
{
"type":"Integer",
"description":"Point in time (Unix timestamp) when the boost was removed",
"html_description":"<td>Point in time (Unix timestamp) when the boost was removed</td>",
"rst_description":"Point in time (Unix timestamp) when the boost was removed\n",
"name":"remove_date",
"required":true
},
{
"type":"ChatBoostSource",
"description":"Source of the removed boost",
"html_description":"<td>Source of the removed boost</td>",
"rst_description":"Source of the removed boost\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can change the privacy settings pertaining to gifts for the business account</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can change the privacy settings pertaining to gifts for the business account\n",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can view gifts and the amount of Telegram Stars owned by the business account</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can view gifts and the amount of Telegram Stars owned by the business account\n",
"description":"True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts</td>",
"rst_description":"*Optional*. :code:`True`, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts\n",
"description":"Describes the connection of the bot with a business account.",
"html_description":"<p>Describes the connection of the bot with a business account.</p>",
"rst_description":"Describes the connection of the bot with a business account.",
"annotations":[
{
"type":"String",
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"id",
"required":true
},
{
"type":"User",
"description":"Business account user that created the business connection",
"html_description":"<td>Business account user that created the business connection</td>",
"rst_description":"Business account user that created the business connection\n",
"name":"user",
"required":true
},
{
"type":"Integer",
"description":"Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td>Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"user_chat_id",
"required":true
},
{
"type":"Integer",
"description":"Date the connection was established in Unix time",
"html_description":"<td>Date the connection was established in Unix time</td>",
"rst_description":"Date the connection was established in Unix time\n",
"name":"date",
"required":true
},
{
"type":"BusinessBotRights",
"description":"Rights of the business bot",
"html_description":"<td><em>Optional</em>. Rights of the business bot</td>",
"rst_description":"*Optional*. Rights of the business bot\n",
"name":"rights",
"required":false
},
{
"type":"Boolean",
"description":"True, if the connection is active",
"description":"This object is received when messages are deleted from a connected business account.",
"html_description":"<p>This object is received when messages are deleted from a connected business account.</p>",
"rst_description":"This object is received when messages are deleted from a connected business account.",
"annotations":[
{
"type":"String",
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id",
"required":true
},
{
"type":"Chat",
"description":"Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.",
"html_description":"<td>Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.</td>",
"rst_description":"Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.\n",
"name":"chat",
"required":true
},
{
"type":"Array of Integer",
"description":"The list of identifiers of deleted messages in the chat of the business account",
"html_description":"<td>The list of identifiers of deleted messages in the chat of the business account</td>",
"rst_description":"The list of identifiers of deleted messages in the chat of the business account\n",
"name":"message_ids",
"required":true
}
],
"category":"types"
},
{
"anchor":"responseparameters",
"name":"ResponseParameters",
"description":"Describes why a request was unsuccessful.",
"html_description":"<p>Describes why a request was unsuccessful.</p>",
"rst_description":"Describes why a request was unsuccessful.",
"annotations":[
{
"type":"Integer",
"description":"The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.",
"html_description":"<td><em>Optional</em>. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.</td>",
"rst_description":"*Optional*. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.\n",
"name":"migrate_to_chat_id",
"required":false
},
{
"type":"Integer",
"description":"In case of exceeding flood control, the number of seconds left to wait before the request can be repeated",
"html_description":"<td><em>Optional</em>. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated</td>",
"rst_description":"*Optional*. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated\n",
"name":"retry_after",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmedia",
"name":"InputMedia",
"description":"This object represents the content of a media message to be sent. It should be one of\n - InputMediaAnimation\n - InputMediaDocument\n - InputMediaAudio\n - InputMediaPhoto\n - InputMediaVideo",
"html_description":"<p>This object represents the content of a media message to be sent. It should be one of</p><ul>\n<li><a href=\"#inputmediaanimation\">InputMediaAnimation</a></li>\n<li><a href=\"#inputmediadocument\">InputMediaDocument</a></li>\n<li><a href=\"#inputmediaaudio\">InputMediaAudio</a></li>\n<li><a href=\"#inputmediaphoto\">InputMediaPhoto</a></li>\n<li><a href=\"#inputmediavideo\">InputMediaVideo</a></li>\n</ul>",
"rst_description":"This object represents the content of a media message to be sent. It should be one of\n\n - :class:`aiogram.types.input_media_animation.InputMediaAnimation`\n - :class:`aiogram.types.input_media_document.InputMediaDocument`\n - :class:`aiogram.types.input_media_audio.InputMediaAudio`\n - :class:`aiogram.types.input_media_photo.InputMediaPhoto`\n - :class:`aiogram.types.input_media_video.InputMediaVideo`",
"annotations":[],
"category":"types"
},
{
"anchor":"inputmediaphoto",
"name":"InputMediaPhoto",
"description":"Represents a photo to be sent.",
"html_description":"<p>Represents a photo to be sent.</p>",
"rst_description":"Represents a photo to be sent.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be photo",
"html_description":"<td>Type of the result, must be <em>photo</em></td>",
"rst_description":"Type of the result, must be *photo*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"description":"Caption of the photo to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the photo caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Boolean",
"description":"Pass True, if the caption must be shown above the message media",
"html_description":"<td><em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media</td>",
"rst_description":"*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
"name":"show_caption_above_media",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the photo needs to be covered with a spoiler animation",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the photo needs to be covered with a spoiler animation</td>",
"rst_description":"*Optional*. Pass :code:`True` if the photo needs to be covered with a spoiler animation\n",
"name":"has_spoiler",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmediavideo",
"name":"InputMediaVideo",
"description":"Represents a video to be sent.",
"html_description":"<p>Represents a video to be sent.</p>",
"rst_description":"Represents a video to be sent.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be video",
"html_description":"<td>Type of the result, must be <em>video</em></td>",
"rst_description":"Type of the result, must be *video*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. 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>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail",
"required":false
},
{
"type":"String",
"description":"Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td><em>Optional</em>. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"cover",
"required":false
},
{
"type":"Integer",
"description":"Start timestamp for the video in the message",
"html_description":"<td><em>Optional</em>. Start timestamp for the video in the message</td>",
"rst_description":"*Optional*. Start timestamp for the video in the message\n",
"name":"start_timestamp",
"required":false
},
{
"type":"String",
"description":"Caption of the video to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the video to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the video caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the video caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the video caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Boolean",
"description":"Pass True, if the caption must be shown above the message media",
"html_description":"<td><em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media</td>",
"rst_description":"*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
"name":"show_caption_above_media",
"required":false
},
{
"type":"Integer",
"description":"Video width",
"html_description":"<td><em>Optional</em>. Video width</td>",
"rst_description":"*Optional*. Video width\n",
"name":"width",
"required":false
},
{
"type":"Integer",
"description":"Video height",
"html_description":"<td><em>Optional</em>. Video height</td>",
"rst_description":"*Optional*. Video height\n",
"name":"height",
"required":false
},
{
"type":"Integer",
"description":"Video duration in seconds",
"html_description":"<td><em>Optional</em>. Video duration in seconds</td>",
"rst_description":"*Optional*. Video duration in seconds\n",
"name":"duration",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the uploaded video is suitable for streaming",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the uploaded video is suitable for streaming</td>",
"rst_description":"*Optional*. Pass :code:`True` if the uploaded video is suitable for streaming\n",
"name":"supports_streaming",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the video needs to be covered with a spoiler animation",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the video needs to be covered with a spoiler animation</td>",
"rst_description":"*Optional*. Pass :code:`True` if the video needs to be covered with a spoiler animation\n",
"name":"has_spoiler",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmediaanimation",
"name":"InputMediaAnimation",
"description":"Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.",
"html_description":"<p>Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.</p>",
"rst_description":"Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be animation",
"html_description":"<td>Type of the result, must be <em>animation</em></td>",
"rst_description":"Type of the result, must be *animation*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. 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>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail",
"required":false
},
{
"type":"String",
"description":"Caption of the animation to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the animation to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the animation to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the animation caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the animation caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the animation caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Boolean",
"description":"Pass True, if the caption must be shown above the message media",
"html_description":"<td><em>Optional</em>. Pass <em>True</em>, if the caption must be shown above the message media</td>",
"rst_description":"*Optional*. Pass :code:`True`, if the caption must be shown above the message media\n",
"html_description":"<td><em>Optional</em>. Animation duration in seconds</td>",
"rst_description":"*Optional*. Animation duration in seconds\n",
"name":"duration",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the animation needs to be covered with a spoiler animation",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the animation needs to be covered with a spoiler animation</td>",
"rst_description":"*Optional*. Pass :code:`True` if the animation needs to be covered with a spoiler animation\n",
"name":"has_spoiler",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmediaaudio",
"name":"InputMediaAudio",
"description":"Represents an audio file to be treated as music to be sent.",
"html_description":"<p>Represents an audio file to be treated as music to be sent.</p>",
"rst_description":"Represents an audio file to be treated as music to be sent.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be audio",
"html_description":"<td>Type of the result, must be <em>audio</em></td>",
"rst_description":"Type of the result, must be *audio*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. 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>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail",
"required":false
},
{
"type":"String",
"description":"Caption of the audio to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the audio to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the audio to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the audio caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Integer",
"description":"Duration of the audio in seconds",
"html_description":"<td><em>Optional</em>. Duration of the audio in seconds</td>",
"rst_description":"*Optional*. Duration of the audio in seconds\n",
"name":"duration",
"required":false
},
{
"type":"String",
"description":"Performer of the audio",
"html_description":"<td><em>Optional</em>. Performer of the audio</td>",
"rst_description":"*Optional*. Performer of the audio\n",
"name":"performer",
"required":false
},
{
"type":"String",
"description":"Title of the audio",
"html_description":"<td><em>Optional</em>. Title of the audio</td>",
"rst_description":"*Optional*. Title of the audio\n",
"name":"title",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmediadocument",
"name":"InputMediaDocument",
"description":"Represents a general file to be sent.",
"html_description":"<p>Represents a general file to be sent.</p>",
"rst_description":"Represents a general file to be sent.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be document",
"html_description":"<td>Type of the result, must be <em>document</em></td>",
"rst_description":"Type of the result, must be *document*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. 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>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail",
"required":false
},
{
"type":"String",
"description":"Caption of the document to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the document to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Boolean",
"description":"Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.",
"html_description":"<td><em>Optional</em>. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always <em>True</em>, if the document is sent as part of an album.</td>",
"rst_description":"*Optional*. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always :code:`True`, if the document is sent as part of an album.\n",
"name":"disable_content_type_detection",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputfile",
"name":"InputFile",
"description":"This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.",
"html_description":"<p>This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.</p>",
"rst_description":"This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.",
"annotations":[],
"category":"types"
},
{
"anchor":"inputpaidmedia",
"name":"InputPaidMedia",
"description":"This object describes the paid media to be sent. Currently, it can be one of\n - InputPaidMediaPhoto\n - InputPaidMediaVideo",
"html_description":"<p>This object describes the paid media to be sent. Currently, it can be one of</p><ul>\n<li><a href=\"#inputpaidmediaphoto\">InputPaidMediaPhoto</a></li>\n<li><a href=\"#inputpaidmediavideo\">InputPaidMediaVideo</a></li>\n</ul>",
"rst_description":"This object describes the paid media to be sent. Currently, it can be one of\n\n - :class:`aiogram.types.input_paid_media_photo.InputPaidMediaPhoto`\n - :class:`aiogram.types.input_paid_media_video.InputPaidMediaVideo`",
"annotations":[],
"category":"types"
},
{
"anchor":"inputpaidmediaphoto",
"name":"InputPaidMediaPhoto",
"description":"The paid media to send is a photo.",
"html_description":"<p>The paid media to send is a photo.</p>",
"rst_description":"The paid media to send is a photo.",
"annotations":[
{
"type":"String",
"description":"Type of the media, must be photo",
"html_description":"<td>Type of the media, must be <em>photo</em></td>",
"rst_description":"Type of the media, must be *photo*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
}
],
"category":"types"
},
{
"anchor":"inputpaidmediavideo",
"name":"InputPaidMediaVideo",
"description":"The paid media to send is a video.",
"html_description":"<p>The paid media to send is a video.</p>",
"rst_description":"The paid media to send is a video.",
"annotations":[
{
"type":"String",
"description":"Type of the media, must be video",
"html_description":"<td>Type of the media, must be <em>video</em></td>",
"rst_description":"Type of the media, must be *video*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"media",
"required":true
},
{
"type":"String",
"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",
"html_description":"<td><em>Optional</em>. 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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. 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>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail",
"required":false
},
{
"type":"String",
"description":"Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td><em>Optional</em>. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"*Optional*. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"cover",
"required":false
},
{
"type":"Integer",
"description":"Start timestamp for the video in the message",
"html_description":"<td><em>Optional</em>. Start timestamp for the video in the message</td>",
"rst_description":"*Optional*. Start timestamp for the video in the message\n",
"name":"start_timestamp",
"required":false
},
{
"type":"Integer",
"description":"Video width",
"html_description":"<td><em>Optional</em>. Video width</td>",
"rst_description":"*Optional*. Video width\n",
"name":"width",
"required":false
},
{
"type":"Integer",
"description":"Video height",
"html_description":"<td><em>Optional</em>. Video height</td>",
"rst_description":"*Optional*. Video height\n",
"name":"height",
"required":false
},
{
"type":"Integer",
"description":"Video duration in seconds",
"html_description":"<td><em>Optional</em>. Video duration in seconds</td>",
"rst_description":"*Optional*. Video duration in seconds\n",
"name":"duration",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the uploaded video is suitable for streaming",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the uploaded video is suitable for streaming</td>",
"rst_description":"*Optional*. Pass :code:`True` if the uploaded video is suitable for streaming\n",
"name":"supports_streaming",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputprofilephoto",
"name":"InputProfilePhoto",
"description":"This object describes a profile photo to set. Currently, it can be one of\n - InputProfilePhotoStatic\n - InputProfilePhotoAnimated",
"html_description":"<p>This object describes a profile photo to set. Currently, it can be one of</p><ul>\n<li><a href=\"#inputprofilephotostatic\">InputProfilePhotoStatic</a></li>\n<li><a href=\"#inputprofilephotoanimated\">InputProfilePhotoAnimated</a></li>\n</ul>",
"rst_description":"This object describes a profile photo to set. Currently, it can be one of\n\n - :class:`aiogram.types.input_profile_photo_static.InputProfilePhotoStatic`\n - :class:`aiogram.types.input_profile_photo_animated.InputProfilePhotoAnimated`",
"annotations":[],
"category":"types"
},
{
"anchor":"inputprofilephotostatic",
"name":"InputProfilePhotoStatic",
"description":"A static profile photo in the .JPG format.",
"html_description":"<p>A static profile photo in the .JPG format.</p>",
"rst_description":"A static profile photo in the .JPG format.",
"description":"The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description":"<td>The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"photo",
"required":true
}
],
"category":"types"
},
{
"anchor":"inputprofilephotoanimated",
"name":"InputProfilePhotoAnimated",
"description":"An animated profile photo in the MPEG4 format.",
"html_description":"<p>An animated profile photo in the MPEG4 format.</p>",
"rst_description":"An animated profile photo in the MPEG4 format.",
"description":"The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description":"<td>The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"animation",
"required":true
},
{
"type":"Float",
"description":"Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.",
"html_description":"<td><em>Optional</em>. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.</td>",
"rst_description":"*Optional*. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.\n",
"name":"main_frame_timestamp",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputstorycontent",
"name":"InputStoryContent",
"description":"This object describes the content of a story to post. Currently, it can be one of\n - InputStoryContentPhoto\n - InputStoryContentVideo",
"html_description":"<p>This object describes the content of a story to post. Currently, it can be one of</p><ul>\n<li><a href=\"#inputstorycontentphoto\">InputStoryContentPhoto</a></li>\n<li><a href=\"#inputstorycontentvideo\">InputStoryContentVideo</a></li>\n</ul>",
"rst_description":"This object describes the content of a story to post. Currently, it can be one of\n\n - :class:`aiogram.types.input_story_content_photo.InputStoryContentPhoto`\n - :class:`aiogram.types.input_story_content_video.InputStoryContentVideo`",
"annotations":[],
"category":"types"
},
{
"anchor":"inputstorycontentphoto",
"name":"InputStoryContentPhoto",
"description":"Describes a photo to post as a story.",
"html_description":"<p>Describes a photo to post as a story.</p>",
"rst_description":"Describes a photo to post as a story.",
"description":"The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description":"<td>The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"The photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the photo was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"photo",
"required":true
}
],
"category":"types"
},
{
"anchor":"inputstorycontentvideo",
"name":"InputStoryContentVideo",
"description":"Describes a video to post as a story.",
"html_description":"<p>Describes a video to post as a story.</p>",
"rst_description":"Describes a video to post as a story.",
"description":"The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description":"<td>The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the video was uploaded using multipart/form-data under <file_attach_name>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"The video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass 'attach://<file_attach_name>' if the video was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"video",
"required":true
},
{
"type":"Float",
"description":"Precise duration of the video in seconds; 0-60",
"html_description":"<td><em>Optional</em>. Precise duration of the video in seconds; 0-60</td>",
"rst_description":"*Optional*. Precise duration of the video in seconds; 0-60\n",
"name":"duration",
"required":false
},
{
"type":"Float",
"description":"Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.",
"html_description":"<td><em>Optional</em>. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.</td>",
"rst_description":"*Optional*. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.\n",
"name":"cover_frame_timestamp",
"required":false
},
{
"type":"Boolean",
"description":"Pass True if the video has no sound",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the video has no sound</td>",
"rst_description":"*Optional*. Pass :code:`True` if the video has no sound\n",
"name":"is_animation",
"required":false
}
],
"category":"types"
}
],
"description":"All types used in the Bot API responses are represented as JSON-objects.\nIt is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.\nOptional fields may be not returned when irrelevant."
},
{
"title":"Available methods",
"anchor":"available-methods",
"children":[
{
"anchor":"getme",
"name":"getMe",
"description":"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.",
"html_description":"<p>A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a <a href=\"#user\">User</a> object.</p>",
"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"
},
{
"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":"<p>Use this method to log out from the cloud Bot API server before launching the bot locally. You <strong>must</strong> 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 <em>True</em> on success. Requires no parameters.</p>",
"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"
},
{
"anchor":"close",
"name":"close",
"description":"Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.",
"html_description":"<p>Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns <em>True</em> on success. Requires no parameters.</p>",
"rst_description":"Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns :code:`True` on success. Requires no parameters.",
"annotations":[],
"category":"methods"
},
{
"anchor":"sendmessage",
"name":"sendMessage",
"description":"Use this method to send text messages. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send text messages. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to send text messages. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"annotations":[
{
"type":"String",
"required":false,
"description":"Unique identifier of the business connection on behalf of which the message will be sent",
"html_description":"<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
"rst_description":"Unique identifier of the business connection on behalf of which the message will be sent\n",
"name":"business_connection_id"
},
{
"type":"Integer or String",
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Text of the message to be sent, 1-4096 characters after entities parsing",
"html_description":"<td>Text of the message to be sent, 1-4096 characters after entities parsing</td>",
"rst_description":"Text of the message to be sent, 1-4096 characters after entities parsing\n",
"name":"text"
},
{
"type":"String",
"required":false,
"description":"Mode for parsing entities in the message text. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode"
},
{
"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":"<td>A JSON-serialized list of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
"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"
},
{
"type":"LinkPreviewOptions",
"required":false,
"description":"Link preview generation options for the message",
"html_description":"<td>Link preview generation options for the message</td>",
"rst_description":"Link preview generation options for the message\n",
"name":"link_preview_options"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"name":"protect_content"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"name":"allow_paid_broadcast"
},
{
"type":"String",
"required":false,
"description":"Unique identifier of the message effect to be added to the message; for private chats only",
"html_description":"<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
"rst_description":"Unique identifier of the message effect to be added to the message; for private chats only\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name":"reply_markup"
}
],
"category":"methods"
},
{
"anchor":"forwardmessage",
"name":"forwardMessage",
"description":"Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.",
"html_description":"<p>Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat\n",
"description":"Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"html_description":"<td>Unique identifier for the chat where the original message was sent (or channel username in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)\n",
"name":"from_chat_id"
},
{
"type":"Integer",
"required":false,
"description":"New start timestamp for the forwarded video in the message",
"html_description":"<td>New start timestamp for the forwarded video in the message</td>",
"rst_description":"New start timestamp for the forwarded video in the message\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.",
"html_description":"<p>Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of <a href=\"#messageid\">MessageId</a> of the sent messages is returned.</p>",
"rst_description":"Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of :class:`aiogram.types.message_id.MessageId` of the sent messages is returned.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat\n",
"description":"Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
"html_description":"<td>Unique identifier for the chat where the original messages were sent (or channel username in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the chat where the original messages were sent (or channel username in the format :code:`@channelusername`)\n",
"description":"A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.",
"html_description":"<td>A JSON-serialized list of 1-100 identifiers of messages in the chat <em>from_chat_id</em> to forward. The identifiers must be specified in a strictly increasing order.</td>",
"rst_description":"A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to forward. The identifiers must be specified in a strictly increasing order.\n",
"name":"message_ids"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the messages silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the forwarded messages from forwarding and saving",
"html_description":"<td>Protects the contents of the forwarded messages from forwarding and saving</td>",
"rst_description":"Protects the contents of the forwarded messages from forwarding and saving\n",
"name":"protect_content"
}
],
"category":"methods"
},
{
"anchor":"copymessage",
"name":"copyMessage",
"description":"Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
"html_description":"<p>Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessage\">forwardMessage</a>, but the copied message doesn't have a link to the original message. Returns the <a href=\"#messageid\">MessageId</a> of the sent message on success.</p>",
"rst_description":"Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_message.ForwardMessage`, but the copied message doesn't have a link to the original message. Returns the :class:`aiogram.types.message_id.MessageId` of the sent message 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"html_description":"<td>Unique identifier for the chat where the original message was sent (or channel username in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)\n",
"name":"from_chat_id"
},
{
"type":"Integer",
"required":true,
"description":"Message identifier in the chat specified in from_chat_id",
"html_description":"<td>Message identifier in the chat specified in <em>from_chat_id</em></td>",
"rst_description":"Message identifier in the chat specified in *from_chat_id*\n",
"name":"message_id"
},
{
"type":"Integer",
"required":false,
"description":"New start timestamp for the copied video in the message",
"html_description":"<td>New start timestamp for the copied video in the message</td>",
"rst_description":"New start timestamp for the copied video in the message\n",
"description":"Mode for parsing entities in the new caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the new caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the new caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode"
},
{
"type":"Array of MessageEntity",
"required":false,
"description":"A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.",
"html_description":"<td>Pass <em>True</em>, if the caption must be shown above the message media. Ignored if a new caption isn't specified.</td>",
"rst_description":"Pass :code:`True`, if the caption must be shown above the message media. Ignored if a new caption isn't specified.\n",
"name":"show_caption_above_media"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"name":"protect_content"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"name":"reply_markup"
}
],
"category":"methods"
},
{
"anchor":"copymessages",
"name":"copyMessages",
"description":"Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.",
"html_description":"<p>Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessages\">forwardMessages</a>, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of <a href=\"#messageid\">MessageId</a> of the sent messages is returned.</p>",
"rst_description":"Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_messages.ForwardMessages`, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of :class:`aiogram.types.message_id.MessageId` of the sent messages 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
"description":"Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
"html_description":"<td>Unique identifier for the chat where the original messages were sent (or channel username in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the chat where the original messages were sent (or channel username in the format :code:`@channelusername`)\n",
"description":"A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
"html_description":"<td>A JSON-serialized list of 1-100 identifiers of messages in the chat <em>from_chat_id</em> to copy. The identifiers must be specified in a strictly increasing order.</td>",
"rst_description":"A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to copy. The identifiers must be specified in a strictly increasing order.\n",
"description":"Sends the messages silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"description":"Mode for parsing entities in the photo caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"name":"allow_paid_broadcast"
},
{
"type":"String",
"required":false,
"description":"Unique identifier of the message effect to be added to the message; for private chats only",
"html_description":"<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
"rst_description":"Unique identifier of the message effect to be added to the message; for private chats only\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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":"<p>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 <a href=\"#message\">Message</a> is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.</p><p>For sending voice messages, use the <a href=\"#sendvoice\">sendVoice</a> method instead.</p>",
"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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"html_description":"<td>Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"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",
"html_description":"<td>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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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":"<p>Use this method to send general files. On success, the sent <a href=\"#message\">Message</a> 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.</p>",
"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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"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",
"html_description":"<td>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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"description":"Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing",
"html_description":"<td>Document caption (may also be used when resending documents by <em>file_id</em>), 0-1024 characters after entities parsing</td>",
"rst_description":"Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing\n",
"description":"Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"name":"protect_content"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"name":"allow_paid_broadcast"
},
{
"type":"String",
"required":false,
"description":"Unique identifier of the message effect to be added to the message; for private chats only",
"html_description":"<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
"rst_description":"Unique identifier of the message effect to be added to the message; for private chats only\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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":"<p>Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as <a href=\"#document\">Document</a>). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.</p>",
"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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"name":"video"
},
{
"type":"Integer",
"required":false,
"description":"Duration of sent video in seconds",
"html_description":"<td>Duration of sent video in seconds</td>",
"rst_description":"Duration of sent video in seconds\n",
"name":"duration"
},
{
"type":"Integer",
"required":false,
"description":"Video width",
"html_description":"<td>Video width</td>",
"rst_description":"Video width\n",
"name":"width"
},
{
"type":"Integer",
"required":false,
"description":"Video height",
"html_description":"<td>Video height</td>",
"rst_description":"Video height\n",
"name":"height"
},
{
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files",
"html_description":"<td>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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"thumbnail"
},
{
"type":"InputFile or String",
"required":false,
"description":"Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
"html_description":"<td>Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"cover"
},
{
"type":"Integer",
"required":false,
"description":"Start timestamp for the video in the message",
"html_description":"<td>Start timestamp for the video in the message</td>",
"rst_description":"Start timestamp for the video in the message\n",
"name":"start_timestamp"
},
{
"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":"<td>Video caption (may also be used when resending videos by <em>file_id</em>), 0-1024 characters after entities parsing</td>",
"rst_description":"Video caption (may also be used when resending videos by *file_id*), 0-1024 characters after entities parsing\n",
"description":"Mode for parsing entities in the video caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the video caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the video caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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":"<p>Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.</p>",
"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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"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",
"html_description":"<td>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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"description":"Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing",
"html_description":"<td>Animation caption (may also be used when resending animation by <em>file_id</em>), 0-1024 characters after entities parsing</td>",
"rst_description":"Animation caption (may also be used when resending animation by *file_id*), 0-1024 characters after entities parsing\n",
"description":"Mode for parsing entities in the animation caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the animation caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the animation caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Pass True if the animation needs to be covered with a spoiler animation",
"html_description":"<td>Pass <em>True</em> if the animation needs to be covered with a spoiler animation</td>",
"rst_description":"Pass :code:`True` if the animation needs to be covered with a spoiler animation\n",
"name":"has_spoiler"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"name":"allow_paid_broadcast"
},
{
"type":"String",
"required":false,
"description":"Unique identifier of the message effect to be added to the message; for private chats only",
"html_description":"<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
"rst_description":"Unique identifier of the message effect to be added to the message; for private chats only\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"html_description":"<p>Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as <a href=\"#audio\">Audio</a> or <a href=\"#document\">Document</a>). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.</p>",
"rst_description":"Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as :class:`aiogram.types.audio.Audio` or :class:`aiogram.types.document.Document`). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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 » <sending-files>`\n",
"description":"Mode for parsing entities in the voice message caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the voice message caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the voice message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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":"<p>As of <a href=\"https://telegram.org/blog/video-messages-and-telescope\">v.4.0</a>, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"As of `v.4.0 <https://telegram.org/blog/video-messages-and-telescope>`_, 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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>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. <a href=\"#sending-files\">More information on Sending Files »</a>. Sending video notes by a URL is currently unsupported</td>",
"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-files>`. Sending video notes by a URL is currently unsupported\n",
"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",
"html_description":"<td>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>. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"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://<file_attach_name>' if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. :ref:`More information on Sending Files » <sending-files>`\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.",
"html_description":"<td>Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.</td>",
"rst_description":"Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
"name":"payload"
},
{
"type":"String",
"required":false,
"description":"Media caption, 0-1024 characters after entities parsing",
"html_description":"<td>Media caption, 0-1024 characters after entities parsing</td>",
"rst_description":"Media caption, 0-1024 characters after entities parsing\n",
"description":"Mode for parsing entities in the media caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the media caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the media caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"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 Message objects that were sent is returned.",
"html_description":"<p>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 <a href=\"#message\">Message</a> objects that were sent is returned.</p>",
"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 :class:`aiogram.types.message.Message` objects that were sent is returned.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
"description":"Sends messages silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description":"<td>Period in seconds during which the location will be updated (see <a href=\"https://telegram.org/blog/live-locations\">Live Locations</a>, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description":"Period in seconds during which the location will be updated (see `Live Locations <https://telegram.org/blog/live-locations>`_, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"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":"<td>For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
"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",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)",
"html_description":"<td>Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)</td>",
"rst_description":"Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)\n",
"description":"Google Places type of the venue. (See supported types.)",
"html_description":"<td>Google Places type of the venue. (See <a href=\"https://developers.google.com/places/web-service/supported_types\">supported types</a>.)</td>",
"rst_description":"Google Places type of the venue. (See `supported types <https://developers.google.com/places/web-service/supported_types>`_.)\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Additional data about the contact in the form of a vCard, 0-2048 bytes",
"html_description":"<td>Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a>, 0-2048 bytes</td>",
"rst_description":"Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_, 0-2048 bytes\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>). Polls can't be sent to channel direct messages chats.</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Polls can't be sent to channel direct messages chats.\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed",
"html_description":"<td>Mode for parsing entities in the question. See <a href=\"#formatting-options\">formatting options</a> for more details. Currently, only custom emoji entities are allowed</td>",
"rst_description":"Mode for parsing entities in the question. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Currently, only custom emoji entities are allowed\n",
"name":"question_parse_mode"
},
{
"type":"Array of MessageEntity",
"required":false,
"description":"A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of <em>question_parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of *question_parse_mode*\n",
"description":"0-based identifier of the correct answer option, required for polls in quiz mode",
"html_description":"<td>0-based identifier of the correct answer option, required for polls in quiz mode</td>",
"rst_description":"0-based identifier of the correct answer option, required for polls in quiz mode\n",
"name":"correct_option_id"
},
{
"type":"String",
"required":false,
"description":"Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing",
"html_description":"<td>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</td>",
"rst_description":"Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing\n",
"name":"explanation"
},
{
"type":"String",
"required":false,
"description":"Mode for parsing entities in the explanation. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the explanation. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the explanation. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"explanation_parse_mode"
},
{
"type":"Array of MessageEntity",
"required":false,
"description":"A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of <em>explanation_parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of *explanation_parse_mode*\n",
"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":"<td>Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with <em>close_date</em>.</td>",
"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",
"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":"<td>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 <em>open_period</em>.</td>",
"rst_description":"Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open_period*.\n",
"name":"close_date"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the poll needs to be immediately closed. This can be useful for poll preview.",
"html_description":"<td>Pass <em>True</em> if the poll needs to be immediately closed. This can be useful for poll preview.</td>",
"rst_description":"Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send a checklist on behalf of a connected business account. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to send a checklist on behalf of a connected business account. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection on behalf of which the message will be sent",
"html_description":"<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
"rst_description":"Unique identifier of the business connection on behalf of which the message will be sent\n",
"name":"business_connection_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier for the target chat",
"html_description":"<td>Unique identifier for the target chat</td>",
"rst_description":"Unique identifier for the target chat\n",
"name":"chat_id"
},
{
"type":"InputChecklist",
"required":true,
"description":"A JSON-serialized object for the checklist to send",
"html_description":"<td>A JSON-serialized object for the checklist to send</td>",
"rst_description":"A JSON-serialized object for the checklist to send\n",
"name":"checklist"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message silently. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message silently. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"name":"protect_content"
},
{
"type":"String",
"required":false,
"description":"Unique identifier of the message effect to be added to the message",
"html_description":"<td>Unique identifier of the message effect to be added to the message</td>",
"rst_description":"Unique identifier of the message effect to be added to the message\n",
"name":"message_effect_id"
},
{
"type":"ReplyParameters",
"required":false,
"description":"A JSON-serialized object for description of the message to reply to",
"html_description":"<td>A JSON-serialized object for description of the message to reply to</td>",
"rst_description":"A JSON-serialized object for description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup",
"required":false,
"description":"A JSON-serialized object for an inline keyboard",
"description":"Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send an animated emoji that will display a random value. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"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.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"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":"<td>Emoji on which the dice throw animation is based. Currently, must be one of “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"🎲\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"🎯\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"🏀\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"⚽\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"🎳\"/>”, or “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"🎰\"/>”. Dice can have values 1-6 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"🎲\"/>”, “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"🎯\"/>” and “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"🎳\"/>”, values 1-5 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"🏀\"/>” and “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"⚽\"/>”, and values 1-64 for “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"🎰\"/>”. Defaults to “<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"🎲\"/>”</td>",
"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",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Description of the message to reply to",
"html_description":"<td>Description of the message to reply to</td>",
"rst_description":"Description of the message to reply to\n",
"name":"reply_parameters"
},
{
"type":"InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Use this method to stream a partial message to a user while the message is being generated. Returns True on success.",
"html_description":"<p>Use this method to stream a partial message to a user while the message is being generated. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to stream a partial message to a user while the message is being generated. Returns :code:`True` on success.",
"description":"Unique identifier for the target private chat",
"html_description":"<td>Unique identifier for the target private chat</td>",
"rst_description":"Unique identifier for the target private chat\n",
"name":"chat_id"
},
{
"type":"Integer",
"required":false,
"description":"Unique identifier for the target message thread",
"html_description":"<td>Unique identifier for the target message thread</td>",
"rst_description":"Unique identifier for the target message thread\n",
"name":"message_thread_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated",
"html_description":"<td>Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated</td>",
"rst_description":"Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated\n",
"name":"draft_id"
},
{
"type":"String",
"required":true,
"description":"Text of the message to be sent, 1-4096 characters after entities parsing",
"html_description":"<td>Text of the message to be sent, 1-4096 characters after entities parsing</td>",
"rst_description":"Text of the message to be sent, 1-4096 characters after entities parsing\n",
"name":"text"
},
{
"type":"String",
"required":false,
"description":"Mode for parsing entities in the message text. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode"
},
{
"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":"<td>A JSON-serialized list of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
"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":"<p>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 <em>True</em> on success.</p><blockquote>\n<p>Example: The <a href=\"https://t.me/imagebot\">ImageBot</a> 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 <a href=\"#sendchataction\">sendChatAction</a> with <em>action</em> = <em>upload_photo</em>. The user will see a “sending photo” status for the bot.</p>\n</blockquote><p>We only recommend using this method when a response from the bot will take a <strong>noticeable</strong> amount of time to arrive.</p>",
"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 <https://t.me/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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel chats and channel direct messages chats aren't supported.",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>). Channel chats and channel direct messages chats aren't supported.</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel chats and channel direct messages chats aren't supported.\n",
"description":"Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only\n",
"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":"<td>Type of action to broadcast. Choose one, depending on what the user is about to receive: <em>typing</em> for <a href=\"#sendmessage\">text messages</a>, <em>upload_photo</em> for <a href=\"#sendphoto\">photos</a>, <em>record_video</em> or <em>upload_video</em> for <a href=\"#sendvideo\">videos</a>, <em>record_voice</em> or <em>upload_voice</em> for <a href=\"#sendvoice\">voice notes</a>, <em>upload_document</em> for <a href=\"#senddocument\">general files</a>, <em>choose_sticker</em> for <a href=\"#sendsticker\">stickers</a>, <em>find_location</em> for <a href=\"#sendlocation\">location data</a>, <em>record_video_note</em> or <em>upload_video_note</em> for <a href=\"#sendvideonote\">video notes</a>.</td>",
"rst_description":"Type of action to broadcast. Choose one, depending on what the user is about to receive: *typing* for `text messages <https://core.telegram.org/bots/api#sendmessage>`_, *upload_photo* for `photos <https://core.telegram.org/bots/api#sendphoto>`_, *record_video* or *upload_video* for `videos <https://core.telegram.org/bots/api#sendvideo>`_, *record_voice* or *upload_voice* for `voice notes <https://core.telegram.org/bots/api#sendvoice>`_, *upload_document* for `general files <https://core.telegram.org/bots/api#senddocument>`_, *choose_sticker* for `stickers <https://core.telegram.org/bots/api#sendsticker>`_, *find_location* for `location data <https://core.telegram.org/bots/api#sendlocation>`_, *record_video_note* or *upload_video_note* for `video notes <https://core.telegram.org/bots/api#sendvideonote>`_.\n",
"name":"action"
}
],
"category":"methods"
},
{
"anchor":"setmessagereaction",
"name":"setMessageReaction",
"description":"Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.",
"html_description":"<p>Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.",
"html_description":"<td>Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.</td>",
"rst_description":"Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.\n",
"description":"A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.",
"html_description":"<td>A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.</td>",
"rst_description":"A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.\n",
"description":"Pass True to set the reaction with a big animation",
"html_description":"<td>Pass <em>True</em> to set the reaction with a big animation</td>",
"rst_description":"Pass :code:`True` to set the reaction with a big animation\n",
"name":"is_big"
}
],
"category":"methods"
},
{
"anchor":"getuserprofilephotos",
"name":"getUserProfilePhotos",
"description":"Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.",
"html_description":"<p>Use this method to get a list of profile pictures for a user. Returns a <a href=\"#userprofilephotos\">UserProfilePhotos</a> object.</p>",
"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":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"description":"Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.",
"html_description":"<p>Use this method to get a list of profile audios for a user. Returns a <a href=\"#userprofileaudios\">UserProfileAudios</a> object.</p>",
"rst_description":"Use this method to get a list of profile audios for a user. Returns a :class:`aiogram.types.user_profile_audios.UserProfileAudios` object.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"name":"user_id"
},
{
"type":"Integer",
"required":false,
"description":"Sequential number of the first audio to be returned. By default, all audios are returned.",
"html_description":"<td>Sequential number of the first audio to be returned. By default, all audios are returned.</td>",
"rst_description":"Sequential number of the first audio to be returned. By default, all audios are returned.\n",
"name":"offset"
},
{
"type":"Integer",
"required":false,
"description":"Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
"html_description":"<td>Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.</td>",
"rst_description":"Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
"description":"Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.",
"html_description":"<p>Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method <a href=\"/bots/webapps#initializing-mini-apps\">requestEmojiStatusAccess</a>. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method `requestEmojiStatusAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_. Returns :code:`True` on success.",
"description":"Expiration date of the emoji status, if any",
"html_description":"<td>Expiration date of the emoji status, if any</td>",
"rst_description":"Expiration date of the emoji status, if any\n",
"name":"emoji_status_expiration_date"
}
],
"category":"methods"
},
{
"anchor":"getfile",
"name":"getFile",
"description":"Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.\nNote: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.",
"html_description":"<p>Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a <a href=\"#file\">File</a> object is returned. The file can then be downloaded via the link <code>https://api.telegram.org/file/bot<token>/<file_path></code>, where <code><file_path></code> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling <a href=\"#getfile\">getFile</a> again.</p><p><strong>Note:</strong> This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.</p>",
"rst_description":"Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a :class:`aiogram.types.file.File` object is returned. The file can then be downloaded via the link :code:`https://api.telegram.org/file/bot<token>/<file_path>`, where :code:`<file_path>` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling :class:`aiogram.methods.get_file.GetFile` again.\n**Note:** This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.",
"annotations":[
{
"type":"String",
"required":true,
"description":"File identifier to get information about",
"html_description":"<td>File identifier to get information about</td>",
"rst_description":"File identifier to get information about\n",
"name":"file_id"
}
],
"category":"methods"
},
{
"anchor":"banchatmember",
"name":"banChatMember",
"description":"Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. 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":"<p>Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless <a href=\"#unbanchatmember\">unbanned</a> first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless `unbanned <https://core.telegram.org/bots/api#unbanchatmember>`_ first. 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.",
"description":"Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target group or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"description":"Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"html_description":"<td>Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
"rst_description":"Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
"description":"Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.",
"html_description":"<td>Pass <em>True</em> to delete all messages from the chat for the user that is being removed. If <em>False</em>, the user will be able to see messages in the group that were sent before the user was removed. Always <em>True</em> for supergroups and channels.</td>",
"rst_description":"Pass :code:`True` to delete all messages from the chat for the user that is being removed. If :code:`False`, the user will be able to see messages in the group that were sent before the user was removed. Always :code:`True` for supergroups and channels.\n",
"name":"revoke_messages"
}
],
"category":"methods"
},
{
"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":"<p>Use this method to unban a previously banned user in a supergroup or channel. The user will <strong>not</strong> 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 <strong>removed</strong> from the chat. If you don't want this, use the parameter <em>only_if_banned</em>. Returns <em>True</em> on success.</p>",
"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":"<td>Unique identifier for the target group or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target group or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"description":"Do nothing if the user is not banned",
"html_description":"<td>Do nothing if the user is not banned</td>",
"rst_description":"Do nothing if the user is not banned\n",
"name":"only_if_banned"
}
],
"category":"methods"
},
{
"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":"<p>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 <em>True</em> for all permissions to lift restrictions from a user. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<td>Pass <em>True</em> if chat permissions are set independently. Otherwise, the <em>can_send_other_messages</em> and <em>can_add_web_page_previews</em> permissions will imply the <em>can_send_messages</em>, <em>can_send_audios</em>, <em>can_send_documents</em>, <em>can_send_photos</em>, <em>can_send_videos</em>, <em>can_send_video_notes</em>, and <em>can_send_voice_notes</em> permissions; the <em>can_send_polls</em> permission will imply the <em>can_send_messages</em> permission.</td>",
"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",
"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":"<td>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</td>",
"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",
"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":"<p>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 <em>False</em> for all boolean parameters to demote a user. Returns <em>True</em> on success.</p>",
"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.",
"description":"Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
"html_description":"<td>Pass <em>True</em> if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
"rst_description":"Pass :code:`True` if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
"description":"Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators",
"html_description":"<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to <em>True</em> for promotions of channel administrators</td>",
"rst_description":"Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to :code:`True` for promotions of channel administrators\n",
"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":"<td>Pass <em>True</em> 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)</td>",
"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",
"description":"Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
"html_description":"<td>Pass <em>True</em> if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
"rst_description":"Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
"description":"Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
"html_description":"<td>Pass <em>True</em> if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
"rst_description":"Pass :code:`True` if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
"description":"Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only",
"html_description":"<td>Pass <em>True</em> if the administrator can manage direct messages within the channel and decline suggested posts; for channels only</td>",
"rst_description":"Pass :code:`True` if the administrator can manage direct messages within the channel and decline suggested posts; for channels only\n",
"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":"<p>Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"name":"chat_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"description":"Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.",
"html_description":"<p>Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the <em>can_manage_tags</em> administrator right. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. 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":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"name":"chat_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"name":"user_id"
},
{
"type":"String",
"required":false,
"description":"New tag for the member; 0-16 characters, emoji are not allowed",
"html_description":"<td>New tag for the member; 0-16 characters, emoji are not allowed</td>",
"rst_description":"New tag for the member; 0-16 characters, emoji are not allowed\n",
"description":"Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.",
"html_description":"<p>Use this method to ban a channel chat in a supergroup or a channel. Until the chat is <a href=\"#unbanchatsenderchat\">unbanned</a>, the owner of the banned chat won't be able to send messages on behalf of <strong>any of their channels</strong>. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to ban a channel chat in a supergroup or a channel. Until the chat is `unbanned <https://core.telegram.org/bots/api#unbanchatsenderchat>`_, the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns :code:`True` on success.",
"description":"Unique identifier of the target sender chat",
"html_description":"<td>Unique identifier of the target sender chat</td>",
"rst_description":"Unique identifier of the target sender chat\n",
"name":"sender_chat_id"
}
],
"category":"methods"
},
{
"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":"<p>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 <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier of the target sender chat",
"html_description":"<td>Unique identifier of the target sender chat</td>",
"rst_description":"Unique identifier of the target sender chat\n",
"name":"sender_chat_id"
}
],
"category":"methods"
},
{
"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":"<p>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 <em>can_restrict_members</em> administrator rights. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<td>Pass <em>True</em> if chat permissions are set independently. Otherwise, the <em>can_send_other_messages</em> and <em>can_add_web_page_previews</em> permissions will imply the <em>can_send_messages</em>, <em>can_send_audios</em>, <em>can_send_documents</em>, <em>can_send_photos</em>, <em>can_send_videos</em>, <em>can_send_video_notes</em>, and <em>can_send_voice_notes</em> permissions; the <em>can_send_polls</em> permission will imply the <em>can_send_messages</em> permission.</td>",
"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"
}
],
"category":"methods"
},
{
"anchor":"exportchatinvitelink",
"name":"exportChatInviteLink",
"description":"Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.\nNote: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.",
"html_description":"<p>Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as <em>String</em> on success.</p><blockquote>\n<p>Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using <a href=\"#exportchatinvitelink\">exportChatInviteLink</a> or by calling the <a href=\"#getchat\">getChat</a> method. If your bot needs to generate a new primary invite link replacing its previous one, use <a href=\"#exportchatinvitelink\">exportChatInviteLink</a> again.</p>\n</blockquote>",
"rst_description":"Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as *String* on success.\n\n Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using :class:`aiogram.methods.export_chat_invite_link.ExportChatInviteLink` or by calling the :class:`aiogram.methods.get_chat.GetChat` method. If your bot needs to generate a new primary invite link replacing its previous one, use :class:`aiogram.methods.export_chat_invite_link.ExportChatInviteLink` again.",
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name":"chat_id"
}
],
"category":"methods"
},
{
"anchor":"createchatinvitelink",
"name":"createChatInviteLink",
"description":"Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.",
"html_description":"<p>Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method <a href=\"#revokechatinvitelink\">revokeChatInviteLink</a>. Returns the new invite link as <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"rst_description":"Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
"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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"html_description":"<td>The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999</td>",
"rst_description":"The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999\n",
"description":"True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified",
"html_description":"<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators. If <em>True</em>, <em>member_limit</em> can't be specified</td>",
"rst_description":":code:`True`, if users joining the chat via the link need to be approved by chat administrators. If :code:`True`, *member_limit* can't be specified\n",
"description":"Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.",
"html_description":"<p>Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"rst_description":"Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
"description":"The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"html_description":"<td>The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999</td>",
"rst_description":"The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999\n",
"description":"True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified",
"html_description":"<td><em>True</em>, if users joining the chat via the link need to be approved by chat administrators. If <em>True</em>, <em>member_limit</em> can't be specified</td>",
"rst_description":":code:`True`, if users joining the chat via the link need to be approved by chat administrators. If :code:`True`, *member_limit* can't be specified\n",
"name":"creates_join_request"
}
],
"category":"methods"
},
{
"anchor":"createchatsubscriptioninvitelink",
"name":"createChatSubscriptionInviteLink",
"description":"Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.",
"html_description":"<p>Use this method to create a <a href=\"https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions\">subscription invite link</a> for a channel chat. The bot must have the <em>can_invite_users</em> administrator rights. The link can be edited using the method <a href=\"#editchatsubscriptioninvitelink\">editChatSubscriptionInviteLink</a> or revoked using the method <a href=\"#revokechatinvitelink\">revokeChatInviteLink</a>. Returns the new invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"rst_description":"Use this method to create a `subscription invite link <https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions>`_ for a channel chat. The bot must have the *can_invite_users* administrator rights. The link can be edited using the method :class:`aiogram.methods.edit_chat_subscription_invite_link.EditChatSubscriptionInviteLink` or revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
"annotations":[
{
"type":"Integer or String",
"required":true,
"description":"Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target channel chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target channel chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).",
"html_description":"<td>The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).</td>",
"rst_description":"The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).\n",
"description":"The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000",
"html_description":"<td>The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000</td>",
"rst_description":"The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000\n",
"name":"subscription_price"
}
],
"category":"methods"
},
{
"anchor":"editchatsubscriptioninvitelink",
"name":"editChatSubscriptionInviteLink",
"description":"Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.",
"html_description":"<p>Use this method to edit a subscription invite link created by the bot. The bot must have the <em>can_invite_users</em> administrator rights. Returns the edited invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"rst_description":"Use this method to edit a subscription invite link created by the bot. The bot must have the *can_invite_users* administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
"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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Invite link name; 0-32 characters",
"html_description":"<td>Invite link name; 0-32 characters</td>",
"rst_description":"Invite link name; 0-32 characters\n",
"name":"name"
}
],
"category":"methods"
},
{
"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":"<p>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 <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
"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.",
"html_description":"<td>The invite link to revoke</td>",
"rst_description":"The invite link to revoke\n",
"name":"invite_link"
}
],
"category":"methods"
},
{
"anchor":"approvechatjoinrequest",
"name":"approveChatJoinRequest",
"description":"Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.",
"html_description":"<p>Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the <em>can_invite_users</em> administrator right. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"name":"user_id"
}
],
"category":"methods"
},
{
"anchor":"declinechatjoinrequest",
"name":"declineChatJoinRequest",
"description":"Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.",
"html_description":"<p>Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the <em>can_invite_users</em> administrator right. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns :code:`True` on success.",
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"name":"user_id"
}
],
"category":"methods"
},
{
"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":"<p>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 <em>True</em> on success.</p>",
"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.",
"description":"New chat photo, uploaded using multipart/form-data",
"html_description":"<td>New chat photo, uploaded using multipart/form-data</td>",
"rst_description":"New chat photo, uploaded using multipart/form-data\n",
"name":"photo"
}
],
"category":"methods"
},
{
"anchor":"deletechatphoto",
"name":"deleteChatPhoto",
"description":"Use this method to delete a chat photo. 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":"<p>Use this method to delete a chat photo. 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 <em>True</em> on success.</p>",
"rst_description":"Use this method to delete a chat photo. 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name":"chat_id"
}
],
"category":"methods"
},
{
"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":"<p>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 <em>True</em> on success.</p>",
"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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"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":"<p>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 <em>True</em> on success.</p>",
"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.",
"description":"Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.",
"html_description":"<p>Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns :code:`True` on success.",
"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":"<td>Pass <em>True</em> 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.</td>",
"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",
"description":"Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns True on success.",
"html_description":"<p>Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns :code:`True` on success.",
"description":"Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.",
"html_description":"<td>Identifier of the message to unpin. Required if <em>business_connection_id</em> is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.</td>",
"rst_description":"Identifier of the message to unpin. Required if *business_connection_id* is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.\n",
"description":"Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.",
"html_description":"<p>Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns :code:`True` on success.",
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead.",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>). Channel direct messages chats aren't supported; leave the corresponding channel instead.</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`). Channel direct messages chats aren't supported; leave the corresponding channel instead.\n",
"description":"Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.",
"html_description":"<p>Use this method to get up-to-date information about the chat. Returns a <a href=\"#chatfullinfo\">ChatFullInfo</a> object on success.</p>",
"rst_description":"Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.",
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"description":"Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.",
"html_description":"<p>Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of <a href=\"#chatmember\">ChatMember</a> objects.</p>",
"rst_description":"Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of :class:`aiogram.types.chat_member.ChatMember` objects.",
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"description":"Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.",
"html_description":"<p>Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a <a href=\"#chatmember\">ChatMember</a> object on success.</p>",
"rst_description":"Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a :class:`aiogram.types.chat_member.ChatMember` object on success.",
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
"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":"<p>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 <em>can_set_sticker_set</em> optionally returned in <a href=\"#getchat\">getChat</a> requests to check if the bot can use this method. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Name of the sticker set to be set as the group sticker set",
"html_description":"<td>Name of the sticker set to be set as the group sticker set</td>",
"rst_description":"Name of the sticker set to be set as the group sticker set\n",
"name":"sticker_set_name"
}
],
"category":"methods"
},
{
"anchor":"deletechatstickerset",
"name":"deleteChatStickerSet",
"description":"Use this method to delete a group sticker set from 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":"<p>Use this method to delete a group sticker set from 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 <em>can_set_sticker_set</em> optionally returned in <a href=\"#getchat\">getChat</a> requests to check if the bot can use this method. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete a group sticker set from 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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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 Sticker objects.",
"html_description":"<p>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 <a href=\"#sticker\">Sticker</a> objects.</p>",
"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.",
"description":"Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.",
"html_description":"<p>Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_manage_topics</em> administrator right. Returns information about the created topic as a <a href=\"#forumtopic\">ForumTopic</a> object.</p>",
"rst_description":"Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as a :class:`aiogram.types.forum_topic.ForumTopic` object.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)",
"html_description":"<td>Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)</td>",
"rst_description":"Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)\n",
"description":"Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.",
"html_description":"<td>Unique identifier of the custom emoji shown as the topic icon. Use <a href=\"#getforumtopiciconstickers\">getForumTopicIconStickers</a> to get all allowed custom emoji identifiers.</td>",
"rst_description":"Unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers.\n",
"description":"Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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":"<p>Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_manage_topics</em> administrator rights, unless it is the creator of the topic. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept",
"html_description":"<td>New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept</td>",
"rst_description":"New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept\n",
"name":"name"
},
{
"type":"String",
"required":false,
"description":"New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept",
"html_description":"<td>New unique identifier of the custom emoji shown as the topic icon. Use <a href=\"#getforumtopiciconstickers\">getForumTopicIconStickers</a> to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept</td>",
"rst_description":"New unique identifier of the custom emoji shown as the topic icon. Use :class:`aiogram.methods.get_forum_topic_icon_stickers.GetForumTopicIconStickers` to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept\n",
"description":"Use this method to close an open 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":"<p>Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the <em>can_manage_topics</em> administrator rights, unless it is the creator of the topic. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to close an open 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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<p>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 <em>can_manage_topics</em> administrator rights, unless it is the creator of the topic. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.",
"html_description":"<p>Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_delete_messages</em> administrator rights. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns :code:`True` on success.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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":"<p>Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_pin_messages</em> administrator right in the supergroup. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat 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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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 the can_manage_topics administrator rights. Returns True on success.",
"html_description":"<p>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 the <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
"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 the *can_manage_topics* administrator rights. Returns :code:`True` on success.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<p>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 <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<p>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 <em>can_manage_topics</em> administrator rights. The topic will be automatically unhidden if it was hidden. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<p>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 <em>can_manage_topics</em> administrator rights. The topic will be automatically closed if it was open. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"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":"<p>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 <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
"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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Use this method to clear the list of pinned messages in a General 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":"<p>Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the <em>can_pin_messages</em> administrator right in the supergroup. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to clear the list of pinned messages in a General 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.",
"description":"Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
"description":"Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.\nAlternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.",
"html_description":"<p>Use this method to send answers to callback queries sent from <a href=\"/bots/features#inline-keyboards\">inline keyboards</a>. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, <em>True</em> is returned.</p><blockquote>\n<p>Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via <a href=\"https://t.me/botfather\">@BotFather</a> and accept the terms. Otherwise, you may use links like <code>t.me/your_bot?start=XXXX</code> that open your bot with a parameter.</p>\n</blockquote>",
"rst_description":"Use this method to send answers to callback queries sent from `inline keyboards <https://core.telegram.org/bots/features#inline-keyboards>`_. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, :code:`True` is returned.\n\n Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via `@BotFather <https://t.me/botfather>`_ and accept the terms. Otherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter.",
"description":"Unique identifier for the query to be answered",
"html_description":"<td>Unique identifier for the query to be answered</td>",
"rst_description":"Unique identifier for the query to be answered\n",
"name":"callback_query_id"
},
{
"type":"String",
"required":false,
"description":"Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters",
"html_description":"<td>Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters</td>",
"rst_description":"Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters\n",
"name":"text"
},
{
"type":"Boolean",
"required":false,
"description":"If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.",
"html_description":"<td>If <em>True</em>, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to <em>false</em>.</td>",
"rst_description":"If :code:`True`, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to *false*.\n",
"name":"show_alert"
},
{
"type":"String",
"required":false,
"description":"URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.\n\nOtherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.",
"html_description":"<td>URL that will be opened by the user's client. If you have created a <a href=\"#game\">Game</a> and accepted the conditions via <a href=\"https://t.me/botfather\">@BotFather</a>, specify the URL that opens your game - note that this will only work if the query comes from a <a href=\"#inlinekeyboardbutton\"><em>callback_game</em></a> button.<br/>\n<br/>\nOtherwise, you may use links like <code>t.me/your_bot?start=XXXX</code> that open your bot with a parameter.</td>",
"rst_description":"URL that will be opened by the user's client. If you have created a :class:`aiogram.types.game.Game` and accepted the conditions via `@BotFather <https://t.me/botfather>`_, specify the URL that opens your game - note that this will only work if the query comes from a `https://core.telegram.org/bots/api#inlinekeyboardbutton <https://core.telegram.org/bots/api#inlinekeyboardbutton>`_ *callback_game* button.\n\n\n\nOtherwise, you may use links like :code:`t.me/your_bot?start=XXXX` that open your bot with a parameter.\n",
"description":"The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.",
"html_description":"<td>The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.</td>",
"rst_description":"The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.\n",
"description":"Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.",
"html_description":"<p>Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a <a href=\"#userchatboosts\">UserChatBoosts</a> object.</p>",
"rst_description":"Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a :class:`aiogram.types.user_chat_boosts.UserChatBoosts` object.",
"description":"Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.",
"html_description":"<p>Use this method to get information about the connection of the bot with a business account. Returns a <a href=\"#businessconnection\">BusinessConnection</a> object on success.</p>",
"rst_description":"Use this method to get information about the connection of the bot with a business account. Returns a :class:`aiogram.types.business_connection.BusinessConnection` object on success.",
"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":"<p>Use this method to change the list of the bot's commands. See <a href=\"/bots/features#commands\">this manual</a> for more details about bot commands. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the list of the bot's commands. See `this manual <https://core.telegram.org/bots/features#commands>`_ for more details about bot commands. Returns :code:`True` on success.",
"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":"<td>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.</td>",
"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"
},
{
"type":"BotCommandScope",
"required":false,
"description":"A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.",
"html_description":"<td>A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to <a href=\"#botcommandscopedefault\">BotCommandScopeDefault</a>.</td>",
"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"
},
{
"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":"<td>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</td>",
"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",
"description":"Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.",
"html_description":"<p>Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, <a href=\"#determining-list-of-commands\">higher level commands</a> will be shown to affected users. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, `higher level commands <https://core.telegram.org/bots/api#determining-list-of-commands>`_ will be shown to affected users. Returns :code:`True` on success.",
"description":"A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.",
"html_description":"<td>A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to <a href=\"#botcommandscopedefault\">BotCommandScopeDefault</a>.</td>",
"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",
"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":"<td>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</td>",
"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",
"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":"<p>Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of <a href=\"#botcommand\">BotCommand</a> objects. If commands aren't set, an empty list is returned.</p>",
"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.",
"description":"A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.",
"html_description":"<td>A JSON-serialized object, describing scope of users. Defaults to <a href=\"#botcommandscopedefault\">BotCommandScopeDefault</a>.</td>",
"rst_description":"A JSON-serialized object, describing scope of users. Defaults to :class:`aiogram.types.bot_command_scope_default.BotCommandScopeDefault`.\n",
"description":"A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.",
"html_description":"<td>A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.</td>",
"rst_description":"A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.\n",
"name":"language_code"
}
],
"category":"methods"
},
{
"anchor":"getmyname",
"name":"getMyName",
"description":"Use this method to get the current bot name for the given user language. Returns BotName on success.",
"html_description":"<p>Use this method to get the current bot name for the given user language. Returns <a href=\"#botname\">BotName</a> on success.</p>",
"rst_description":"Use this method to get the current bot name for the given user language. Returns :class:`aiogram.types.bot_name.BotName` on success.",
"description":"Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.",
"html_description":"<p>Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns :code:`True` on success.",
"description":"A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.",
"html_description":"<td>A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.</td>",
"rst_description":"A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.\n",
"description":"Use this method to get the current bot description for the given user language. Returns BotDescription on success.",
"html_description":"<p>Use this method to get the current bot description for the given user language. Returns <a href=\"#botdescription\">BotDescription</a> on success.</p>",
"rst_description":"Use this method to get the current bot description for the given user language. Returns :class:`aiogram.types.bot_description.BotDescription` on success.",
"description":"Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.",
"html_description":"<p>Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns :code:`True` on success.",
"description":"New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.",
"html_description":"<td>New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.</td>",
"rst_description":"New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.\n",
"description":"A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.",
"html_description":"<td>A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.</td>",
"rst_description":"A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.\n",
"description":"Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.",
"html_description":"<p>Use this method to get the current bot short description for the given user language. Returns <a href=\"#botshortdescription\">BotShortDescription</a> on success.</p>",
"rst_description":"Use this method to get the current bot short description for the given user language. Returns :class:`aiogram.types.bot_short_description.BotShortDescription` on success.",
"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":"<p>Use this method to change the bot's menu button in a private chat, or the default menu button. Returns <em>True</em> on success.</p>",
"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.",
"description":"A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault",
"html_description":"<td>A JSON-serialized object for the bot's new menu button. Defaults to <a href=\"#menubuttondefault\">MenuButtonDefault</a></td>",
"rst_description":"A JSON-serialized object for the bot's new menu button. Defaults to :class:`aiogram.types.menu_button_default.MenuButtonDefault`\n",
"description":"Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.",
"html_description":"<p>Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns <a href=\"#menubutton\">MenuButton</a> on success.</p>",
"rst_description":"Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns :class:`aiogram.types.menu_button.MenuButton` on success.",
"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 free to modify the list before adding the bot. Returns True on success.",
"html_description":"<p>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 free to modify the list before adding the bot. Returns <em>True</em> on success.</p>",
"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 free to modify the list before adding the bot. Returns :code:`True` on success.",
"description":"A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.",
"html_description":"<td>A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.</td>",
"rst_description":"A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.\n",
"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":"<td>Pass <em>True</em> 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.</td>",
"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",
"description":"Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.",
"html_description":"<p>Use this method to get the current default administrator rights of the bot. Returns <a href=\"#chatadministratorrights\">ChatAdministratorRights</a> on success.</p>",
"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.",
"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":"<td>Pass <em>True</em> to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.</td>",
"rst_description":"Pass :code:`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.\n",
"description":"Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.",
"html_description":"<p>Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a <a href=\"#gifts\">Gifts</a> object.</p>",
"rst_description":"Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a :class:`aiogram.types.gifts.Gifts` object.",
"annotations":[],
"category":"methods"
},
{
"anchor":"sendgift",
"name":"sendGift",
"description":"Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.",
"html_description":"<p>Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns <em>True</em> on success.</p>",
"rst_description":"Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns :code:`True` on success.",
"description":"Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.",
"html_description":"<td>Required if <em>user_id</em> is not specified. Unique identifier for the chat or username of the channel (in the format <code>@channelusername</code>) that will receive the gift.</td>",
"rst_description":"Required if *user_id* is not specified. Unique identifier for the chat or username of the channel (in the format :code:`@channelusername`) that will receive the gift.\n",
"description":"Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.",
"html_description":"<td>Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.</td>",
"rst_description":"Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.\n",
"description":"A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.",
"html_description":"<td>A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of <em>text_parse_mode</em>. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.</td>",
"rst_description":"A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.\n",
"description":"Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months",
"html_description":"<td>Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months</td>",
"rst_description":"Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months\n",
"description":"Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.",
"html_description":"<td>Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.</td>",
"rst_description":"Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.\n",
"description":"A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.",
"html_description":"<td>A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of <em>text_parse_mode</em>. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, and “custom_emoji” are ignored.</td>",
"rst_description":"A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', and 'custom_emoji' are ignored.\n",
"name":"text_entities"
}
],
"category":"methods"
},
{
"anchor":"verifyuser",
"name":"verifyUser",
"description":"Verifies a user on behalf of the organization which is represented by the bot. Returns True on success.",
"html_description":"<p>Verifies a user <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> which is represented by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Verifies a user `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ which is represented by the bot. Returns :code:`True` on success.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"description":"Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.",
"html_description":"<td>Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.</td>",
"rst_description":"Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.\n",
"name":"custom_description"
}
],
"category":"methods"
},
{
"anchor":"verifychat",
"name":"verifyChat",
"description":"Verifies a chat on behalf of the organization which is represented by the bot. Returns True on success.",
"html_description":"<p>Verifies a chat <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> which is represented by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Verifies a chat `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ which is represented 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 channel (in the format @channelusername). Channel direct messages chats can't be verified.",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>). Channel direct messages chats can't be verified.</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Channel direct messages chats can't be verified.\n",
"description":"Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.",
"html_description":"<td>Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.</td>",
"rst_description":"Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.\n",
"description":"Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.",
"html_description":"<p>Removes verification from a user who is currently verified <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> represented by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Removes verification from a user who is currently verified `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ represented by the bot. Returns :code:`True` on success.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user",
"html_description":"<td>Unique identifier of the target user</td>",
"rst_description":"Unique identifier of the target user\n",
"name":"user_id"
}
],
"category":"methods"
},
{
"anchor":"removechatverification",
"name":"removeChatVerification",
"description":"Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.",
"html_description":"<p>Removes verification from a chat that is currently verified <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> represented by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Removes verification from a chat that is currently verified `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ represented 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 channel (in the format @channelusername)",
"html_description":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name":"chat_id"
}
],
"category":"methods"
},
{
"anchor":"readbusinessmessage",
"name":"readBusinessMessage",
"description":"Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.",
"html_description":"<p>Marks incoming message as read on behalf of a business account. Requires the <em>can_read_messages</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns :code:`True` on success.",
"description":"Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.",
"html_description":"<p>Delete messages on behalf of a business account. Requires the <em>can_delete_sent_messages</em> business bot right to delete messages sent by the bot itself, or the <em>can_delete_all_messages</em> business bot right to delete any message. Returns <em>True</em> on success.</p>",
"rst_description":"Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection on behalf of which to delete the messages",
"html_description":"<td>Unique identifier of the business connection on behalf of which to delete the messages</td>",
"rst_description":"Unique identifier of the business connection on behalf of which to delete the messages\n",
"name":"business_connection_id"
},
{
"type":"Array of Integer",
"required":true,
"description":"A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted",
"html_description":"<td>A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See <a href=\"#deletemessage\">deleteMessage</a> for limitations on which messages can be deleted</td>",
"rst_description":"A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
"name":"message_ids"
}
],
"category":"methods"
},
{
"anchor":"setbusinessaccountname",
"name":"setBusinessAccountName",
"description":"Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.",
"html_description":"<p>Changes the first and last name of a managed business account. Requires the <em>can_change_name</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"String",
"required":true,
"description":"The new value of the first name for the business account; 1-64 characters",
"html_description":"<td>The new value of the first name for the business account; 1-64 characters</td>",
"rst_description":"The new value of the first name for the business account; 1-64 characters\n",
"description":"The new value of the last name for the business account; 0-64 characters",
"html_description":"<td>The new value of the last name for the business account; 0-64 characters</td>",
"rst_description":"The new value of the last name for the business account; 0-64 characters\n",
"name":"last_name"
}
],
"category":"methods"
},
{
"anchor":"setbusinessaccountusername",
"name":"setBusinessAccountUsername",
"description":"Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.",
"html_description":"<p>Changes the username of a managed business account. Requires the <em>can_change_username</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"String",
"required":false,
"description":"The new value of the username for the business account; 0-32 characters",
"html_description":"<td>The new value of the username for the business account; 0-32 characters</td>",
"rst_description":"The new value of the username for the business account; 0-32 characters\n",
"name":"username"
}
],
"category":"methods"
},
{
"anchor":"setbusinessaccountbio",
"name":"setBusinessAccountBio",
"description":"Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.",
"html_description":"<p>Changes the bio of a managed business account. Requires the <em>can_change_bio</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"String",
"required":false,
"description":"The new value of the bio for the business account; 0-140 characters",
"html_description":"<td>The new value of the bio for the business account; 0-140 characters</td>",
"rst_description":"The new value of the bio for the business account; 0-140 characters\n",
"name":"bio"
}
],
"category":"methods"
},
{
"anchor":"setbusinessaccountprofilephoto",
"name":"setBusinessAccountProfilePhoto",
"description":"Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
"html_description":"<p>Changes the profile photo of a managed business account. Requires the <em>can_edit_profile_photo</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"InputProfilePhoto",
"required":true,
"description":"The new profile photo to set",
"html_description":"<td>The new profile photo to set</td>",
"rst_description":"The new profile photo to set\n",
"name":"photo"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.",
"html_description":"<td>Pass <em>True</em> to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.</td>",
"rst_description":"Pass :code:`True` to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.\n",
"name":"is_public"
}
],
"category":"methods"
},
{
"anchor":"removebusinessaccountprofilephoto",
"name":"removeBusinessAccountProfilePhoto",
"description":"Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
"html_description":"<p>Removes the current profile photo of a managed business account. Requires the <em>can_edit_profile_photo</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.",
"html_description":"<td>Pass <em>True</em> to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.</td>",
"rst_description":"Pass :code:`True` to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.\n",
"name":"is_public"
}
],
"category":"methods"
},
{
"anchor":"setbusinessaccountgiftsettings",
"name":"setBusinessAccountGiftSettings",
"description":"Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.",
"html_description":"<p>Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the <em>can_change_gift_settings</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"description":"Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field",
"html_description":"<td>Pass <em>True</em>, if a button for sending a gift to the user or by the business account must always be shown in the input field</td>",
"rst_description":"Pass :code:`True`, if a button for sending a gift to the user or by the business account must always be shown in the input field\n",
"description":"Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.",
"html_description":"<p>Returns the amount of Telegram Stars owned by a managed business account. Requires the <em>can_view_gifts_and_stars</em> business bot right. Returns <a href=\"#staramount\">StarAmount</a> on success.</p>",
"rst_description":"Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.star_amount.StarAmount` on success.",
"description":"Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.",
"html_description":"<p>Transfers Telegram Stars from the business account balance to the bot's balance. Requires the <em>can_transfer_stars</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns :code:`True` on success.",
"description":"Number of Telegram Stars to transfer; 1-10000",
"html_description":"<td>Number of Telegram Stars to transfer; 1-10000</td>",
"rst_description":"Number of Telegram Stars to transfer; 1-10000\n",
"name":"star_count"
}
],
"category":"methods"
},
{
"anchor":"getbusinessaccountgifts",
"name":"getBusinessAccountGifts",
"description":"Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.",
"html_description":"<p>Returns the gifts received and owned by a managed business account. Requires the <em>can_view_gifts_and_stars</em> business bot right. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
"rst_description":"Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
"description":"Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
"html_description":"<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
"rst_description":"Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
"description":"Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results",
"html_description":"<td>Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results</td>",
"rst_description":"Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results\n",
"description":"Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.",
"html_description":"<p>Returns the gifts owned and hosted by a user. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
"rst_description":"Returns the gifts owned and hosted by a user. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the user",
"html_description":"<td>Unique identifier of the user</td>",
"rst_description":"Unique identifier of the user\n",
"name":"user_id"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased an unlimited number of times",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
"name":"exclude_unlimited"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can be upgraded to unique</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
"name":"exclude_limited_upgradable"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
"name":"exclude_limited_non_upgradable"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
"html_description":"<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
"rst_description":"Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
"name":"exclude_from_blockchain"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude unique gifts",
"html_description":"<td>Pass <em>True</em> to exclude unique gifts</td>",
"rst_description":"Pass :code:`True` to exclude unique gifts\n",
"name":"exclude_unique"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
"html_description":"<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
"rst_description":"Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
"name":"sort_by_price"
},
{
"type":"String",
"required":false,
"description":"Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
"html_description":"<td>Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results</td>",
"rst_description":"Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
"name":"offset"
},
{
"type":"Integer",
"required":false,
"description":"The maximum number of gifts to be returned; 1-100. Defaults to 100",
"html_description":"<td>The maximum number of gifts to be returned; 1-100. Defaults to 100</td>",
"rst_description":"The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
"name":"limit"
}
],
"category":"methods"
},
{
"anchor":"getchatgifts",
"name":"getChatGifts",
"description":"Returns the gifts owned by a chat. Returns OwnedGifts on success.",
"html_description":"<p>Returns the gifts owned by a chat. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
"rst_description":"Returns the gifts owned by a chat. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` 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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"name":"chat_id"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.",
"html_description":"<td>Pass <em>True</em> to exclude gifts that aren't saved to the chat's profile page. Always <em>True</em>, unless the bot has the <em>can_post_messages</em> administrator right in the channel.</td>",
"rst_description":"Pass :code:`True` to exclude gifts that aren't saved to the chat's profile page. Always :code:`True`, unless the bot has the *can_post_messages* administrator right in the channel.\n",
"name":"exclude_unsaved"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.",
"html_description":"<td>Pass <em>True</em> to exclude gifts that are saved to the chat's profile page. Always <em>False</em>, unless the bot has the <em>can_post_messages</em> administrator right in the channel.</td>",
"rst_description":"Pass :code:`True` to exclude gifts that are saved to the chat's profile page. Always :code:`False`, unless the bot has the *can_post_messages* administrator right in the channel.\n",
"name":"exclude_saved"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased an unlimited number of times",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
"name":"exclude_unlimited"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can be upgraded to unique</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
"name":"exclude_limited_upgradable"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
"html_description":"<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique</td>",
"rst_description":"Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
"name":"exclude_limited_non_upgradable"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
"html_description":"<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
"rst_description":"Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
"name":"exclude_from_blockchain"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to exclude unique gifts",
"html_description":"<td>Pass <em>True</em> to exclude unique gifts</td>",
"rst_description":"Pass :code:`True` to exclude unique gifts\n",
"name":"exclude_unique"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
"html_description":"<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
"rst_description":"Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
"name":"sort_by_price"
},
{
"type":"String",
"required":false,
"description":"Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
"html_description":"<td>Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results</td>",
"rst_description":"Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
"name":"offset"
},
{
"type":"Integer",
"required":false,
"description":"The maximum number of gifts to be returned; 1-100. Defaults to 100",
"html_description":"<td>The maximum number of gifts to be returned; 1-100. Defaults to 100</td>",
"rst_description":"The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
"description":"Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.",
"html_description":"<p>Converts a given regular gift to Telegram Stars. Requires the <em>can_convert_gifts_to_stars</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns :code:`True` on success.",
"description":"Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.",
"html_description":"<p>Upgrades a given regular gift to a unique gift. Requires the <em>can_transfer_and_upgrade_gifts</em> business bot right. Additionally requires the <em>can_transfer_stars</em> business bot right if the upgrade is paid. Returns <em>True</em> on success.</p>",
"rst_description":"Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns :code:`True` on success.",
"description":"The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.",
"html_description":"<td>The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If <code>gift.prepaid_upgrade_star_count > 0</code>, then pass 0, otherwise, the <em>can_transfer_stars</em> business bot right is required and <code>gift.upgrade_star_count</code> must be passed.</td>",
"rst_description":"The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If :code:`gift.prepaid_upgrade_star_count > 0`, then pass 0, otherwise, the *can_transfer_stars* business bot right is required and :code:`gift.upgrade_star_count` must be passed.\n",
"description":"Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.",
"html_description":"<p>Transfers an owned unique gift to another user. Requires the <em>can_transfer_and_upgrade_gifts</em> business bot right. Requires <em>can_transfer_stars</em> business bot right if the transfer is paid. Returns <em>True</em> on success.</p>",
"rst_description":"Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns :code:`True` on success.",
"description":"The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.",
"html_description":"<td>The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the <em>can_transfer_stars</em> business bot right is required.</td>",
"rst_description":"The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the *can_transfer_stars* business bot right is required.\n",
"description":"Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
"html_description":"<p>Posts a story on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <a href=\"#story\">Story</a> on success.</p>",
"rst_description":"Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
"description":"Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
"html_description":"<td>Period after which the story is moved to the archive, in seconds; must be one of <code>6 * 3600</code>, <code>12 * 3600</code>, <code>86400</code>, or <code>2 * 86400</code></td>",
"rst_description":"Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
"description":"Mode for parsing entities in the story caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the story caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the story caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.",
"html_description":"<p>Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the <em>can_manage_stories</em> business bot right for both business accounts. Returns <a href=\"#story\">Story</a> on success.</p>",
"rst_description":"Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns :class:`aiogram.types.story.Story` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier of the business connection",
"html_description":"<td>Unique identifier of the business connection</td>",
"rst_description":"Unique identifier of the business connection\n",
"name":"business_connection_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the chat which posted the story that should be reposted",
"html_description":"<td>Unique identifier of the chat which posted the story that should be reposted</td>",
"rst_description":"Unique identifier of the chat which posted the story that should be reposted\n",
"name":"from_chat_id"
},
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the story that should be reposted",
"html_description":"<td>Unique identifier of the story that should be reposted</td>",
"rst_description":"Unique identifier of the story that should be reposted\n",
"name":"from_story_id"
},
{
"type":"Integer",
"required":true,
"description":"Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
"html_description":"<td>Period after which the story is moved to the archive, in seconds; must be one of <code>6 * 3600</code>, <code>12 * 3600</code>, <code>86400</code>, or <code>2 * 86400</code></td>",
"rst_description":"Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
"name":"active_period"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True to keep the story accessible after it expires",
"html_description":"<td>Pass <em>True</em> to keep the story accessible after it expires</td>",
"rst_description":"Pass :code:`True` to keep the story accessible after it expires\n",
"name":"post_to_chat_page"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the content of the story must be protected from forwarding and screenshotting",
"html_description":"<td>Pass <em>True</em> if the content of the story must be protected from forwarding and screenshotting</td>",
"rst_description":"Pass :code:`True` if the content of the story must be protected from forwarding and screenshotting\n",
"description":"Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
"html_description":"<p>Edits a story previously posted by the bot on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <a href=\"#story\">Story</a> on success.</p>",
"rst_description":"Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
"description":"Mode for parsing entities in the story caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the story caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the story caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.",
"html_description":"<p>Deletes a story previously posted by the bot on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <em>True</em> on success.</p>",
"rst_description":"Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :code:`True` on success.",
"description":"All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.\nOn successful call, a JSON-object containing the result will be returned."
"description":"Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
"html_description":"<p>Use this method to edit text and <a href=\"#games\">game</a> messages. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
"rst_description":"Use this method to edit text and `game <https://core.telegram.org/bots/api#games>`_ messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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",
"description":"Mode for parsing entities in the message text. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
"description":"Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
"html_description":"<p>Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
"rst_description":"Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the message to edit",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Identifier of the message to edit</td>",
"rst_description":"Required if *inline_message_id* is not specified. Identifier of the message to edit\n",
"description":"Mode for parsing entities in the message caption. See formatting options for more details.",
"html_description":"<td>Mode for parsing entities in the message caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"Mode for parsing entities in the message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.",
"html_description":"<td>Pass <em>True</em>, if the caption must be shown above the message media. Supported only for animation, photo and video messages.</td>",
"rst_description":"Pass :code:`True`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.\n",
"description":"Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
"html_description":"<p>Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
"rst_description":"Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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",
"description":"Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.",
"html_description":"<p>Use this method to edit live location messages. A location can be edited until its <em>live_period</em> expires or editing is explicitly disabled by a call to <a href=\"#stopmessagelivelocation\">stopMessageLiveLocation</a>. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned.</p>",
"rst_description":"Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned.",
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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",
"description":"New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged",
"html_description":"<td>New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current <em>live_period</em> by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then <em>live_period</em> remains unchanged</td>",
"rst_description":"New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged\n",
"description":"Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"html_description":"<td>Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.</td>",
"rst_description":"Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
"name":"heading"
},
{
"type":"Integer",
"required":false,
"description":"The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"html_description":"<td>The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
"rst_description":"The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.\n",
"description":"A JSON-serialized object for a new inline keyboard.",
"html_description":"<td>A JSON-serialized object for a new <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>.</td>",
"rst_description":"A JSON-serialized object for a new `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_.\n",
"name":"reply_markup"
}
],
"category":"methods"
},
{
"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":"<p>Use this method to stop updating a live location message before <em>live_period</em> expires. On success, if the message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned.</p>",
"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.",
"description":"Unique identifier of the business connection on behalf of which the message to be edited was sent",
"html_description":"<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
"rst_description":"Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
"name":"business_connection_id"
},
{
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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",
"description":"Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.",
"html_description":"<p>Use this method to edit a checklist on behalf of a connected business account. On success, the edited <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to edit a checklist on behalf of a connected business account. On success, the edited :class:`aiogram.types.message.Message` is returned.",
"html_description":"<td>A JSON-serialized object for the new <a href=\"/bots/features#inline-keyboards\">inline keyboard</a> for the message</td>",
"rst_description":"A JSON-serialized object for the new `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ for the message\n",
"description":"Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
"html_description":"<p>Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
"rst_description":"Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
"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":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"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"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the message to edit",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Identifier of the message to edit</td>",
"rst_description":"Required if *inline_message_id* is not specified. Identifier of the message to edit\n",
"description":"Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.",
"html_description":"<p>Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
"description":"Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future",
"html_description":"<td>Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future</td>",
"rst_description":"Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future\n",
"description":"Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.",
"html_description":"<p>Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
"description":"Comment for the creator of the suggested post; 0-128 characters",
"html_description":"<td>Comment for the creator of the suggested post; 0-128 characters</td>",
"rst_description":"Comment for the creator of the suggested post; 0-128 characters\n",
"name":"comment"
}
],
"category":"methods"
},
{
"anchor":"deletemessage",
"name":"deleteMessage",
"description":"Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n- Bots can delete incoming messages in private chats.\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.\n- If the bot is an administrator of a group, it can delete any message there.\n- If the bot has can_delete_messages administrator right in a supergroup or a channel, it can delete any message there.\n- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.\nReturns True on success.",
"html_description":"<p>Use this method to delete a message, including service messages, with the following limitations:<br/>\n- A message can only be deleted if it was sent less than 48 hours ago.<br/>\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.<br/>\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.<br/>\n- Bots can delete outgoing messages in private chats, groups, and supergroups.<br/>\n- Bots can delete incoming messages in private chats.<br/>\n- Bots granted <em>can_post_messages</em> permissions can delete outgoing messages in channels.<br/>\n- If the bot is an administrator of a group, it can delete any message there.<br/>\n- If the bot has <em>can_delete_messages</em> administrator right in a supergroup or a channel, it can delete any message there.<br/>\n- If the bot has <em>can_manage_direct_messages</em> administrator right in a channel, it can delete any message in the corresponding direct messages chat.<br/>\nReturns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete a message, including service messages, with the following limitations:\n\n- A message can only be deleted if it was sent less than 48 hours ago.\n\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n\n- Bots can delete incoming messages in private chats.\n\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n\n- If the bot is an administrator of a group, it can delete any message there.\n\n- If the bot has *can_delete_messages* administrator right in a supergroup or a channel, it can delete any message there.\n\n- If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat.\n\nReturns :code:`True` on success.",
"description":"Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.",
"html_description":"<p>Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns :code:`True` on success.",
"description":"A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted",
"html_description":"<td>A JSON-serialized list of 1-100 identifiers of messages to delete. See <a href=\"#deletemessage\">deleteMessage</a> for limitations on which messages can be deleted</td>",
"rst_description":"A JSON-serialized list of 1-100 identifiers of messages to delete. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
"description":"The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots.\nPlease note, that it is currently only possible to edit messages without reply_markup or with inline keyboards."
},
{
"title":"Stickers",
"anchor":"stickers",
"children":[
{
"anchor":"sticker",
"name":"Sticker",
"description":"This object represents a sticker.",
"html_description":"<p>This object represents a sticker.</p>",
"rst_description":"This object represents a sticker.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"file_unique_id",
"required":true
},
{
"type":"String",
"description":"Type of the sticker, currently one of 'regular', 'mask', 'custom_emoji'. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.",
"html_description":"<td>Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields <em>is_animated</em> and <em>is_video</em>.</td>",
"rst_description":"Type of the sticker, currently one of 'regular', 'mask', 'custom_emoji'. The type of the sticker is independent from its format, which is determined by the fields *is_animated* and *is_video*.\n",
"name":"type",
"required":true
},
{
"type":"Integer",
"description":"Sticker width",
"html_description":"<td>Sticker width</td>",
"rst_description":"Sticker width\n",
"name":"width",
"required":true
},
{
"type":"Integer",
"description":"Sticker height",
"html_description":"<td>Sticker height</td>",
"rst_description":"Sticker height\n",
"name":"height",
"required":true
},
{
"type":"Boolean",
"description":"True, if the sticker is animated",
"html_description":"<td><em>True</em>, if the sticker is <a href=\"https://telegram.org/blog/animated-stickers\">animated</a></td>",
"rst_description":":code:`True`, if the sticker is `animated <https://telegram.org/blog/animated-stickers>`_\n",
"name":"is_animated",
"required":true
},
{
"type":"Boolean",
"description":"True, if the sticker is a video sticker",
"html_description":"<td><em>True</em>, if the sticker is a <a href=\"https://telegram.org/blog/video-stickers-better-reactions\">video sticker</a></td>",
"rst_description":":code:`True`, if the sticker is a `video sticker <https://telegram.org/blog/video-stickers-better-reactions>`_\n",
"name":"is_video",
"required":true
},
{
"type":"PhotoSize",
"description":"Sticker thumbnail in the .WEBP or .JPG format",
"html_description":"<td><em>Optional</em>. Sticker thumbnail in the .WEBP or .JPG format</td>",
"rst_description":"*Optional*. Sticker thumbnail in the .WEBP or .JPG format\n",
"description":"True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places",
"html_description":"<td><em>Optional</em>. <em>True</em>, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places</td>",
"rst_description":"*Optional*. :code:`True`, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places\n",
"description":"This object describes the position on faces where a mask should be placed by default.",
"html_description":"<p>This object describes the position on faces where a mask should be placed by default.</p>",
"rst_description":"This object describes the position on faces where a mask should be placed by default.",
"annotations":[
{
"type":"String",
"description":"The part of the face relative to which the mask should be placed. One of 'forehead', 'eyes', 'mouth', or 'chin'.",
"html_description":"<td>The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.</td>",
"rst_description":"The part of the face relative to which the mask should be placed. One of 'forehead', 'eyes', 'mouth', or 'chin'.\n",
"description":"Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.",
"html_description":"<td>Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.</td>",
"rst_description":"Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.\n",
"description":"Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.",
"html_description":"<td>Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.</td>",
"rst_description":"Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.\n",
"description":"The added sticker. 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 pass 'attach://<file_attach_name>' to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files",
"html_description":"<td>The added sticker. Pass a <em>file_id</em> 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 pass “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"The added sticker. 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 pass 'attach://<file_attach_name>' to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. :ref:`More information on Sending Files » <sending-files>`\n",
"description":"Format of the added sticker, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, 'video' for a .WEBM video",
"html_description":"<td>Format of the added sticker, must be one of “static” for a <strong>.WEBP</strong> or <strong>.PNG</strong> image, “animated” for a <strong>.TGS</strong> animation, “video” for a <strong>.WEBM</strong> video</td>",
"rst_description":"Format of the added sticker, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, 'video' for a **.WEBM** video\n",
"description":"List of 1-20 emoji associated with the sticker",
"html_description":"<td>List of 1-20 emoji associated with the sticker</td>",
"rst_description":"List of 1-20 emoji associated with the sticker\n",
"name":"emoji_list",
"required":true
},
{
"type":"MaskPosition",
"description":"Position where the mask should be placed on faces. For 'mask' stickers only.",
"html_description":"<td><em>Optional</em>. Position where the mask should be placed on faces. For “mask” stickers only.</td>",
"rst_description":"*Optional*. Position where the mask should be placed on faces. For 'mask' stickers only.\n",
"name":"mask_position",
"required":false
},
{
"type":"Array of String",
"description":"List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.",
"html_description":"<td><em>Optional</em>. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.</td>",
"rst_description":"*Optional*. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For 'regular' and 'custom_emoji' stickers only.\n",
"description":"Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send static .WEBP, <a href=\"https://telegram.org/blog/animated-stickers\">animated</a> .TGS, or <a href=\"https://telegram.org/blog/video-stickers-better-reactions\">video</a> .WEBM stickers. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to send static .WEBP, `animated <https://telegram.org/blog/animated-stickers>`_ .TGS, or `video <https://telegram.org/blog/video-stickers-better-reactions>`_ .WEBM stickers. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files. Video and animated stickers can't be sent via an HTTP URL.",
"html_description":"<td>Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. <a href=\"#sending-files\">More information on Sending Files »</a>. Video and animated stickers can't be sent via an HTTP URL.</td>",
"rst_description":"Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. :ref:`More information on Sending Files » <sending-files>`. Video and animated stickers can't be sent via an HTTP URL.\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
"html_description":"<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
"rst_description":"Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
"description":"Use this method to get a sticker set. On success, a StickerSet object is returned.",
"html_description":"<p>Use this method to get a sticker set. On success, a <a href=\"#stickerset\">StickerSet</a> object is returned.</p>",
"rst_description":"Use this method to get a sticker set. On success, a :class:`aiogram.types.sticker_set.StickerSet` object is returned.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Name of the sticker set",
"html_description":"<td>Name of the sticker set</td>",
"rst_description":"Name of the sticker set\n",
"name":"name"
}
],
"category":"methods"
},
{
"anchor":"getcustomemojistickers",
"name":"getCustomEmojiStickers",
"description":"Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.",
"html_description":"<p>Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of <a href=\"#sticker\">Sticker</a> objects.</p>",
"rst_description":"Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of :class:`aiogram.types.sticker.Sticker` objects.",
"description":"Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.",
"html_description":"<p>Use this method to upload a file with a sticker for later use in the <a href=\"#createnewstickerset\">createNewStickerSet</a>, <a href=\"#addstickertoset\">addStickerToSet</a>, or <a href=\"#replacestickerinset\">replaceStickerInSet</a> methods (the file can be used multiple times). Returns the uploaded <a href=\"#file\">File</a> on success.</p>",
"rst_description":"Use this method to upload a file with a sticker for later use in the :class:`aiogram.methods.create_new_sticker_set.CreateNewStickerSet`, :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet`, or :class:`aiogram.methods.replace_sticker_in_set.ReplaceStickerInSet` methods (the file can be used multiple times). Returns the uploaded :class:`aiogram.types.file.File` on success.",
"description":"A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files",
"html_description":"<td>A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See <a href=\"/stickers\"/><a href=\"https://core.telegram.org/stickers\">https://core.telegram.org/stickers</a> for technical requirements. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
"rst_description":"A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See `https://core.telegram.org/stickers <https://core.telegram.org/stickers>`_`https://core.telegram.org/stickers <https://core.telegram.org/stickers>`_ for technical requirements. :ref:`More information on Sending Files » <sending-files>`\n",
"name":"sticker"
},
{
"type":"String",
"required":true,
"description":"Format of the sticker, must be one of 'static', 'animated', 'video'",
"html_description":"<td>Format of the sticker, must be one of “static”, “animated”, “video”</td>",
"rst_description":"Format of the sticker, must be one of 'static', 'animated', 'video'\n",
"description":"Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.",
"html_description":"<p>Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns :code:`True` on success.",
"description":"User identifier of created sticker set owner",
"html_description":"<td>User identifier of created sticker set owner</td>",
"rst_description":"User identifier of created sticker set owner\n",
"name":"user_id"
},
{
"type":"String",
"required":true,
"description":"Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in \"_by_<bot_username>\". <bot_username> is case insensitive. 1-64 characters.",
"html_description":"<td>Short name of sticker set, to be used in <code>t.me/addstickers/</code> URLs (e.g., <em>animals</em>). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in <code>\"_by_<bot_username>\"</code>. <code><bot_username></code> is case insensitive. 1-64 characters.</td>",
"rst_description":"Short name of sticker set, to be used in :code:`t.me/addstickers/` URLs (e.g., *animals*). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in :code:`\"_by_<bot_username>\"`. :code:`<bot_username>` is case insensitive. 1-64 characters.\n",
"name":"name"
},
{
"type":"String",
"required":true,
"description":"Sticker set title, 1-64 characters",
"html_description":"<td>Sticker set title, 1-64 characters</td>",
"rst_description":"Sticker set title, 1-64 characters\n",
"description":"Type of stickers in the set, pass 'regular', 'mask', or 'custom_emoji'. By default, a regular sticker set is created.",
"html_description":"<td>Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.</td>",
"rst_description":"Type of stickers in the set, pass 'regular', 'mask', or 'custom_emoji'. By default, a regular sticker set is created.\n",
"description":"Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only",
"html_description":"<td>Pass <em>True</em> if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only</td>",
"rst_description":"Pass :code:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only\n",
"description":"Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.",
"html_description":"<p>Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
"description":"A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.",
"html_description":"<td>A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.</td>",
"rst_description":"A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.\n",
"description":"Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.",
"html_description":"<p>Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling <a href=\"#deletestickerfromset\">deleteStickerFromSet</a>, then <a href=\"#addstickertoset\">addStickerToSet</a>, then <a href=\"#setstickerpositioninset\">setStickerPositionInSet</a>. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling :class:`aiogram.methods.delete_sticker_from_set.DeleteStickerFromSet`, then :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet`, then :class:`aiogram.methods.set_sticker_position_in_set.SetStickerPositionInSet`. Returns :code:`True` on success.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"User identifier of the sticker set owner",
"html_description":"<td>User identifier of the sticker set owner</td>",
"rst_description":"User identifier of the sticker set owner\n",
"name":"user_id"
},
{
"type":"String",
"required":true,
"description":"Sticker set name",
"html_description":"<td>Sticker set name</td>",
"rst_description":"Sticker set name\n",
"name":"name"
},
{
"type":"String",
"required":true,
"description":"File identifier of the replaced sticker",
"html_description":"<td>File identifier of the replaced sticker</td>",
"rst_description":"File identifier of the replaced sticker\n",
"name":"old_sticker"
},
{
"type":"InputSticker",
"required":true,
"description":"A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.",
"html_description":"<td>A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.</td>",
"rst_description":"A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.\n",
"description":"Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.",
"html_description":"<p>Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"File identifier of the sticker",
"html_description":"<td>File identifier of the sticker</td>",
"rst_description":"File identifier of the sticker\n",
"name":"sticker"
},
{
"type":"Array of String",
"required":true,
"description":"A JSON-serialized list of 1-20 emoji associated with the sticker",
"html_description":"<td>A JSON-serialized list of 1-20 emoji associated with the sticker</td>",
"rst_description":"A JSON-serialized list of 1-20 emoji associated with the sticker\n",
"name":"emoji_list"
}
],
"category":"methods"
},
{
"anchor":"setstickerkeywords",
"name":"setStickerKeywords",
"description":"Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.",
"html_description":"<p>Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"File identifier of the sticker",
"html_description":"<td>File identifier of the sticker</td>",
"rst_description":"File identifier of the sticker\n",
"name":"sticker"
},
{
"type":"Array of String",
"required":false,
"description":"A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters",
"html_description":"<td>A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters</td>",
"rst_description":"A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters\n",
"name":"keywords"
}
],
"category":"methods"
},
{
"anchor":"setstickermaskposition",
"name":"setStickerMaskPosition",
"description":"Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.",
"html_description":"<p>Use this method to change the <a href=\"#maskposition\">mask position</a> of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to change the `mask position <https://core.telegram.org/bots/api#maskposition>`_ of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"File identifier of the sticker",
"html_description":"<td>File identifier of the sticker</td>",
"rst_description":"File identifier of the sticker\n",
"name":"sticker"
},
{
"type":"MaskPosition",
"required":false,
"description":"A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.",
"html_description":"<td>A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.</td>",
"rst_description":"A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.\n",
"name":"mask_position"
}
],
"category":"methods"
},
{
"anchor":"setstickersettitle",
"name":"setStickerSetTitle",
"description":"Use this method to set the title of a created sticker set. Returns True on success.",
"html_description":"<p>Use this method to set the title of a created sticker set. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to set the title of a created sticker set. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Sticker set name",
"html_description":"<td>Sticker set name</td>",
"rst_description":"Sticker set name\n",
"name":"name"
},
{
"type":"String",
"required":true,
"description":"Sticker set title, 1-64 characters",
"html_description":"<td>Sticker set title, 1-64 characters</td>",
"rst_description":"Sticker set title, 1-64 characters\n",
"name":"title"
}
],
"category":"methods"
},
{
"anchor":"setstickersetthumbnail",
"name":"setStickerSetThumbnail",
"description":"Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.",
"html_description":"<p>Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns :code:`True` on success.",
"description":"A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-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-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
"html_description":"<td>A <strong>.WEBP</strong> or <strong>.PNG</strong> image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a <strong>.TGS</strong> animation with a thumbnail up to 32 kilobytes in size (see <a href=\"/stickers#animation-requirements\"/><a href=\"https://core.telegram.org/stickers#animation-requirements\">https://core.telegram.org/stickers#animation-requirements</a> for animated sticker technical requirements), or a <strong>.WEBM</strong> video with the thumbnail up to 32 kilobytes in size; see <a href=\"/stickers#video-requirements\"/><a href=\"https://core.telegram.org/stickers#video-requirements\">https://core.telegram.org/stickers#video-requirements</a> for video sticker technical requirements. Pass a <em>file_id</em> 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. <a href=\"#sending-files\">More information on Sending Files »</a>. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.</td>",
"rst_description":"A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-requirements>`_`https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-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-requirements <https://core.telegram.org/stickers#video-requirements>`_`https://core.telegram.org/stickers#video-requirements <https://core.telegram.org/stickers#video-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 » <sending-files>`. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
"description":"Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a .WEBM video",
"html_description":"<td>Format of the thumbnail, must be one of “static” for a <strong>.WEBP</strong> or <strong>.PNG</strong> image, “animated” for a <strong>.TGS</strong> animation, or “video” for a <strong>.WEBM</strong> video</td>",
"rst_description":"Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **.WEBM** video\n",
"description":"Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.",
"html_description":"<p>Use this method to set the thumbnail of a custom emoji sticker set. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to set the thumbnail of a custom emoji sticker set. Returns :code:`True` on success.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Sticker set name",
"html_description":"<td>Sticker set name</td>",
"rst_description":"Sticker set name\n",
"name":"name"
},
{
"type":"String",
"required":false,
"description":"Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.",
"html_description":"<td>Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.</td>",
"rst_description":"Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.\n",
"name":"custom_emoji_id"
}
],
"category":"methods"
},
{
"anchor":"deletestickerset",
"name":"deleteStickerSet",
"description":"Use this method to delete a sticker set that was created by the bot. Returns True on success.",
"html_description":"<p>Use this method to delete a sticker set that was created by the bot. Returns <em>True</em> on success.</p>",
"rst_description":"Use this method to delete a sticker set that was created by the bot. Returns :code:`True` on success.",
"description":"The following methods and objects allow your bot to handle stickers and sticker sets."
},
{
"title":"Inline mode",
"anchor":"inline-mode",
"children":[
{
"anchor":"inlinequery",
"name":"InlineQuery",
"description":"This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.",
"html_description":"<p>This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.</p>",
"rst_description":"This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.",
"annotations":[
{
"type":"String",
"description":"Unique identifier for this query",
"html_description":"<td>Unique identifier for this query</td>",
"rst_description":"Unique identifier for this query\n",
"name":"id",
"required":true
},
{
"type":"User",
"description":"Sender",
"html_description":"<td>Sender</td>",
"rst_description":"Sender\n",
"name":"from",
"required":true
},
{
"type":"String",
"description":"Text of the query (up to 256 characters)",
"html_description":"<td>Text of the query (up to 256 characters)</td>",
"rst_description":"Text of the query (up to 256 characters)\n",
"name":"query",
"required":true
},
{
"type":"String",
"description":"Offset of the results to be returned, can be controlled by the bot",
"html_description":"<td>Offset of the results to be returned, can be controlled by the bot</td>",
"rst_description":"Offset of the results to be returned, can be controlled by the bot\n",
"name":"offset",
"required":true
},
{
"type":"String",
"description":"Type of the chat from which the inline query was sent. Can be either 'sender' for a private chat with the inline query sender, 'private', 'group', 'supergroup', or 'channel'. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat",
"html_description":"<td><em>Optional</em>. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat</td>",
"rst_description":"*Optional*. Type of the chat from which the inline query was sent. Can be either 'sender' for a private chat with the inline query sender, 'private', 'group', 'supergroup', or 'channel'. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat\n",
"name":"chat_type",
"required":false
},
{
"type":"Location",
"description":"Sender location, only for bots that request user location",
"html_description":"<td><em>Optional</em>. Sender location, only for bots that request user location</td>",
"rst_description":"*Optional*. Sender location, only for bots that request user location\n",
"name":"location",
"required":false
}
],
"category":"types"
},
{
"anchor":"answerinlinequery",
"name":"answerInlineQuery",
"description":"Use this method to send answers to an inline query. On success, True is returned.\nNo more than 50 results per query are allowed.",
"html_description":"<p>Use this method to send answers to an inline query. On success, <em>True</em> is returned.<br/>\nNo more than <strong>50</strong> results per query are allowed.</p>",
"rst_description":"Use this method to send answers to an inline query. On success, :code:`True` is returned.\n\nNo more than **50** results per query are allowed.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier for the answered query",
"html_description":"<td>Unique identifier for the answered query</td>",
"rst_description":"Unique identifier for the answered query\n",
"name":"inline_query_id"
},
{
"type":"Array of InlineQueryResult",
"required":true,
"description":"A JSON-serialized array of results for the inline query",
"html_description":"<td>A JSON-serialized array of results for the inline query</td>",
"rst_description":"A JSON-serialized array of results for the inline query\n",
"name":"results"
},
{
"type":"Integer",
"required":false,
"description":"The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.",
"html_description":"<td>The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.</td>",
"rst_description":"The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.\n",
"description":"Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.",
"html_description":"<td>Pass <em>True</em> if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.</td>",
"rst_description":"Pass :code:`True` if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.\n",
"description":"Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.",
"html_description":"<td>Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.</td>",
"rst_description":"Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes.\n",
"description":"A JSON-serialized object describing a button to be shown above inline query results",
"html_description":"<td>A JSON-serialized object describing a button to be shown above inline query results</td>",
"rst_description":"A JSON-serialized object describing a button to be shown above inline query results\n",
"name":"button"
}
],
"category":"methods"
},
{
"anchor":"inlinequeryresultsbutton",
"name":"InlineQueryResultsButton",
"description":"This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.",
"html_description":"<p>This object represents a button to be shown above inline query results. You <strong>must</strong> use exactly one of the optional fields.</p>",
"rst_description":"This object represents a button to be shown above inline query results. You **must** use exactly one of the optional fields.",
"annotations":[
{
"type":"String",
"description":"Label text on the button",
"html_description":"<td>Label text on the button</td>",
"description":"Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.",
"html_description":"<td><em>Optional</em>. Description of the <a href=\"/bots/webapps\">Web App</a> that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method <a href=\"/bots/webapps#initializing-mini-apps\">switchInlineQuery</a> inside the Web App.</td>",
"rst_description":"*Optional*. Description of the `Web App <https://core.telegram.org/bots/webapps>`_ that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method `switchInlineQuery <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_ inside the Web App.\n",
"description":"Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.\n\nExample: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#deep-linking\">Deep-linking</a> parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only <code>A-Z</code>, <code>a-z</code>, <code>0-9</code>, <code>_</code> and <code>-</code> are allowed.<br/>\n<br/>\n<em>Example:</em> An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a <a href=\"#inlinekeyboardmarkup\"><em>switch_inline</em></a> button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.</td>",
"rst_description":"*Optional*. `Deep-linking <https://core.telegram.org/bots/features#deep-linking>`_ parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only :code:`A-Z`, :code:`a-z`, :code:`0-9`, :code:`_` and :code:`-` are allowed.\n\n\n\n*Example:* An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a `https://core.telegram.org/bots/api#inlinekeyboardmarkup <https://core.telegram.org/bots/api#inlinekeyboardmarkup>`_ *switch_inline* button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.\n",
"description":"This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:\n - InlineQueryResultCachedAudio\n - InlineQueryResultCachedDocument\n - InlineQueryResultCachedGif\n - InlineQueryResultCachedMpeg4Gif\n - InlineQueryResultCachedPhoto\n - InlineQueryResultCachedSticker\n - InlineQueryResultCachedVideo\n - InlineQueryResultCachedVoice\n - InlineQueryResultArticle\n - InlineQueryResultAudio\n - InlineQueryResultContact\n - InlineQueryResultGame\n - InlineQueryResultDocument\n - InlineQueryResultGif\n - InlineQueryResultLocation\n - InlineQueryResultMpeg4Gif\n - InlineQueryResultPhoto\n - InlineQueryResultVenue\n - InlineQueryResultVideo\n - InlineQueryResultVoice\nNote: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.",
"html_description":"<p>This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:</p><ul>\n<li><a href=\"#inlinequeryresultcachedaudio\">InlineQueryResultCachedAudio</a></li>\n<li><a href=\"#inlinequeryresultcacheddocument\">InlineQueryResultCachedDocument</a></li>\n<li><a href=\"#inlinequeryresultcachedgif\">InlineQueryResultCachedGif</a></li>\n<li><a href=\"#inlinequeryresultcachedmpeg4gif\">InlineQueryResultCachedMpeg4Gif</a></li>\n<li><a href=\"#inlinequeryresultcachedphoto\">InlineQueryResultCachedPhoto</a></li>\n<li><a href=\"#inlinequeryresultcachedsticker\">InlineQueryResultCachedSticker</a></li>\n<li><a href=\"#inlinequeryresultcachedvideo\">InlineQueryResultCachedVideo</a></li>\n<li><a href=\"#inlinequeryresultcachedvoice\">InlineQueryResultCachedVoice</a></li>\n<li><a href=\"#inlinequeryresultarticle\">InlineQueryResultArticle</a></li>\n<li><a href=\"#inlinequeryresultaudio\">InlineQueryResultAudio</a></li>\n<li><a href=\"#inlinequeryresultcontact\">InlineQueryResultContact</a></li>\n<li><a href=\"#inlinequeryresultgame\">InlineQueryResultGame</a></li>\n<li><a href=\"#inlinequeryresultdocument\">InlineQueryResultDocument</a></li>\n<li><a href=\"#inlinequeryresultgif\">InlineQueryResultGif</a></li>\n<li><a href=\"#inlinequeryresultlocation\">InlineQueryResultLocation</a></li>\n<li><a href=\"#inlinequeryresultmpeg4gif\">InlineQueryResultMpeg4Gif</a></li>\n<li><a href=\"#inlinequeryresultphoto\">InlineQueryResultPhoto</a></li>\n<li><a href=\"#inlinequeryresultvenue\">InlineQueryResultVenue</a></li>\n<li><a href=\"#inlinequeryresultvideo\">InlineQueryResultVideo</a></li>\n<li><a href=\"#inlinequeryresultvoice\">InlineQueryResultVoice</a></li>\n</ul><p><strong>Note:</strong> All URLs passed in inline query results will be available to end users and therefore must be assumed to be <strong>public</strong>.</p>",
"rst_description":"This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:\n\n - :class:`aiogram.types.inline_query_result_cached_audio.InlineQueryResultCachedAudio`\n - :class:`aiogram.types.inline_query_result_cached_document.InlineQueryResultCachedDocument`\n - :class:`aiogram.types.inline_query_result_cached_gif.InlineQueryResultCachedGif`\n - :class:`aiogram.types.inline_query_result_cached_mpeg4_gif.InlineQueryResultCachedMpeg4Gif`\n - :class:`aiogram.types.inline_query_result_cached_photo.InlineQueryResultCachedPhoto`\n - :class:`aiogram.types.inline_query_result_cached_sticker.InlineQueryResultCachedSticker`\n - :class:`aiogram.types.inline_query_result_cached_video.InlineQueryResultCachedVideo`\n - :class:`aiogram.types.inline_query_result_cached_voice.InlineQueryResultCachedVoice`\n - :class:`aiogram.types.inline_query_result_article.InlineQueryResultArticle`\n - :class:`aiogram.types.inline_query_result_audio.InlineQueryResultAudio`\n - :class:`aiogram.types.inline_query_result_contact.InlineQueryResultContact`\n - :class:`aiogram.types.inline_query_result_game.InlineQueryResultGame`\n - :class:`aiogram.types.inline_query_result_document.InlineQueryResultDocument`\n - :class:`aiogram.types.inline_query_result_gif.InlineQueryResultGif`\n - :class:`aiogram.types.inline_query_result_location.InlineQueryResultLocation`\n - :class:`aiogram.types.inline_query_result_mpeg4_gif.InlineQueryResultMpeg4Gif`\n - :class:`aiogram.types.inline_query_result_photo.InlineQueryResultPhoto`\n - :class:`aiogram.types.inline_query_result_venue.InlineQueryResultVenue`\n - :class:`aiogram.types.inline_query_result_video.InlineQueryResultVideo`\n - :class:`aiogram.types.inline_query_result_voice.InlineQueryResultVoice`\n\n**Note:** All URLs passed in inline query results will be available to end users and therefore must be assumed to be **public**.",
"annotations":[],
"category":"types"
},
{
"anchor":"inlinequeryresultarticle",
"name":"InlineQueryResultArticle",
"description":"Represents a link to an article or web page.",
"html_description":"<p>Represents a link to an article or web page.</p>",
"rst_description":"Represents a link to an article or web page.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be article",
"html_description":"<td>Type of the result, must be <em>article</em></td>",
"rst_description":"Type of the result, must be *article*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 Bytes",
"html_description":"<td>Unique identifier for this result, 1-64 Bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 Bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Title of the result",
"html_description":"<td>Title of the result</td>",
"rst_description":"Title of the result\n",
"name":"title",
"required":true
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent",
"html_description":"<td>Content of the message to be sent</td>",
"rst_description":"Content of the message to be sent\n",
"name":"input_message_content",
"required":true
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"String",
"description":"URL of the result",
"html_description":"<td><em>Optional</em>. URL of the result</td>",
"rst_description":"*Optional*. URL of the result\n",
"name":"url",
"required":false
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"String",
"description":"Url of the thumbnail for the result",
"html_description":"<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description":"*Optional*. Url of the thumbnail for the result\n",
"description":"Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.",
"html_description":"<p>Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the photo.</p>",
"rst_description":"Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the photo.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be photo",
"html_description":"<td>Type of the result, must be <em>photo</em></td>",
"rst_description":"Type of the result, must be *photo*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB",
"html_description":"<td>A valid URL of the photo. Photo must be in <strong>JPEG</strong> format. Photo size must not exceed 5MB</td>",
"rst_description":"A valid URL of the photo. Photo must be in **JPEG** format. Photo size must not exceed 5MB\n",
"name":"photo_url",
"required":true
},
{
"type":"String",
"description":"URL of the thumbnail for the photo",
"html_description":"<td>URL of the thumbnail for the photo</td>",
"rst_description":"URL of the thumbnail for the photo\n",
"html_description":"<td><em>Optional</em>. Width of the photo</td>",
"rst_description":"*Optional*. Width of the photo\n",
"name":"photo_width",
"required":false
},
{
"type":"Integer",
"description":"Height of the photo",
"html_description":"<td><em>Optional</em>. Height of the photo</td>",
"rst_description":"*Optional*. Height of the photo\n",
"name":"photo_height",
"required":false
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"String",
"description":"Caption of the photo to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the photo caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the photo",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the photo</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the photo\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultgif",
"name":"InlineQueryResultGif",
"description":"Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.",
"html_description":"<p>Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the animation.</p>",
"rst_description":"Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be gif",
"html_description":"<td>Type of the result, must be <em>gif</em></td>",
"rst_description":"Type of the result, must be *gif*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"description":"MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description":"<td><em>Optional</em>. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”</td>",
"rst_description":"*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Caption of the GIF file to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the GIF animation",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the GIF animation</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the GIF animation\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultmpeg4gif",
"name":"InlineQueryResultMpeg4Gif",
"description":"Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.",
"html_description":"<p>Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the animation.</p>",
"rst_description":"Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be mpeg4_gif",
"html_description":"<td>Type of the result, must be <em>mpeg4_gif</em></td>",
"rst_description":"Type of the result, must be *mpeg4_gif*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"description":"MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'",
"html_description":"<td><em>Optional</em>. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”</td>",
"rst_description":"*Optional*. MIME type of the thumbnail, must be one of 'image/jpeg', 'image/gif', or 'video/mp4'. Defaults to 'image/jpeg'\n",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the video animation",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the video animation</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the video animation\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultvideo",
"name":"InlineQueryResultVideo",
"description":"Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.\nIf an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.",
"html_description":"<p>Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the video.</p><blockquote>\n<p>If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you <strong>must</strong> replace its content using <em>input_message_content</em>.</p>\n</blockquote>",
"rst_description":"Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the video.\n\n If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you **must** replace its content using *input_message_content*.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be video",
"html_description":"<td>Type of the result, must be <em>video</em></td>",
"rst_description":"Type of the result, must be *video*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid URL for the embedded video player or video file",
"html_description":"<td>A valid URL for the embedded video player or video file</td>",
"rst_description":"A valid URL for the embedded video player or video file\n",
"name":"video_url",
"required":true
},
{
"type":"String",
"description":"MIME type of the content of the video URL, 'text/html' or 'video/mp4'",
"html_description":"<td>MIME type of the content of the video URL, “text/html” or “video/mp4”</td>",
"rst_description":"MIME type of the content of the video URL, 'text/html' or 'video/mp4'\n",
"name":"mime_type",
"required":true
},
{
"type":"String",
"description":"URL of the thumbnail (JPEG only) for the video",
"html_description":"<td>URL of the thumbnail (JPEG only) for the video</td>",
"rst_description":"URL of the thumbnail (JPEG only) for the video\n",
"html_description":"<td>Title for the result</td>",
"rst_description":"Title for the result\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Caption of the video to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the video to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the video caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the video caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the video caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"html_description":"<td><em>Optional</em>. Video width</td>",
"rst_description":"*Optional*. Video width\n",
"name":"video_width",
"required":false
},
{
"type":"Integer",
"description":"Video height",
"html_description":"<td><em>Optional</em>. Video height</td>",
"rst_description":"*Optional*. Video height\n",
"name":"video_height",
"required":false
},
{
"type":"Integer",
"description":"Video duration in seconds",
"html_description":"<td><em>Optional</em>. Video duration in seconds</td>",
"rst_description":"*Optional*. Video duration in seconds\n",
"name":"video_duration",
"required":false
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the video. This field is <strong>required</strong> if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the video. This field is **required** if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).\n",
"description":"Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.",
"html_description":"<p>Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the audio.</p>",
"rst_description":"Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio.",
"description":"Type of the result, must be audio",
"html_description":"<td>Type of the result, must be <em>audio</em></td>",
"rst_description":"Type of the result, must be *audio*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid URL for the audio file",
"html_description":"<td>A valid URL for the audio file</td>",
"rst_description":"A valid URL for the audio file\n",
"name":"audio_url",
"required":true
},
{
"type":"String",
"description":"Title",
"html_description":"<td>Title</td>",
"rst_description":"Title\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Caption, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the audio caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.",
"html_description":"<p>Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the the voice message.</p>",
"rst_description":"Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the the voice message.",
"description":"Type of the result, must be voice",
"html_description":"<td>Type of the result, must be <em>voice</em></td>",
"rst_description":"Type of the result, must be *voice*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid URL for the voice recording",
"html_description":"<td>A valid URL for the voice recording</td>",
"rst_description":"A valid URL for the voice recording\n",
"name":"voice_url",
"required":true
},
{
"type":"String",
"description":"Recording title",
"html_description":"<td>Recording title</td>",
"rst_description":"Recording title\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Caption, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the voice message caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the voice message caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the voice message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"Integer",
"description":"Recording duration in seconds",
"html_description":"<td><em>Optional</em>. Recording duration in seconds</td>",
"rst_description":"*Optional*. Recording duration in seconds\n",
"name":"voice_duration",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the voice recording",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the voice recording</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the voice recording\n",
"description":"Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.",
"html_description":"<p>Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the file. Currently, only <strong>.PDF</strong> and <strong>.ZIP</strong> files can be sent using this method.</p>",
"rst_description":"Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method.",
"description":"Type of the result, must be document",
"html_description":"<td>Type of the result, must be <em>document</em></td>",
"rst_description":"Type of the result, must be *document*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td>Title for the result</td>",
"rst_description":"Title for the result\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Caption of the document to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the document to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"String",
"description":"A valid URL for the file",
"html_description":"<td>A valid URL for the file</td>",
"rst_description":"A valid URL for the file\n",
"name":"document_url",
"required":true
},
{
"type":"String",
"description":"MIME type of the content of the file, either 'application/pdf' or 'application/zip'",
"html_description":"<td>MIME type of the content of the file, either “application/pdf” or “application/zip”</td>",
"rst_description":"MIME type of the content of the file, either 'application/pdf' or 'application/zip'\n",
"name":"mime_type",
"required":true
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"description":"Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.",
"html_description":"<p>Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the location.</p>",
"rst_description":"Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the location.",
"description":"Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description":"<td><em>Optional</em>. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description":"*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"description":"For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"html_description":"<td><em>Optional</em>. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.</td>",
"rst_description":"*Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
"name":"heading",
"required":false
},
{
"type":"Integer",
"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":"<td><em>Optional</em>. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
"rst_description":"*Optional*. 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",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the location",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the location</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the location\n",
"name":"input_message_content",
"required":false
},
{
"type":"String",
"description":"Url of the thumbnail for the result",
"html_description":"<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description":"*Optional*. Url of the thumbnail for the result\n",
"description":"Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.",
"html_description":"<p>Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the venue.</p>",
"rst_description":"Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the venue.",
"description":"Type of the result, must be venue",
"html_description":"<td>Type of the result, must be <em>venue</em></td>",
"rst_description":"Type of the result, must be *venue*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 Bytes",
"html_description":"<td>Unique identifier for this result, 1-64 Bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 Bytes\n",
"name":"id",
"required":true
},
{
"type":"Float",
"description":"Latitude of the venue location in degrees",
"html_description":"<td>Latitude of the venue location in degrees</td>",
"rst_description":"Latitude of the venue location in degrees\n",
"name":"latitude",
"required":true
},
{
"type":"Float",
"description":"Longitude of the venue location in degrees",
"html_description":"<td>Longitude of the venue location in degrees</td>",
"rst_description":"Longitude of the venue location in degrees\n",
"name":"longitude",
"required":true
},
{
"type":"String",
"description":"Title of the venue",
"html_description":"<td>Title of the venue</td>",
"rst_description":"Title of the venue\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Address of the venue",
"html_description":"<td>Address of the venue</td>",
"rst_description":"Address of the venue\n",
"name":"address",
"required":true
},
{
"type":"String",
"description":"Foursquare identifier of the venue if known",
"html_description":"<td><em>Optional</em>. Foursquare identifier of the venue if known</td>",
"rst_description":"*Optional*. Foursquare identifier of the venue if known\n",
"name":"foursquare_id",
"required":false
},
{
"type":"String",
"description":"Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)",
"html_description":"<td><em>Optional</em>. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)</td>",
"rst_description":"*Optional*. Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)\n",
"name":"foursquare_type",
"required":false
},
{
"type":"String",
"description":"Google Places identifier of the venue",
"html_description":"<td><em>Optional</em>. Google Places identifier of the venue</td>",
"rst_description":"*Optional*. Google Places identifier of the venue\n",
"name":"google_place_id",
"required":false
},
{
"type":"String",
"description":"Google Places type of the venue. (See supported types.)",
"html_description":"<td><em>Optional</em>. Google Places type of the venue. (See <a href=\"https://developers.google.com/places/web-service/supported_types\">supported types</a>.)</td>",
"rst_description":"*Optional*. Google Places type of the venue. (See `supported types <https://developers.google.com/places/web-service/supported_types>`_.)\n",
"name":"google_place_type",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the venue",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the venue</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the venue\n",
"name":"input_message_content",
"required":false
},
{
"type":"String",
"description":"Url of the thumbnail for the result",
"html_description":"<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description":"*Optional*. Url of the thumbnail for the result\n",
"description":"Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.",
"html_description":"<p>Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the contact.</p>",
"rst_description":"Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the contact.",
"html_description":"<td>Contact's first name</td>",
"rst_description":"Contact's first name\n",
"name":"first_name",
"required":true
},
{
"type":"String",
"description":"Contact's last name",
"html_description":"<td><em>Optional</em>. Contact's last name</td>",
"rst_description":"*Optional*. Contact's last name\n",
"name":"last_name",
"required":false
},
{
"type":"String",
"description":"Additional data about the contact in the form of a vCard, 0-2048 bytes",
"html_description":"<td><em>Optional</em>. Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a>, 0-2048 bytes</td>",
"rst_description":"*Optional*. Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_, 0-2048 bytes\n",
"name":"vcard",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the contact",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the contact</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the contact\n",
"name":"input_message_content",
"required":false
},
{
"type":"String",
"description":"Url of the thumbnail for the result",
"html_description":"<td><em>Optional</em>. Url of the thumbnail for the result</td>",
"rst_description":"*Optional*. Url of the thumbnail for the result\n",
"html_description":"<td>Type of the result, must be <em>game</em></td>",
"rst_description":"Type of the result, must be *game*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Short name of the game",
"html_description":"<td>Short name of the game</td>",
"rst_description":"Short name of the game\n",
"name":"game_short_name",
"required":true
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultcachedphoto",
"name":"InlineQueryResultCachedPhoto",
"description":"Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.",
"html_description":"<p>Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the photo.</p>",
"rst_description":"Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the photo.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be photo",
"html_description":"<td>Type of the result, must be <em>photo</em></td>",
"rst_description":"Type of the result, must be *photo*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid file identifier of the photo",
"html_description":"<td>A valid file identifier of the photo</td>",
"rst_description":"A valid file identifier of the photo\n",
"name":"photo_file_id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"String",
"description":"Caption of the photo to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the photo to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the photo to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the photo caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the photo",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the photo</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the photo\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultcachedgif",
"name":"InlineQueryResultCachedGif",
"description":"Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.",
"html_description":"<p>Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with specified content instead of the animation.</p>",
"rst_description":"Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with specified content instead of the animation.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be gif",
"html_description":"<td>Type of the result, must be <em>gif</em></td>",
"rst_description":"Type of the result, must be *gif*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid file identifier for the GIF file",
"html_description":"<td>A valid file identifier for the GIF file</td>",
"rst_description":"A valid file identifier for the GIF file\n",
"name":"gif_file_id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Caption of the GIF file to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the GIF file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the GIF file to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the GIF animation",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the GIF animation</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the GIF animation\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultcachedmpeg4gif",
"name":"InlineQueryResultCachedMpeg4Gif",
"description":"Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.",
"html_description":"<p>Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the animation.</p>",
"rst_description":"Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be mpeg4_gif",
"html_description":"<td>Type of the result, must be <em>mpeg4_gif</em></td>",
"rst_description":"Type of the result, must be *mpeg4_gif*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid file identifier for the MPEG4 file",
"html_description":"<td>A valid file identifier for the MPEG4 file</td>",
"rst_description":"A valid file identifier for the MPEG4 file\n",
"name":"mpeg4_file_id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td><em>Optional</em>. Title for the result</td>",
"rst_description":"*Optional*. Title for the result\n",
"name":"title",
"required":false
},
{
"type":"String",
"description":"Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.",
"html_description":"<p>Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the sticker.</p>",
"rst_description":"Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the sticker.",
"description":"Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.",
"html_description":"<p>Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the file.</p>",
"rst_description":"Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file.",
"description":"Type of the result, must be document",
"html_description":"<td>Type of the result, must be <em>document</em></td>",
"rst_description":"Type of the result, must be *document*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td>Title for the result</td>",
"rst_description":"Title for the result\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"A valid file identifier for the file",
"html_description":"<td>A valid file identifier for the file</td>",
"rst_description":"A valid file identifier for the file\n",
"name":"document_file_id",
"required":true
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"String",
"description":"Caption of the document to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the document to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the document to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the document caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the document caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the document caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the file",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the file</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the file\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inlinequeryresultcachedvideo",
"name":"InlineQueryResultCachedVideo",
"description":"Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.",
"html_description":"<p>Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the video.</p>",
"rst_description":"Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the video.",
"annotations":[
{
"type":"String",
"description":"Type of the result, must be video",
"html_description":"<td>Type of the result, must be <em>video</em></td>",
"rst_description":"Type of the result, must be *video*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid file identifier for the video file",
"html_description":"<td>A valid file identifier for the video file</td>",
"rst_description":"A valid file identifier for the video file\n",
"name":"video_file_id",
"required":true
},
{
"type":"String",
"description":"Title for the result",
"html_description":"<td>Title for the result</td>",
"rst_description":"Title for the result\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Short description of the result",
"html_description":"<td><em>Optional</em>. Short description of the result</td>",
"rst_description":"*Optional*. Short description of the result\n",
"name":"description",
"required":false
},
{
"type":"String",
"description":"Caption of the video to be sent, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption of the video to be sent, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption of the video to be sent, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the video caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the video caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the video caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"description":"Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.",
"html_description":"<p>Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the voice message.</p>",
"rst_description":"Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the voice message.",
"description":"Caption, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the voice message caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the voice message caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the voice message caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the voice message",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the voice message</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the voice message\n",
"description":"Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.",
"html_description":"<p>Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use <em>input_message_content</em> to send a message with the specified content instead of the audio.</p>",
"rst_description":"Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio.",
"description":"Type of the result, must be audio",
"html_description":"<td>Type of the result, must be <em>audio</em></td>",
"rst_description":"Type of the result, must be *audio*\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this result, 1-64 bytes",
"html_description":"<td>Unique identifier for this result, 1-64 bytes</td>",
"rst_description":"Unique identifier for this result, 1-64 bytes\n",
"name":"id",
"required":true
},
{
"type":"String",
"description":"A valid file identifier for the audio file",
"html_description":"<td>A valid file identifier for the audio file</td>",
"rst_description":"A valid file identifier for the audio file\n",
"name":"audio_file_id",
"required":true
},
{
"type":"String",
"description":"Caption, 0-1024 characters after entities parsing",
"html_description":"<td><em>Optional</em>. Caption, 0-1024 characters after entities parsing</td>",
"rst_description":"*Optional*. Caption, 0-1024 characters after entities parsing\n",
"name":"caption",
"required":false
},
{
"type":"String",
"description":"Mode for parsing entities in the audio caption. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the audio caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the audio caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in the caption, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
"name":"caption_entities",
"required":false
},
{
"type":"InlineKeyboardMarkup",
"description":"Inline keyboard attached to the message",
"html_description":"<td><em>Optional</em>. <a href=\"/bots/features#inline-keyboards\">Inline keyboard</a> attached to the message</td>",
"rst_description":"*Optional*. `Inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ attached to the message\n",
"name":"reply_markup",
"required":false
},
{
"type":"InputMessageContent",
"description":"Content of the message to be sent instead of the audio",
"html_description":"<td><em>Optional</em>. Content of the message to be sent instead of the audio</td>",
"rst_description":"*Optional*. Content of the message to be sent instead of the audio\n",
"name":"input_message_content",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputmessagecontent",
"name":"InputMessageContent",
"description":"This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:\n - InputTextMessageContent\n - InputLocationMessageContent\n - InputVenueMessageContent\n - InputContactMessageContent\n - InputInvoiceMessageContent",
"html_description":"<p>This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:</p><ul>\n<li><a href=\"#inputtextmessagecontent\">InputTextMessageContent</a></li>\n<li><a href=\"#inputlocationmessagecontent\">InputLocationMessageContent</a></li>\n<li><a href=\"#inputvenuemessagecontent\">InputVenueMessageContent</a></li>\n<li><a href=\"#inputcontactmessagecontent\">InputContactMessageContent</a></li>\n<li><a href=\"#inputinvoicemessagecontent\">InputInvoiceMessageContent</a></li>\n</ul>",
"rst_description":"This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:\n\n - :class:`aiogram.types.input_text_message_content.InputTextMessageContent`\n - :class:`aiogram.types.input_location_message_content.InputLocationMessageContent`\n - :class:`aiogram.types.input_venue_message_content.InputVenueMessageContent`\n - :class:`aiogram.types.input_contact_message_content.InputContactMessageContent`\n - :class:`aiogram.types.input_invoice_message_content.InputInvoiceMessageContent`",
"annotations":[],
"category":"types"
},
{
"anchor":"inputtextmessagecontent",
"name":"InputTextMessageContent",
"description":"Represents the content of a text message to be sent as the result of an inline query.",
"html_description":"<p>Represents the <a href=\"#inputmessagecontent\">content</a> of a text message to be sent as the result of an inline query.</p>",
"rst_description":"Represents the `content <https://core.telegram.org/bots/api#inputmessagecontent>`_ of a text message to be sent as the result of an inline query.",
"annotations":[
{
"type":"String",
"description":"Text of the message to be sent, 1-4096 characters",
"html_description":"<td>Text of the message to be sent, 1-4096 characters</td>",
"rst_description":"Text of the message to be sent, 1-4096 characters\n",
"name":"message_text",
"required":true
},
{
"type":"String",
"description":"Mode for parsing entities in the message text. See formatting options for more details.",
"html_description":"<td><em>Optional</em>. Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
"rst_description":"*Optional*. Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
"name":"parse_mode",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"List of special entities that appear in message text, which can be specified instead of parse_mode",
"html_description":"<td><em>Optional</em>. List of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
"rst_description":"*Optional*. List of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
"description":"Represents the content of a location message to be sent as the result of an inline query.",
"html_description":"<p>Represents the <a href=\"#inputmessagecontent\">content</a> of a location message to be sent as the result of an inline query.</p>",
"rst_description":"Represents the `content <https://core.telegram.org/bots/api#inputmessagecontent>`_ of a location message to be sent as the result of an inline query.",
"annotations":[
{
"type":"Float",
"description":"Latitude of the location in degrees",
"html_description":"<td>Latitude of the location in degrees</td>",
"rst_description":"Latitude of the location in degrees\n",
"name":"latitude",
"required":true
},
{
"type":"Float",
"description":"Longitude of the location in degrees",
"html_description":"<td>Longitude of the location in degrees</td>",
"rst_description":"Longitude of the location in degrees\n",
"description":"Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.",
"html_description":"<td><em>Optional</em>. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.</td>",
"rst_description":"*Optional*. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.\n",
"description":"For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"html_description":"<td><em>Optional</em>. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.</td>",
"rst_description":"*Optional*. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.\n",
"name":"heading",
"required":false
},
{
"type":"Integer",
"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":"<td><em>Optional</em>. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.</td>",
"rst_description":"*Optional*. 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",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputvenuemessagecontent",
"name":"InputVenueMessageContent",
"description":"Represents the content of a venue message to be sent as the result of an inline query.",
"html_description":"<p>Represents the <a href=\"#inputmessagecontent\">content</a> of a venue message to be sent as the result of an inline query.</p>",
"rst_description":"Represents the `content <https://core.telegram.org/bots/api#inputmessagecontent>`_ of a venue message to be sent as the result of an inline query.",
"annotations":[
{
"type":"Float",
"description":"Latitude of the venue in degrees",
"html_description":"<td>Latitude of the venue in degrees</td>",
"rst_description":"Latitude of the venue in degrees\n",
"name":"latitude",
"required":true
},
{
"type":"Float",
"description":"Longitude of the venue in degrees",
"html_description":"<td>Longitude of the venue in degrees</td>",
"rst_description":"Longitude of the venue in degrees\n",
"name":"longitude",
"required":true
},
{
"type":"String",
"description":"Name of the venue",
"html_description":"<td>Name of the venue</td>",
"rst_description":"Name of the venue\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Address of the venue",
"html_description":"<td>Address of the venue</td>",
"rst_description":"Address of the venue\n",
"name":"address",
"required":true
},
{
"type":"String",
"description":"Foursquare identifier of the venue, if known",
"html_description":"<td><em>Optional</em>. Foursquare identifier of the venue, if known</td>",
"rst_description":"*Optional*. Foursquare identifier of the venue, if known\n",
"name":"foursquare_id",
"required":false
},
{
"type":"String",
"description":"Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)",
"html_description":"<td><em>Optional</em>. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)</td>",
"rst_description":"*Optional*. Foursquare type of the venue, if known. (For example, 'arts_entertainment/default', 'arts_entertainment/aquarium' or 'food/icecream'.)\n",
"name":"foursquare_type",
"required":false
},
{
"type":"String",
"description":"Google Places identifier of the venue",
"html_description":"<td><em>Optional</em>. Google Places identifier of the venue</td>",
"rst_description":"*Optional*. Google Places identifier of the venue\n",
"name":"google_place_id",
"required":false
},
{
"type":"String",
"description":"Google Places type of the venue. (See supported types.)",
"html_description":"<td><em>Optional</em>. Google Places type of the venue. (See <a href=\"https://developers.google.com/places/web-service/supported_types\">supported types</a>.)</td>",
"rst_description":"*Optional*. Google Places type of the venue. (See `supported types <https://developers.google.com/places/web-service/supported_types>`_.)\n",
"name":"google_place_type",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputcontactmessagecontent",
"name":"InputContactMessageContent",
"description":"Represents the content of a contact message to be sent as the result of an inline query.",
"html_description":"<p>Represents the <a href=\"#inputmessagecontent\">content</a> of a contact message to be sent as the result of an inline query.</p>",
"rst_description":"Represents the `content <https://core.telegram.org/bots/api#inputmessagecontent>`_ of a contact message to be sent as the result of an inline query.",
"html_description":"<td>Contact's first name</td>",
"rst_description":"Contact's first name\n",
"name":"first_name",
"required":true
},
{
"type":"String",
"description":"Contact's last name",
"html_description":"<td><em>Optional</em>. Contact's last name</td>",
"rst_description":"*Optional*. Contact's last name\n",
"name":"last_name",
"required":false
},
{
"type":"String",
"description":"Additional data about the contact in the form of a vCard, 0-2048 bytes",
"html_description":"<td><em>Optional</em>. Additional data about the contact in the form of a <a href=\"https://en.wikipedia.org/wiki/VCard\">vCard</a>, 0-2048 bytes</td>",
"rst_description":"*Optional*. Additional data about the contact in the form of a `vCard <https://en.wikipedia.org/wiki/VCard>`_, 0-2048 bytes\n",
"name":"vcard",
"required":false
}
],
"category":"types"
},
{
"anchor":"inputinvoicemessagecontent",
"name":"InputInvoiceMessageContent",
"description":"Represents the content of an invoice message to be sent as the result of an inline query.",
"html_description":"<p>Represents the <a href=\"#inputmessagecontent\">content</a> of an invoice message to be sent as the result of an inline query.</p>",
"rst_description":"Represents the `content <https://core.telegram.org/bots/api#inputmessagecontent>`_ of an invoice message to be sent as the result of an inline query.",
"description":"Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Payment provider token, obtained via <a href=\"https://t.me/botfather\">@BotFather</a>. Pass an empty string for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
"html_description":"<td>Three-letter ISO 4217 currency code, see <a href=\"/bots/payments#supported-currencies\">more on currencies</a>. Pass “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_. Pass 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
"html_description":"<td>Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. The maximum accepted amount for tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a maximum tip of <code>US$ 1.45</code> pass <code>max_tip_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"A JSON-serialized array of suggested amounts of tip 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":"<td><em>Optional</em>. A JSON-serialized array of suggested amounts of tip in the <em>smallest units</em> of the currency (integer, <strong>not</strong> 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 <em>max_tip_amount</em>.</td>",
"rst_description":"*Optional*. A JSON-serialized array of suggested amounts of tip 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",
"required":false
},
{
"type":"String",
"description":"A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.",
"html_description":"<td><em>Optional</em>. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.</td>",
"rst_description":"*Optional*. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.\n",
"name":"provider_data",
"required":false
},
{
"type":"String",
"description":"URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.",
"html_description":"<td><em>Optional</em>. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.</td>",
"rst_description":"*Optional*. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.\n",
"name":"photo_url",
"required":false
},
{
"type":"Integer",
"description":"Photo size in bytes",
"html_description":"<td><em>Optional</em>. Photo size in bytes</td>",
"rst_description":"*Optional*. Photo size in bytes\n",
"description":"Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if you require the user's full name to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if you require the user's phone number to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if you require the user's email address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if you require the user's shipping address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the user's phone number should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the user's email address should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.",
"html_description":"<td><em>Optional</em>. Pass <em>True</em> if the final price depends on the shipping method. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"*Optional*. Pass :code:`True` if the final price depends on the shipping method. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Represents a result of an inline query that was chosen by the user and sent to their chat partner.\nNote: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.",
"html_description":"<p>Represents a <a href=\"#inlinequeryresult\">result</a> of an inline query that was chosen by the user and sent to their chat partner.</p><p><strong>Note:</strong> It is necessary to enable <a href=\"/bots/inline#collecting-feedback\">inline feedback</a> via <a href=\"https://t.me/botfather\">@BotFather</a> in order to receive these objects in updates.</p>",
"rst_description":"Represents a `result <https://core.telegram.org/bots/api#inlinequeryresult>`_ of an inline query that was chosen by the user and sent to their chat partner.\n**Note:** It is necessary to enable `inline feedback <https://core.telegram.org/bots/inline#collecting-feedback>`_ via `@BotFather <https://t.me/botfather>`_ in order to receive these objects in updates.",
"annotations":[
{
"type":"String",
"description":"The unique identifier for the result that was chosen",
"html_description":"<td>The unique identifier for the result that was chosen</td>",
"rst_description":"The unique identifier for the result that was chosen\n",
"name":"result_id",
"required":true
},
{
"type":"User",
"description":"The user that chose the result",
"html_description":"<td>The user that chose the result</td>",
"rst_description":"The user that chose the result\n",
"name":"from",
"required":true
},
{
"type":"Location",
"description":"Sender location, only for bots that require user location",
"html_description":"<td><em>Optional</em>. Sender location, only for bots that require user location</td>",
"rst_description":"*Optional*. Sender location, only for bots that require user location\n",
"name":"location",
"required":false
},
{
"type":"String",
"description":"Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.",
"html_description":"<td><em>Optional</em>. Identifier of the sent inline message. Available only if there is an <a href=\"#inlinekeyboardmarkup\">inline keyboard</a> attached to the message. Will be also received in <a href=\"#callbackquery\">callback queries</a> and can be used to <a href=\"#updating-messages\">edit</a> the message.</td>",
"rst_description":"*Optional*. Identifier of the sent inline message. Available only if there is an `inline keyboard <https://core.telegram.org/bots/api#inlinekeyboardmarkup>`_ attached to the message. Will be also received in `callback queries <https://core.telegram.org/bots/api#callbackquery>`_ and can be used to `edit <https://core.telegram.org/bots/api#updating-messages>`_ the message.\n",
"name":"inline_message_id",
"required":false
},
{
"type":"String",
"description":"The query that was used to obtain the result",
"html_description":"<td>The query that was used to obtain the result</td>",
"rst_description":"The query that was used to obtain the result\n",
"name":"query",
"required":true
}
],
"category":"types"
},
{
"anchor":"answerwebappquery",
"name":"answerWebAppQuery",
"description":"Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.",
"html_description":"<p>Use this method to set the result of an interaction with a <a href=\"/bots/webapps\">Web App</a> and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a <a href=\"#sentwebappmessage\">SentWebAppMessage</a> object is returned.</p>",
"rst_description":"Use this method to set the result of an interaction with a `Web App <https://core.telegram.org/bots/webapps>`_ and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a :class:`aiogram.types.sent_web_app_message.SentWebAppMessage` object is returned.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier for the query to be answered",
"html_description":"<td>Unique identifier for the query to be answered</td>",
"rst_description":"Unique identifier for the query to be answered\n",
"name":"web_app_query_id"
},
{
"type":"InlineQueryResult",
"required":true,
"description":"A JSON-serialized object describing the message to be sent",
"html_description":"<td>A JSON-serialized object describing the message to be sent</td>",
"rst_description":"A JSON-serialized object describing the message to be sent\n",
"name":"result"
}
],
"category":"methods"
},
{
"anchor":"sentwebappmessage",
"name":"SentWebAppMessage",
"description":"Describes an inline message sent by a Web App on behalf of a user.",
"html_description":"<p>Describes an inline message sent by a <a href=\"/bots/webapps\">Web App</a> on behalf of a user.</p>",
"rst_description":"Describes an inline message sent by a `Web App <https://core.telegram.org/bots/webapps>`_ on behalf of a user.",
"annotations":[
{
"type":"String",
"description":"Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.",
"html_description":"<td><em>Optional</em>. Identifier of the sent inline message. Available only if there is an <a href=\"#inlinekeyboardmarkup\">inline keyboard</a> attached to the message.</td>",
"rst_description":"*Optional*. Identifier of the sent inline message. Available only if there is an `inline keyboard <https://core.telegram.org/bots/api#inlinekeyboardmarkup>`_ attached to the message.\n",
"description":"Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.",
"html_description":"<p>Stores a message that can be sent by a user of a Mini App. Returns a <a href=\"#preparedinlinemessage\">PreparedInlineMessage</a> object.</p>",
"rst_description":"Stores a message that can be sent by a user of a Mini App. Returns a :class:`aiogram.types.prepared_inline_message.PreparedInlineMessage` object.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Unique identifier of the target user that can use the prepared message",
"html_description":"<td>Unique identifier of the target user that can use the prepared message</td>",
"rst_description":"Unique identifier of the target user that can use the prepared message\n",
"name":"user_id"
},
{
"type":"InlineQueryResult",
"required":true,
"description":"A JSON-serialized object describing the message to be sent",
"html_description":"<td>A JSON-serialized object describing the message to be sent</td>",
"rst_description":"A JSON-serialized object describing the message to be sent\n",
"name":"result"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the message can be sent to private chats with users",
"html_description":"<td>Pass <em>True</em> if the message can be sent to private chats with users</td>",
"rst_description":"Pass :code:`True` if the message can be sent to private chats with users\n",
"name":"allow_user_chats"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the message can be sent to private chats with bots",
"html_description":"<td>Pass <em>True</em> if the message can be sent to private chats with bots</td>",
"rst_description":"Pass :code:`True` if the message can be sent to private chats with bots\n",
"name":"allow_bot_chats"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the message can be sent to group and supergroup chats",
"html_description":"<td>Pass <em>True</em> if the message can be sent to group and supergroup chats</td>",
"rst_description":"Pass :code:`True` if the message can be sent to group and supergroup chats\n",
"name":"allow_group_chats"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the message can be sent to channel chats",
"html_description":"<td>Pass <em>True</em> if the message can be sent to channel chats</td>",
"rst_description":"Pass :code:`True` if the message can be sent to channel chats\n",
"name":"allow_channel_chats"
}
],
"category":"methods"
},
{
"anchor":"preparedinlinemessage",
"name":"PreparedInlineMessage",
"description":"Describes an inline message to be sent by a user of a Mini App.",
"html_description":"<p>Describes an inline message to be sent by a user of a Mini App.</p>",
"rst_description":"Describes an inline message to be sent by a user of a Mini App.",
"annotations":[
{
"type":"String",
"description":"Unique identifier of the prepared message",
"html_description":"<td>Unique identifier of the prepared message</td>",
"rst_description":"Unique identifier of the prepared message\n",
"name":"id",
"required":true
},
{
"type":"Integer",
"description":"Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used",
"html_description":"<td>Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used</td>",
"rst_description":"Expiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used\n",
"description":"The following methods and objects allow your bot to work in inline mode.\nPlease see our Introduction to Inline bots for more details.\nTo enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot's name."
},
{
"title":"Payments",
"anchor":"payments",
"children":[
{
"anchor":"sendinvoice",
"name":"sendInvoice",
"description":"Use this method to send invoices. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send invoices. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"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":"<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
"rst_description":"Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
"html_description":"<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
"rst_description":"Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
"description":"Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
"html_description":"<td>Payment provider token, obtained via <a href=\"https://t.me/botfather\">@BotFather</a>. Pass an empty string for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
"html_description":"<td>Three-letter ISO 4217 currency code, see <a href=\"/bots/payments#supported-currencies\">more on currencies</a>. Pass “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_. Pass 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
"html_description":"<td>Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
"html_description":"<td>The maximum accepted amount for tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a maximum tip of <code>US$ 1.45</code> pass <code>max_tip_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"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 <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"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":"<td>A JSON-serialized array of suggested amounts of tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> 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 <em>max_tip_amount</em>.</td>",
"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"
},
{
"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":"<td>Unique deep-linking parameter. If left empty, <strong>forwarded copies</strong> of the sent message will have a <em>Pay</em> 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 <em>URL</em> button with a deep link to the bot (instead of a <em>Pay</em> button), with the value used as the start parameter</td>",
"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"
},
{
"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":"<td>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.</td>",
"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"
},
{
"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":"<td>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.</td>",
"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"
},
{
"type":"Integer",
"required":false,
"description":"Photo size in bytes",
"html_description":"<td>Photo size in bytes</td>",
"description":"Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's full name to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's phone number to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's email address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's shipping address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the user's phone number should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the user's email address should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the final price depends on the shipping method. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the final price depends on the shipping method. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
"html_description":"<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
"rst_description":"A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
"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":"<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If empty, one 'Pay <code>total price</code>' button will be shown. If not empty, the first button must be a Pay button.</td>",
"rst_description":"A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. 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"
}
],
"category":"methods"
},
{
"anchor":"createinvoicelink",
"name":"createInvoiceLink",
"description":"Use this method to create a link for an invoice. Returns the created invoice link as String on success.",
"html_description":"<p>Use this method to create a link for an invoice. Returns the created invoice link as <em>String</em> on success.</p>",
"rst_description":"Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.",
"description":"Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.",
"html_description":"<td>Unique identifier of the business connection on behalf of which the link will be created. For payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a> only.</td>",
"rst_description":"Unique identifier of the business connection on behalf of which the link will be created. For payments in `Telegram Stars <https://t.me/BotNews/90>`_ only.\n",
"description":"Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
"html_description":"<td>Payment provider token, obtained via <a href=\"https://t.me/botfather\">@BotFather</a>. Pass an empty string for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
"html_description":"<td>Three-letter ISO 4217 currency code, see <a href=\"/bots/payments#supported-currencies\">more on currencies</a>. Pass “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_. Pass 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
"html_description":"<td>Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.",
"html_description":"<td>The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.</td>",
"rst_description":"The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.\n",
"description":"The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
"html_description":"<td>The maximum accepted amount for tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a maximum tip of <code>US$ 1.45</code> pass <code>max_tip_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"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 <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"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":"<td>A JSON-serialized array of suggested amounts of tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> 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 <em>max_tip_amount</em>.</td>",
"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"
},
{
"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":"<td>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.</td>",
"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"
},
{
"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.",
"html_description":"<td>URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.</td>",
"rst_description":"URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.\n",
"name":"photo_url"
},
{
"type":"Integer",
"required":false,
"description":"Photo size in bytes",
"html_description":"<td>Photo size in bytes</td>",
"description":"Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's full name to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's phone number to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's email address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if you require the user's shipping address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the user's phone number should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the user's email address should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.",
"html_description":"<td>Pass <em>True</em> if the final price depends on the shipping method. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
"rst_description":"Pass :code:`True` if the final price depends on the shipping method. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
"description":"If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.",
"html_description":"<p>If you sent an invoice requesting a shipping address and the parameter <em>is_flexible</em> was specified, the Bot API will send an <a href=\"#update\">Update</a> with a <em>shipping_query</em> field to the bot. Use this method to reply to shipping queries. On success, <em>True</em> is returned.</p>",
"rst_description":"If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an :class:`aiogram.types.update.Update` with a *shipping_query* field to the bot. Use this method to reply to shipping queries. On success, :code:`True` is returned.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier for the query to be answered",
"html_description":"<td>Unique identifier for the query to be answered</td>",
"rst_description":"Unique identifier for the query to be answered\n",
"name":"shipping_query_id"
},
{
"type":"Boolean",
"required":true,
"description":"Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)",
"html_description":"<td>Pass <em>True</em> if delivery to the specified address is possible and <em>False</em> if there are any problems (for example, if delivery to the specified address is not possible)</td>",
"rst_description":"Pass :code:`True` if delivery to the specified address is possible and :code:`False` if there are any problems (for example, if delivery to the specified address is not possible)\n",
"name":"ok"
},
{
"type":"Array of ShippingOption",
"required":false,
"description":"Required if ok is True. A JSON-serialized array of available shipping options.",
"html_description":"<td>Required if <em>ok</em> is <em>True</em>. A JSON-serialized array of available shipping options.</td>",
"rst_description":"Required if *ok* is :code:`True`. A JSON-serialized array of available shipping options.\n",
"description":"Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. 'Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.",
"html_description":"<td>Required if <em>ok</em> is <em>False</em>. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.</td>",
"rst_description":"Required if *ok* is :code:`False`. Error message in human readable form that explains why it is impossible to complete the order (e.g. 'Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.\n",
"description":"Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.",
"html_description":"<p>Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an <a href=\"#update\">Update</a> with the field <em>pre_checkout_query</em>. Use this method to respond to such pre-checkout queries. On success, <em>True</em> is returned. <strong>Note:</strong> The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.</p>",
"rst_description":"Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an :class:`aiogram.types.update.Update` with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. On success, :code:`True` is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.",
"annotations":[
{
"type":"String",
"required":true,
"description":"Unique identifier for the query to be answered",
"html_description":"<td>Unique identifier for the query to be answered</td>",
"rst_description":"Unique identifier for the query to be answered\n",
"name":"pre_checkout_query_id"
},
{
"type":"Boolean",
"required":true,
"description":"Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.",
"html_description":"<td>Specify <em>True</em> if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use <em>False</em> if there are any problems.</td>",
"rst_description":"Specify :code:`True` if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use :code:`False` if there are any problems.\n",
"name":"ok"
},
{
"type":"String",
"required":false,
"description":"Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user.",
"html_description":"<td>Required if <em>ok</em> is <em>False</em>. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user.</td>",
"rst_description":"Required if *ok* is :code:`False`. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user.\n",
"description":"A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.",
"html_description":"<p>A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a <a href=\"#staramount\">StarAmount</a> object.</p>",
"rst_description":"A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a :class:`aiogram.types.star_amount.StarAmount` object.",
"description":"Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.",
"html_description":"<p>Returns the bot's Telegram Star transactions in chronological order. On success, returns a <a href=\"#startransactions\">StarTransactions</a> object.</p>",
"rst_description":"Returns the bot's Telegram Star transactions in chronological order. On success, returns a :class:`aiogram.types.star_transactions.StarTransactions` object.",
"annotations":[
{
"type":"Integer",
"required":false,
"description":"Number of transactions to skip in the response",
"html_description":"<td>Number of transactions to skip in the response</td>",
"rst_description":"Number of transactions to skip in the response\n",
"name":"offset"
},
{
"type":"Integer",
"required":false,
"description":"The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
"html_description":"<td>The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.</td>",
"rst_description":"The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
"description":"Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.",
"html_description":"<p>Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns <em>True</em> on success.</p>",
"rst_description":"Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns :code:`True` on success.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Identifier of the user whose subscription will be edited",
"html_description":"<td>Identifier of the user whose subscription will be edited</td>",
"rst_description":"Identifier of the user whose subscription will be edited\n",
"name":"user_id"
},
{
"type":"String",
"required":true,
"description":"Telegram payment identifier for the subscription",
"html_description":"<td>Telegram payment identifier for the subscription</td>",
"rst_description":"Telegram payment identifier for the subscription\n",
"name":"telegram_payment_charge_id"
},
{
"type":"Boolean",
"required":true,
"description":"Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.",
"html_description":"<td>Pass <em>True</em> to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass <em>False</em> to allow the user to re-enable a subscription that was previously canceled by the bot.</td>",
"rst_description":"Pass :code:`True` to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass :code:`False` to allow the user to re-enable a subscription that was previously canceled by the bot.\n",
"description":"This object represents a portion of the price for goods or services.",
"html_description":"<p>This object represents a portion of the price for goods or services.</p>",
"rst_description":"This object represents a portion of the price for goods or services.",
"annotations":[
{
"type":"String",
"description":"Portion label",
"html_description":"<td>Portion label</td>",
"rst_description":"Portion label\n",
"name":"label",
"required":true
},
{
"type":"Integer",
"description":"Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).",
"html_description":"<td>Price of the product in the <em>smallest units</em> of the <a href=\"/bots/payments#supported-currencies\">currency</a> (integer, <strong>not</strong> float/double). For example, for a price of <code>US$ 1.45</code> pass <code>amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>",
"rst_description":"Price of the product in the *smallest units* of the `currency <https://core.telegram.org/bots/payments#supported-currencies>`_ (integer, **not** float/double). For example, for a price of :code:`US$ 1.45` pass :code:`amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
"name":"amount",
"required":true
}
],
"category":"types"
},
{
"anchor":"invoice",
"name":"Invoice",
"description":"This object contains basic information about an invoice.",
"html_description":"<p>This object contains basic information about an invoice.</p>",
"rst_description":"This object contains basic information about an invoice.",
"description":"Three-letter ISO 4217 currency code, or 'XTR' for payments in Telegram Stars",
"html_description":"<td>Three-letter ISO 4217 <a href=\"/bots/payments#supported-currencies\">currency</a> code, or “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a></td>",
"rst_description":"Three-letter ISO 4217 `currency <https://core.telegram.org/bots/payments#supported-currencies>`_ code, or 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_\n",
"description":"Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).",
"html_description":"<td>Total price in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a price of <code>US$ 1.45</code> pass <code>amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>",
"rst_description":"Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of :code:`US$ 1.45` pass :code:`amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
"name":"total_amount",
"required":true
}
],
"category":"types"
},
{
"anchor":"shippingaddress",
"name":"ShippingAddress",
"description":"This object represents a shipping address.",
"html_description":"<p>This object represents a shipping address.</p>",
"rst_description":"This object represents a shipping address.",
"annotations":[
{
"type":"String",
"description":"Two-letter ISO 3166-1 alpha-2 country code",
"description":"This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.",
"html_description":"<p>This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.</p>",
"rst_description":"This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.",
"description":"Three-letter ISO 4217 currency code, or 'XTR' for payments in Telegram Stars",
"html_description":"<td>Three-letter ISO 4217 <a href=\"/bots/payments#supported-currencies\">currency</a> code, or “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a></td>",
"rst_description":"Three-letter ISO 4217 `currency <https://core.telegram.org/bots/payments#supported-currencies>`_ code, or 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_\n",
"description":"Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).",
"html_description":"<td>Total price in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a price of <code>US$ 1.45</code> pass <code>amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>",
"rst_description":"Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of :code:`US$ 1.45` pass :code:`amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
"description":"This object contains basic information about a refunded payment.",
"html_description":"<p>This object contains basic information about a refunded payment.</p>",
"rst_description":"This object contains basic information about a refunded payment.",
"annotations":[
{
"type":"String",
"description":"Three-letter ISO 4217 currency code, or 'XTR' for payments in Telegram Stars. Currently, always 'XTR'",
"html_description":"<td>Three-letter ISO 4217 <a href=\"/bots/payments#supported-currencies\">currency</a> code, or “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>. Currently, always “XTR”</td>",
"rst_description":"Three-letter ISO 4217 `currency <https://core.telegram.org/bots/payments#supported-currencies>`_ code, or 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_. Currently, always 'XTR'\n",
"name":"currency",
"required":true
},
{
"type":"Integer",
"description":"Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_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).",
"html_description":"<td>Total refunded price in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a price of <code>US$ 1.45</code>, <code>total_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>",
"rst_description":"Total refunded price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of :code:`US$ 1.45`, :code:`total_amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
"description":"Three-letter ISO 4217 currency code, or 'XTR' for payments in Telegram Stars",
"html_description":"<td>Three-letter ISO 4217 <a href=\"/bots/payments#supported-currencies\">currency</a> code, or “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a></td>",
"rst_description":"Three-letter ISO 4217 `currency <https://core.telegram.org/bots/payments#supported-currencies>`_ code, or 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_\n",
"description":"Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass 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).",
"html_description":"<td>Total price in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a price of <code>US$ 1.45</code> pass <code>amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).</td>",
"rst_description":"Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of :code:`US$ 1.45` pass :code:`amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).\n",
"description":"This object describes the state of a revenue withdrawal operation. Currently, it can be one of\n - RevenueWithdrawalStatePending\n - RevenueWithdrawalStateSucceeded\n - RevenueWithdrawalStateFailed",
"html_description":"<p>This object describes the state of a revenue withdrawal operation. Currently, it can be one of</p><ul>\n<li><a href=\"#revenuewithdrawalstatepending\">RevenueWithdrawalStatePending</a></li>\n<li><a href=\"#revenuewithdrawalstatesucceeded\">RevenueWithdrawalStateSucceeded</a></li>\n<li><a href=\"#revenuewithdrawalstatefailed\">RevenueWithdrawalStateFailed</a></li>\n</ul>",
"rst_description":"This object describes the state of a revenue withdrawal operation. Currently, it can be one of\n\n - :class:`aiogram.types.revenue_withdrawal_state_pending.RevenueWithdrawalStatePending`\n - :class:`aiogram.types.revenue_withdrawal_state_succeeded.RevenueWithdrawalStateSucceeded`\n - :class:`aiogram.types.revenue_withdrawal_state_failed.RevenueWithdrawalStateFailed`",
"annotations":[],
"category":"types"
},
{
"anchor":"revenuewithdrawalstatepending",
"name":"RevenueWithdrawalStatePending",
"description":"The withdrawal is in progress.",
"html_description":"<p>The withdrawal is in progress.</p>",
"rst_description":"The withdrawal is in progress.",
"annotations":[
{
"type":"String",
"description":"Type of the state, always 'pending'",
"html_description":"<td>Type of the state, always “pending”</td>",
"rst_description":"Type of the state, always 'pending'\n",
"description":"Contains information about the affiliate that received a commission via this transaction.",
"html_description":"<p>Contains information about the affiliate that received a commission via this transaction.</p>",
"rst_description":"Contains information about the affiliate that received a commission via this transaction.",
"annotations":[
{
"type":"User",
"description":"The bot or the user that received an affiliate commission if it was received by a bot or a user",
"html_description":"<td><em>Optional</em>. The bot or the user that received an affiliate commission if it was received by a bot or a user</td>",
"rst_description":"*Optional*. The bot or the user that received an affiliate commission if it was received by a bot or a user\n",
"name":"affiliate_user",
"required":false
},
{
"type":"Chat",
"description":"The chat that received an affiliate commission if it was received by a chat",
"html_description":"<td><em>Optional</em>. The chat that received an affiliate commission if it was received by a chat</td>",
"rst_description":"*Optional*. The chat that received an affiliate commission if it was received by a chat\n",
"name":"affiliate_chat",
"required":false
},
{
"type":"Integer",
"description":"The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users",
"html_description":"<td>The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users</td>",
"rst_description":"The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users\n",
"name":"commission_per_mille",
"required":true
},
{
"type":"Integer",
"description":"Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds",
"html_description":"<td>Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds</td>",
"rst_description":"Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds\n",
"name":"amount",
"required":true
},
{
"type":"Integer",
"description":"The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds",
"html_description":"<td><em>Optional</em>. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds</td>",
"rst_description":"*Optional*. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds\n",
"description":"This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n - TransactionPartnerUser\n - TransactionPartnerChat\n - TransactionPartnerAffiliateProgram\n - TransactionPartnerFragment\n - TransactionPartnerTelegramAds\n - TransactionPartnerTelegramApi\n - TransactionPartnerOther",
"html_description":"<p>This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of</p><ul>\n<li><a href=\"#transactionpartneruser\">TransactionPartnerUser</a></li>\n<li><a href=\"#transactionpartnerchat\">TransactionPartnerChat</a></li>\n<li><a href=\"#transactionpartneraffiliateprogram\">TransactionPartnerAffiliateProgram</a></li>\n<li><a href=\"#transactionpartnerfragment\">TransactionPartnerFragment</a></li>\n<li><a href=\"#transactionpartnertelegramads\">TransactionPartnerTelegramAds</a></li>\n<li><a href=\"#transactionpartnertelegramapi\">TransactionPartnerTelegramApi</a></li>\n<li><a href=\"#transactionpartnerother\">TransactionPartnerOther</a></li>\n</ul>",
"rst_description":"This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of\n\n - :class:`aiogram.types.transaction_partner_user.TransactionPartnerUser`\n - :class:`aiogram.types.transaction_partner_chat.TransactionPartnerChat`\n - :class:`aiogram.types.transaction_partner_affiliate_program.TransactionPartnerAffiliateProgram`\n - :class:`aiogram.types.transaction_partner_fragment.TransactionPartnerFragment`\n - :class:`aiogram.types.transaction_partner_telegram_ads.TransactionPartnerTelegramAds`\n - :class:`aiogram.types.transaction_partner_telegram_api.TransactionPartnerTelegramApi`\n - :class:`aiogram.types.transaction_partner_other.TransactionPartnerOther`",
"description":"Type of the transaction, currently one of 'invoice_payment' for payments via invoices, 'paid_media_payment' for payments for paid media, 'gift_purchase' for gifts sent by the bot, 'premium_purchase' for Telegram Premium subscriptions gifted by the bot, 'business_account_transfer' for direct transfers from managed business accounts",
"html_description":"<td>Type of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts</td>",
"rst_description":"Type of the transaction, currently one of 'invoice_payment' for payments via invoices, 'paid_media_payment' for payments for paid media, 'gift_purchase' for gifts sent by the bot, 'premium_purchase' for Telegram Premium subscriptions gifted by the bot, 'business_account_transfer' for direct transfers from managed business accounts\n",
"description":"Information about the affiliate that received a commission via this transaction. Can be available only for 'invoice_payment' and 'paid_media_payment' transactions.",
"html_description":"<td><em>Optional</em>. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.</td>",
"rst_description":"*Optional*. Information about the affiliate that received a commission via this transaction. Can be available only for 'invoice_payment' and 'paid_media_payment' transactions.\n",
"description":"The duration of the paid subscription. Can be available only for 'invoice_payment' transactions.",
"html_description":"<td><em>Optional</em>. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.</td>",
"rst_description":"*Optional*. The duration of the paid subscription. Can be available only for 'invoice_payment' transactions.\n",
"description":"Information about the paid media bought by the user; for 'paid_media_payment' transactions only",
"html_description":"<td><em>Optional</em>. Information about the paid media bought by the user; for “paid_media_payment” transactions only</td>",
"rst_description":"*Optional*. Information about the paid media bought by the user; for 'paid_media_payment' transactions only\n",
"description":"Bot-specified paid media payload. Can be available only for 'paid_media_payment' transactions.",
"html_description":"<td><em>Optional</em>. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.</td>",
"rst_description":"*Optional*. Bot-specified paid media payload. Can be available only for 'paid_media_payment' transactions.\n",
"description":"Number of months the gifted Telegram Premium subscription will be active for; for 'premium_purchase' transactions only",
"html_description":"<td><em>Optional</em>. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only</td>",
"rst_description":"*Optional*. Number of months the gifted Telegram Premium subscription will be active for; for 'premium_purchase' transactions only\n",
"description":"Describes the affiliate program that issued the affiliate commission received via this transaction.",
"html_description":"<p>Describes the affiliate program that issued the affiliate commission received via this transaction.</p>",
"rst_description":"Describes the affiliate program that issued the affiliate commission received via this transaction.",
"annotations":[
{
"type":"String",
"description":"Type of the transaction partner, always 'affiliate_program'",
"html_description":"<td>Type of the transaction partner, always “affiliate_program”</td>",
"rst_description":"Type of the transaction partner, always 'affiliate_program'\n",
"name":"type",
"required":true
},
{
"type":"User",
"description":"Information about the bot that sponsored the affiliate program",
"html_description":"<td><em>Optional</em>. Information about the bot that sponsored the affiliate program</td>",
"rst_description":"*Optional*. Information about the bot that sponsored the affiliate program\n",
"name":"sponsor_user",
"required":false
},
{
"type":"Integer",
"description":"The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users",
"html_description":"<td>The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users</td>",
"rst_description":"The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users\n",
"description":"Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.",
"html_description":"<p>Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.</p>",
"rst_description":"Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.",
"description":"Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.",
"html_description":"<td>Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with <em>SuccessfulPayment.telegram_payment_charge_id</em> for successful incoming payments from users.</td>",
"rst_description":"Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with *SuccessfulPayment.telegram_payment_charge_id* for successful incoming payments from users.\n",
"description":"The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999",
"html_description":"<td><em>Optional</em>. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999</td>",
"rst_description":"*Optional*. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999\n",
"description":"Date the transaction was created in Unix time",
"html_description":"<td>Date the transaction was created in Unix time</td>",
"rst_description":"Date the transaction was created in Unix time\n",
"name":"date",
"required":true
},
{
"type":"TransactionPartner",
"description":"Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions",
"html_description":"<td><em>Optional</em>. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions</td>",
"rst_description":"*Optional*. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions\n",
"name":"source",
"required":false
},
{
"type":"TransactionPartner",
"description":"Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions",
"html_description":"<td><em>Optional</em>. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions</td>",
"rst_description":"*Optional*. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions\n",
"name":"receiver",
"required":false
}
],
"category":"types"
},
{
"anchor":"startransactions",
"name":"StarTransactions",
"description":"Contains a list of Telegram Star transactions.",
"html_description":"<p>Contains a list of Telegram Star transactions.</p>",
"rst_description":"Contains a list of Telegram Star transactions.",
"annotations":[
{
"type":"Array of StarTransaction",
"description":"The list of transactions",
"html_description":"<td>The list of transactions</td>",
"description":"Your bot can accept payments from Telegram users. Please see the introduction to payments for more details on the process and how to set up payments for your bot."
"description":"Describes Telegram Passport data shared with the bot by the user.",
"html_description":"<p>Describes Telegram Passport data shared with the bot by the user.</p>",
"rst_description":"Describes Telegram Passport data shared with the bot by the user.",
"annotations":[
{
"type":"Array of EncryptedPassportElement",
"description":"Array with information about documents and other Telegram Passport elements that was shared with the bot",
"html_description":"<td>Array with information about documents and other Telegram Passport elements that was shared with the bot</td>",
"rst_description":"Array with information about documents and other Telegram Passport elements that was shared with the bot\n",
"name":"data",
"required":true
},
{
"type":"EncryptedCredentials",
"description":"Encrypted credentials required to decrypt the data",
"html_description":"<td>Encrypted credentials required to decrypt the data</td>",
"rst_description":"Encrypted credentials required to decrypt the data\n",
"name":"credentials",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportfile",
"name":"PassportFile",
"description":"This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"html_description":"<p>This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.</p>",
"rst_description":"This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"annotations":[
{
"type":"String",
"description":"Identifier for this file, which can be used to download or reuse the file",
"html_description":"<td>Identifier for this file, which can be used to download or reuse the file</td>",
"rst_description":"Identifier for this file, which can be used to download or reuse the file\n",
"name":"file_id",
"required":true
},
{
"type":"String",
"description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.",
"html_description":"<td>Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.</td>",
"rst_description":"Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.\n",
"name":"file_unique_id",
"required":true
},
{
"type":"Integer",
"description":"File size in bytes",
"html_description":"<td>File size in bytes</td>",
"rst_description":"File size in bytes\n",
"name":"file_size",
"required":true
},
{
"type":"Integer",
"description":"Unix time when the file was uploaded",
"html_description":"<td>Unix time when the file was uploaded</td>",
"rst_description":"Unix time when the file was uploaded\n",
"name":"file_date",
"required":true
}
],
"category":"types"
},
{
"anchor":"encryptedpassportelement",
"name":"EncryptedPassportElement",
"description":"Describes documents or other Telegram Passport elements shared with the bot by the user.",
"html_description":"<p>Describes documents or other Telegram Passport elements shared with the bot by the user.</p>",
"rst_description":"Describes documents or other Telegram Passport elements shared with the bot by the user.",
"annotations":[
{
"type":"String",
"description":"Element type. One of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration', 'phone_number', 'email'.",
"html_description":"<td>Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.</td>",
"rst_description":"Element type. One of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration', 'phone_number', 'email'.\n",
"description":"Base64-encoded encrypted Telegram Passport element data provided by the user; available only for 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport' and 'address' types. Can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport' and 'address' types. Can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Array of encrypted files with documents provided by the user; available only for 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Array of encrypted files with documents provided by the user; available only for 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Encrypted file with the front side of the document, provided by the user; available only for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Encrypted file with the front side of the document, provided by the user; available only for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Encrypted file with the reverse side of the document, provided by the user; available only for 'driver_license' and 'identity_card'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Encrypted file with the reverse side of the document, provided by the user; available only for 'driver_license' and 'identity_card'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for 'passport', 'driver_license', 'identity_card' and 'internal_passport'. The file can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Array of encrypted files with translated versions of documents provided by the user; available if requested for 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying EncryptedCredentials.",
"html_description":"<td><em>Optional</em>. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying <a href=\"#encryptedcredentials\">EncryptedCredentials</a>.</td>",
"rst_description":"*Optional*. Array of encrypted files with translated versions of documents provided by the user; available if requested for 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration' and 'temporary_registration' types. Files can be decrypted and verified using the accompanying :class:`aiogram.types.encrypted_credentials.EncryptedCredentials`.\n",
"description":"Base64-encoded element hash for using in PassportElementErrorUnspecified",
"html_description":"<td>Base64-encoded element hash for using in <a href=\"#passportelementerrorunspecified\">PassportElementErrorUnspecified</a></td>",
"rst_description":"Base64-encoded element hash for using in :class:`aiogram.types.passport_element_error_unspecified.PassportElementErrorUnspecified`\n",
"name":"hash",
"required":true
}
],
"category":"types"
},
{
"anchor":"encryptedcredentials",
"name":"EncryptedCredentials",
"description":"Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"html_description":"<p>Describes data required for decrypting and authenticating <a href=\"#encryptedpassportelement\">EncryptedPassportElement</a>. See the <a href=\"/passport#receiving-information\">Telegram Passport Documentation</a> for a complete description of the data decryption and authentication processes.</p>",
"rst_description":"Describes data required for decrypting and authenticating :class:`aiogram.types.encrypted_passport_element.EncryptedPassportElement`. See the `Telegram Passport Documentation <https://core.telegram.org/passport#receiving-information>`_ for a complete description of the data decryption and authentication processes.",
"annotations":[
{
"type":"String",
"description":"Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication",
"html_description":"<td>Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for <a href=\"#encryptedpassportelement\">EncryptedPassportElement</a> decryption and authentication</td>",
"rst_description":"Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for :class:`aiogram.types.encrypted_passport_element.EncryptedPassportElement` decryption and authentication\n",
"name":"data",
"required":true
},
{
"type":"String",
"description":"Base64-encoded data hash for data authentication",
"html_description":"<td>Base64-encoded data hash for data authentication</td>",
"rst_description":"Base64-encoded data hash for data authentication\n",
"name":"hash",
"required":true
},
{
"type":"String",
"description":"Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption",
"html_description":"<td>Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption</td>",
"rst_description":"Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption\n",
"name":"secret",
"required":true
}
],
"category":"types"
},
{
"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":"<p>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 <em>True</em> on success.</p><p>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.</p>",
"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":"<td>User identifier</td>",
"rst_description":"User identifier\n",
"name":"user_id"
},
{
"type":"Array of PassportElementError",
"required":true,
"description":"A JSON-serialized array describing the errors",
"html_description":"<td>A JSON-serialized array describing the errors</td>",
"rst_description":"A JSON-serialized array describing the errors\n",
"name":"errors"
}
],
"category":"methods"
},
{
"anchor":"passportelementerror",
"name":"PassportElementError",
"description":"This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:\n - PassportElementErrorDataField\n - PassportElementErrorFrontSide\n - PassportElementErrorReverseSide\n - PassportElementErrorSelfie\n - PassportElementErrorFile\n - PassportElementErrorFiles\n - PassportElementErrorTranslationFile\n - PassportElementErrorTranslationFiles\n - PassportElementErrorUnspecified",
"html_description":"<p>This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:</p><ul>\n<li><a href=\"#passportelementerrordatafield\">PassportElementErrorDataField</a></li>\n<li><a href=\"#passportelementerrorfrontside\">PassportElementErrorFrontSide</a></li>\n<li><a href=\"#passportelementerrorreverseside\">PassportElementErrorReverseSide</a></li>\n<li><a href=\"#passportelementerrorselfie\">PassportElementErrorSelfie</a></li>\n<li><a href=\"#passportelementerrorfile\">PassportElementErrorFile</a></li>\n<li><a href=\"#passportelementerrorfiles\">PassportElementErrorFiles</a></li>\n<li><a href=\"#passportelementerrortranslationfile\">PassportElementErrorTranslationFile</a></li>\n<li><a href=\"#passportelementerrortranslationfiles\">PassportElementErrorTranslationFiles</a></li>\n<li><a href=\"#passportelementerrorunspecified\">PassportElementErrorUnspecified</a></li>\n</ul>",
"rst_description":"This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:\n\n - :class:`aiogram.types.passport_element_error_data_field.PassportElementErrorDataField`\n - :class:`aiogram.types.passport_element_error_front_side.PassportElementErrorFrontSide`\n - :class:`aiogram.types.passport_element_error_reverse_side.PassportElementErrorReverseSide`\n - :class:`aiogram.types.passport_element_error_selfie.PassportElementErrorSelfie`\n - :class:`aiogram.types.passport_element_error_file.PassportElementErrorFile`\n - :class:`aiogram.types.passport_element_error_files.PassportElementErrorFiles`\n - :class:`aiogram.types.passport_element_error_translation_file.PassportElementErrorTranslationFile`\n - :class:`aiogram.types.passport_element_error_translation_files.PassportElementErrorTranslationFiles`\n - :class:`aiogram.types.passport_element_error_unspecified.PassportElementErrorUnspecified`",
"annotations":[],
"category":"types"
},
{
"anchor":"passportelementerrordatafield",
"name":"PassportElementErrorDataField",
"description":"Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.",
"html_description":"<p>Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.</p>",
"rst_description":"Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be data",
"html_description":"<td>Error source, must be <em>data</em></td>",
"rst_description":"Error source, must be *data*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the error, one of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address'",
"html_description":"<td>The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”</td>",
"rst_description":"The section of the user's Telegram Passport which has the error, one of 'personal_details', 'passport', 'driver_license', 'identity_card', 'internal_passport', 'address'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Name of the data field which has the error",
"html_description":"<td>Name of the data field which has the error</td>",
"rst_description":"Name of the data field which has the error\n",
"name":"field_name",
"required":true
},
{
"type":"String",
"description":"Base64-encoded data hash",
"html_description":"<td>Base64-encoded data hash</td>",
"rst_description":"Base64-encoded data hash\n",
"name":"data_hash",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrorfrontside",
"name":"PassportElementErrorFrontSide",
"description":"Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.",
"html_description":"<p>Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.</p>",
"rst_description":"Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be front_side",
"html_description":"<td>Error source, must be <em>front_side</em></td>",
"rst_description":"Error source, must be *front_side*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport'",
"html_description":"<td>The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”</td>",
"rst_description":"The section of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Base64-encoded hash of the file with the front side of the document",
"html_description":"<td>Base64-encoded hash of the file with the front side of the document</td>",
"rst_description":"Base64-encoded hash of the file with the front side of the document\n",
"name":"file_hash",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrorreverseside",
"name":"PassportElementErrorReverseSide",
"description":"Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.",
"html_description":"<p>Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.</p>",
"rst_description":"Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be reverse_side",
"html_description":"<td>Error source, must be <em>reverse_side</em></td>",
"rst_description":"Error source, must be *reverse_side*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the issue, one of 'driver_license', 'identity_card'",
"html_description":"<td>The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”</td>",
"rst_description":"The section of the user's Telegram Passport which has the issue, one of 'driver_license', 'identity_card'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Base64-encoded hash of the file with the reverse side of the document",
"html_description":"<td>Base64-encoded hash of the file with the reverse side of the document</td>",
"rst_description":"Base64-encoded hash of the file with the reverse side of the document\n",
"name":"file_hash",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrorselfie",
"name":"PassportElementErrorSelfie",
"description":"Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.",
"html_description":"<p>Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.</p>",
"rst_description":"Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be selfie",
"html_description":"<td>Error source, must be <em>selfie</em></td>",
"rst_description":"Error source, must be *selfie*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport'",
"html_description":"<td>The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”</td>",
"rst_description":"The section of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport'\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Base64-encoded hash of the file with the selfie",
"html_description":"<td>Base64-encoded hash of the file with the selfie</td>",
"rst_description":"Base64-encoded hash of the file with the selfie\n",
"name":"file_hash",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrorfile",
"name":"PassportElementErrorFile",
"description":"Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.",
"html_description":"<p>Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.</p>",
"rst_description":"Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be file",
"html_description":"<td>Error source, must be <em>file</em></td>",
"rst_description":"Error source, must be *file*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the issue, one of 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'",
"html_description":"<td>The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”</td>",
"rst_description":"The section of the user's Telegram Passport which has the issue, one of 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'\n",
"description":"Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.",
"html_description":"<p>Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.</p>",
"rst_description":"Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be files",
"html_description":"<td>Error source, must be <em>files</em></td>",
"rst_description":"Error source, must be *files*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"The section of the user's Telegram Passport which has the issue, one of 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'",
"html_description":"<td>The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”</td>",
"rst_description":"The section of the user's Telegram Passport which has the issue, one of 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'\n",
"name":"type",
"required":true
},
{
"type":"Array of String",
"description":"List of base64-encoded file hashes",
"html_description":"<td>List of base64-encoded file hashes</td>",
"rst_description":"List of base64-encoded file hashes\n",
"name":"file_hashes",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrortranslationfile",
"name":"PassportElementErrorTranslationFile",
"description":"Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.",
"html_description":"<p>Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.</p>",
"rst_description":"Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.",
"annotations":[
{
"type":"String",
"description":"Error source, must be translation_file",
"html_description":"<td>Error source, must be <em>translation_file</em></td>",
"rst_description":"Error source, must be *translation_file*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"Type of element of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'",
"html_description":"<td>Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”</td>",
"rst_description":"Type of element of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'\n",
"description":"Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.",
"html_description":"<p>Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.</p>",
"rst_description":"Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.",
"annotations":[
{
"type":"String",
"description":"Error source, must be translation_files",
"html_description":"<td>Error source, must be <em>translation_files</em></td>",
"rst_description":"Error source, must be *translation_files*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"Type of element of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'",
"html_description":"<td>Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”</td>",
"rst_description":"Type of element of the user's Telegram Passport which has the issue, one of 'passport', 'driver_license', 'identity_card', 'internal_passport', 'utility_bill', 'bank_statement', 'rental_agreement', 'passport_registration', 'temporary_registration'\n",
"name":"type",
"required":true
},
{
"type":"Array of String",
"description":"List of base64-encoded file hashes",
"html_description":"<td>List of base64-encoded file hashes</td>",
"rst_description":"List of base64-encoded file hashes\n",
"name":"file_hashes",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
},
{
"anchor":"passportelementerrorunspecified",
"name":"PassportElementErrorUnspecified",
"description":"Represents an issue in an unspecified place. The error is considered resolved when new data is added.",
"html_description":"<p>Represents an issue in an unspecified place. The error is considered resolved when new data is added.</p>",
"rst_description":"Represents an issue in an unspecified place. The error is considered resolved when new data is added.",
"annotations":[
{
"type":"String",
"description":"Error source, must be unspecified",
"html_description":"<td>Error source, must be <em>unspecified</em></td>",
"rst_description":"Error source, must be *unspecified*\n",
"name":"source",
"required":true
},
{
"type":"String",
"description":"Type of element of the user's Telegram Passport which has the issue",
"html_description":"<td>Type of element of the user's Telegram Passport which has the issue</td>",
"rst_description":"Type of element of the user's Telegram Passport which has the issue\n",
"name":"type",
"required":true
},
{
"type":"String",
"description":"Base64-encoded element hash",
"html_description":"<td>Base64-encoded element hash</td>",
"rst_description":"Base64-encoded element hash\n",
"name":"element_hash",
"required":true
},
{
"type":"String",
"description":"Error message",
"html_description":"<td>Error message</td>",
"rst_description":"Error message\n",
"name":"message",
"required":true
}
],
"category":"types"
}
],
"description":"Telegram Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the manual for details."
},
{
"title":"Games",
"anchor":"games",
"children":[
{
"anchor":"sendgame",
"name":"sendGame",
"description":"Use this method to send a game. On success, the sent Message is returned.",
"html_description":"<p>Use this method to send a game. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
"rst_description":"Use this method to send a game. On success, the sent :class:`aiogram.types.message.Message` is returned.",
"description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
"html_description":"<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
"rst_description":"Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
"description":"Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.",
"html_description":"<td>Short name of the game, serves as the unique identifier for the game. Set up your games via <a href=\"https://t.me/botfather\">@BotFather</a>.</td>",
"rst_description":"Short name of the game, serves as the unique identifier for the game. Set up your games via `@BotFather <https://t.me/botfather>`_.\n",
"name":"game_short_name"
},
{
"type":"Boolean",
"required":false,
"description":"Sends the message silently. Users will receive a notification with no sound.",
"html_description":"<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
"rst_description":"Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
"name":"disable_notification"
},
{
"type":"Boolean",
"required":false,
"description":"Protects the contents of the sent message from forwarding and saving",
"html_description":"<td>Protects the contents of the sent message from forwarding and saving</td>",
"rst_description":"Protects the contents of the sent message from forwarding and saving\n",
"description":"Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description":"<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description":"Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"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":"<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.</td>",
"rst_description":"A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.\n",
"description":"This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.",
"html_description":"<p>This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.</p>",
"rst_description":"This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.",
"annotations":[
{
"type":"String",
"description":"Title of the game",
"html_description":"<td>Title of the game</td>",
"rst_description":"Title of the game\n",
"name":"title",
"required":true
},
{
"type":"String",
"description":"Description of the game",
"html_description":"<td>Description of the game</td>",
"rst_description":"Description of the game\n",
"name":"description",
"required":true
},
{
"type":"Array of PhotoSize",
"description":"Photo that will be displayed in the game message in chats.",
"html_description":"<td>Photo that will be displayed in the game message in chats.</td>",
"rst_description":"Photo that will be displayed in the game message in chats.\n",
"name":"photo",
"required":true
},
{
"type":"String",
"description":"Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.",
"html_description":"<td><em>Optional</em>. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls <a href=\"#setgamescore\">setGameScore</a>, or manually edited using <a href=\"#editmessagetext\">editMessageText</a>. 0-4096 characters.</td>",
"rst_description":"*Optional*. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls :class:`aiogram.methods.set_game_score.SetGameScore`, or manually edited using :class:`aiogram.methods.edit_message_text.EditMessageText`. 0-4096 characters.\n",
"name":"text",
"required":false
},
{
"type":"Array of MessageEntity",
"description":"Special entities that appear in text, such as usernames, URLs, bot commands, etc.",
"html_description":"<td><em>Optional</em>. Special entities that appear in <em>text</em>, such as usernames, URLs, bot commands, etc.</td>",
"rst_description":"*Optional*. Special entities that appear in *text*, such as usernames, URLs, bot commands, etc.\n",
"name":"text_entities",
"required":false
},
{
"type":"Animation",
"description":"Animation that will be displayed in the game message in chats. Upload via BotFather",
"html_description":"<td><em>Optional</em>. Animation that will be displayed in the game message in chats. Upload via <a href=\"https://t.me/botfather\">BotFather</a></td>",
"rst_description":"*Optional*. Animation that will be displayed in the game message in chats. Upload via `BotFather <https://t.me/botfather>`_\n",
"name":"animation",
"required":false
}
],
"category":"types"
},
{
"anchor":"callbackgame",
"name":"CallbackGame",
"description":"A placeholder, currently holds no information. Use BotFather to set up your game.",
"html_description":"<p>A placeholder, currently holds no information. Use <a href=\"https://t.me/botfather\">BotFather</a> to set up your game.</p>",
"rst_description":"A placeholder, currently holds no information. Use `BotFather <https://t.me/botfather>`_ to set up your game.",
"annotations":[],
"category":"types"
},
{
"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":"<p>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 <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Returns an error, if the new score is not greater than the user's current score in the chat and <em>force</em> is <em>False</em>.</p>",
"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":"<td>User identifier</td>",
"rst_description":"User identifier\n",
"name":"user_id"
},
{
"type":"Integer",
"required":true,
"description":"New score, must be non-negative",
"html_description":"<td>New score, must be non-negative</td>",
"rst_description":"New score, must be non-negative\n",
"name":"score"
},
{
"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":"<td>Pass <em>True</em> if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters</td>",
"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"
},
{
"type":"Boolean",
"required":false,
"description":"Pass True if the game message should not be automatically edited to include the current scoreboard",
"html_description":"<td>Pass <em>True</em> if the game message should not be automatically edited to include the current scoreboard</td>",
"rst_description":"Pass :code:`True` if the game message should not be automatically edited to include the current scoreboard\n",
"name":"disable_edit_message"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat</td>",
"rst_description":"Required if *inline_message_id* is not specified. Unique identifier for the target chat\n",
"name":"chat_id"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Identifier of the sent message</td>",
"rst_description":"Required if *inline_message_id* is not specified. Identifier of the sent message\n",
"name":"message_id"
},
{
"type":"String",
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message",
"html_description":"<td>Required if <em>chat_id</em> and <em>message_id</em> are not specified. Identifier of the inline message</td>",
"rst_description":"Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
"name":"inline_message_id"
}
],
"category":"methods"
},
{
"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":"<p>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 <a href=\"#gamehighscore\">GameHighScore</a> objects.</p><blockquote>\n<p>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.</p>\n</blockquote>",
"rst_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 :class:`aiogram.types.game_high_score.GameHighScore` objects.\n\n 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.",
"annotations":[
{
"type":"Integer",
"required":true,
"description":"Target user id",
"html_description":"<td>Target user id</td>",
"rst_description":"Target user id\n",
"name":"user_id"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Unique identifier for the target chat</td>",
"rst_description":"Required if *inline_message_id* is not specified. Unique identifier for the target chat\n",
"name":"chat_id"
},
{
"type":"Integer",
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message",
"html_description":"<td>Required if <em>inline_message_id</em> is not specified. Identifier of the sent message</td>",
"rst_description":"Required if *inline_message_id* is not specified. Identifier of the sent message\n",
"name":"message_id"
},
{
"type":"String",
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message",
"html_description":"<td>Required if <em>chat_id</em> and <em>message_id</em> are not specified. Identifier of the inline message</td>",
"rst_description":"Required if *chat_id* and *message_id* are not specified. Identifier of the inline message\n",
"description":"This object represents one row of the high scores table for a game.\nAnd that's about all we've got for now.\nIf you've got any questions, please check out our Bot FAQ",
"html_description":"<p>This object represents one row of the high scores table for a game.</p><p>And that's about all we've got for now.<br/>\nIf you've got any questions, please check out our <a href=\"/bots/faq\"><strong>Bot FAQ »</strong></a></p>",
"rst_description":"This object represents one row of the high scores table for a game.\nAnd that's about all we've got for now.\n\nIf you've got any questions, please check out our `https://core.telegram.org/bots/faq <https://core.telegram.org/bots/faq>`_ **Bot FAQ »**",
"description":"Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.\n - Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.\n - Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.\n - If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.\n - You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.\n - To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via BotFather (see Lumberjack for example).\n - A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the disable_edit_message parameter to disable automatic update of the message with the current scoreboard.\n - Use getGameHighScores to get data for in-game high score tables.\n - You can also add an extra sharing button for users to share their best score to different chats.\n - For examples of what can be done using this new stuff, check the @gamebot and @gamee bots."
