diff --git a/data/web/corefork.telegram.org/bots/api-changelog.html b/data/web/corefork.telegram.org/bots/api-changelog.html index 70a0cb8fcc..8009575b57 100644 --- a/data/web/corefork.telegram.org/bots/api-changelog.html +++ b/data/web/corefork.telegram.org/bots/api-changelog.html @@ -47,27 +47,16 @@ To learn how to create…">
-

The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.
To learn how to create and set up a bot, please consult our Introduction to Bots »

+

The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram. +To learn how to create and set up a bot, please consult our Introduction to Bots »

You will find all changes to our Bot API on this page.

-

Recent changes

+

Recent changes

Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk

-

2024

-

February 16, 2024

-

Bot API 7.1

- -

2023

-

December 29, 2023

+

2023

+

December 29, 2023

Bot API 7.0

Reactions

Block Quotation

Multiple Message Actions

-

September 22, 2023

+

September 22, 2023

Bot API 6.9

-

August 18, 2023

+

August 18, 2023

Bot API 6.8

-

April 21, 2023

+

April 21, 2023

Bot API 6.7

-

March 9, 2023

+

March 9, 2023

Bot API 6.6

-

February 3, 2023

+

February 3, 2023

Bot API 6.5

-

2022

-

December 30, 2022

+

2022

+

December 30, 2022

Bot API 6.4

-

November 5, 2022

+

November 5, 2022

Bot API 6.3

-

August 12, 2022

+

August 12, 2022

Bot API 6.2

Custom Emoji Support

+ diff --git a/data/web/corefork.telegram.org/bots/api.html b/data/web/corefork.telegram.org/bots/api.html index 6af9dc1b7a..03b846fcac 100644 --- a/data/web/corefork.telegram.org/bots/api.html +++ b/data/web/corefork.telegram.org/bots/api.html @@ -47,24 +47,14 @@ To learn how to create…">
-

The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.
To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.

+

The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram. +To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.

-

Recent changes

+

Recent changes

Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk

-

February 16, 2024

-

Bot API 7.1

- -

December 29, 2023

+

December 29, 2023

Bot API 7.0

Reactions

Block Quotation

Multiple Message Actions

-

September 22, 2023

+

September 22, 2023

Bot API 6.9

+

August 18, 2023

+

Bot API 6.8

+

See earlier changes »

-

Authorizing your bot

-

Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <token> in this document instead. You can learn about obtaining tokens and generating new ones in this document.

-

Making requests

+

Authorizing your bot

+

Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <token> in this document instead. You can learn about obtaining tokens and generating new ones in this document.

+

Making requests

All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.telegram.org/bot<token>/METHOD_NAME. Like this for example:

https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe

We support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:

@@ -162,17 +161,17 @@ To learn how to create…">
  • application/json (except for uploading files)
  • multipart/form-data (use to upload files)
    • -

    The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

    +

    The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

    -

    Making requests when getting updates

    -

    If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result.

    +

    Making requests when getting updates

    +

    If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result.

    Please see our FAQ for examples.

    -

    Using a Local Bot API Server

    +

    Using a Local Bot API Server

    The Bot API server source code is available at telegram-bot-api. You can run it locally and send the requests to your own server instead of https://api.telegram.org. If you switch to a local Bot API server, your bot will be able to:

    -

    Do I need a Local Bot API Server

    -

    The majority of bots will be OK with the default configuration, running on our servers. But if you feel that you need one of these features, you're welcome to switch to your own at any time.

    -

    Getting updates

    +

    Do I need a Local Bot API Server

    +

    The majority of bots will be OK with the default configuration, running on our servers. But if you feel that you need one of these features, you're welcome to switch to your own at any time.

    +

    Getting updates

    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.

    Regardless of which option you choose, you will receive JSON-serialized Update objects as a result.

    -

    Update

    -

    This object represents an incoming update.
    At most one of the optional parameters can be present in any given update.

    +

    Update

    +

    This object represents an incoming update. +At most one of the optional parameters can be present in any given update.

    @@ -203,7 +203,7 @@ To learn how to create…"> - + @@ -228,12 +228,12 @@ To learn how to create…"> - + - + @@ -273,12 +273,12 @@ To learn how to create…"> - + - + @@ -297,7 +297,7 @@ To learn how to create…">
    update_id IntegerThe 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.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.
    message
    message_reaction MessageReactionUpdatedOptional. 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.Optional. 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.
    message_reaction_count MessageReactionCountUpdatedOptional. 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.Optional. 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.
    inline_query
    my_chat_member ChatMemberUpdatedOptional. 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.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.
    chat_member ChatMemberUpdatedOptional. 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.Optional. 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.
    chat_join_request
    -

    getUpdates

    +

    getUpdates

    Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

    @@ -331,16 +331,18 @@ To learn how to create…"> - +
    allowed_updates Array of String OptionalA 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.

    Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.    		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.

    Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
    -

    Notes
    1. This method will not work if an outgoing webhook is set up.
    2. In order to avoid getting duplicate updates, recalculate offset after each server response.

    +

    Notes +1. This method will not work if an outgoing webhook is set up. +2. In order to avoid getting duplicate updates, recalculate offset after each server response.

    -

    setWebhook

    +

    setWebhook

    Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.

    -

    If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

    +

    If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.

    @@ -373,13 +375,13 @@ To learn how to create…"> - + - + @@ -391,15 +393,20 @@ To learn how to create…"> - +
    max_connections Integer OptionalThe 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.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.
    allowed_updates Array of String OptionalA 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.
    Please 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.    		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.
    Please 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.
    drop_pending_updatessecret_token String OptionalA 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.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.
    -

    Notes
    1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
    2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
    3. Ports currently supported for webhooks: 443, 80, 88, 8443.

    -

    If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

    +

    Notes +1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. +2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work. +3. Ports currently supported for webhooks: 443, 80, 88, 8443.

    -

    deleteWebhook

    +
    +

    If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

    +
    +

    deleteWebhook

    Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

    @@ -419,9 +426,9 @@ To learn how to create…">
    -

    getWebhookInfo

    +

    getWebhookInfo

    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.

    -

    WebhookInfo

    +

    WebhookInfo

    Describes the current status of a webhook.

    @@ -479,13 +486,13 @@ To learn how to create…">
    -

    Available types

    +

    Available types

    All types used in the Bot API responses are represented as JSON-objects.

    It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.

    Optional fields may be not returned when irrelevant.

    -

    User

    +

    User

    This object represents a Telegram user or bot.

    @@ -509,22 +516,22 @@ To learn how to create…"> - + - + - + - + @@ -553,7 +560,7 @@ To learn how to create…">
    first_name StringUser's or bot's first nameUser's or bot's first name
    last_name StringOptional. User's or bot's last nameOptional. User's or bot's last name
    username StringOptional. User's or bot's usernameOptional. User's or bot's username
    language_code StringOptional. IETF language tag of the user's languageOptional. IETF language tag of the user's language
    is_premium
    -

    Chat

    +

    Chat

    This object represents a chat.

    @@ -572,7 +579,7 @@ To learn how to create…"> - + @@ -627,7 +634,7 @@ To learn how to create…"> - + @@ -695,11 +702,6 @@ To learn how to create…"> - - - - - @@ -717,7 +719,7 @@ To learn how to create…"> - + @@ -735,11 +737,6 @@ To learn how to create…"> - - - - - @@ -751,7 +748,7 @@ To learn how to create…">
    type StringType of chat, can be either “private”, “group”, “supergroup” or “channel”Type of chat, can be either "private", "group", "supergroup" or "channel"
    title
    profile_accent_color_id IntegerOptional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat.
    profile_background_custom_emoji_idOptional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.
    unrestrict_boost_countIntegerOptional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.
    message_auto_delete_time Integer Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.
    has_protected_content TrueOptional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.
    has_visible_historyOptional. True, if the bot can change the group sticker set. Returned only in getChat.
    custom_emoji_sticker_set_nameStringOptional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat.
    linked_chat_id Integer Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.
    -

    Message

    +

    Message

    This object represents a message.

    @@ -783,11 +780,6 @@ To learn how to create…"> - - - - - @@ -828,11 +820,6 @@ To learn how to create…"> - - - - - @@ -845,7 +832,7 @@ To learn how to create…"> - + @@ -995,12 +982,12 @@ To learn how to create…"> - + - + @@ -1060,12 +1047,7 @@ To learn how to create…"> - - - - - - + @@ -1090,12 +1072,12 @@ To learn how to create…"> - + - + @@ -1149,7 +1131,7 @@ To learn how to create…">
    Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
    sender_boost_countIntegerOptional. If the sender of the message boosted the chat, the number of boosts added by the user
    date Integer Date the message was sent in Unix time. It is always a positive number, representing a valid date.Optional. For replies that quote part of the original message, the quoted part of the message
    reply_to_storyStoryOptional. For replies to a story, the original story
    via_bot User Optional. Bot through which the message was sent
    has_protected_content TrueOptional. True, if the message can't be forwardedOptional. True, if the message can't be forwarded
    media_group_id
    supergroup_chat_created TrueOptional. 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.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.
    channel_chat_created TrueOptional. 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.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.
    message_auto_delete_timer_changed
    proximity_alert_triggered ProximityAlertTriggeredOptional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
    boost_addedChatBoostAddedOptional. Service message: user boosted the chatOptional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
    forum_topic_created
    general_forum_topic_hidden GeneralForumTopicHiddenOptional. Service message: the 'General' forum topic hiddenOptional. Service message: the 'General' forum topic hidden
    general_forum_topic_unhidden GeneralForumTopicUnhiddenOptional. Service message: the 'General' forum topic unhiddenOptional. Service message: the 'General' forum topic unhidden
    giveaway_created
    -

    MessageId

    +

    MessageId

    This object represents a unique message identifier.

    @@ -1167,7 +1149,7 @@ To learn how to create…">
    -

    InaccessibleMessage

    +

    InaccessibleMessage

    This object describes a message that was deleted or is otherwise inaccessible to the bot.

    @@ -1195,13 +1177,13 @@ To learn how to create…">
    -

    MaybeInaccessibleMessage

    +

    MaybeInaccessibleMessage

    This object describes a message that can be inaccessible to the bot. It can be one of

    -

    MessageEntity

    +

    MessageEntity

    This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

    @@ -1215,7 +1197,7 @@ To learn how to create…"> - + @@ -1230,26 +1212,26 @@ To learn how to create…"> - + - + - + - +
    type StringType of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers)Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "bot_command" (/start@jobs_bot), "url" (https://telegram.org), "email" (do-not-reply@telegram.org), "phone_number" (+1-212-555-0123), "bold" (bold text), "italic" (italic text), "underline" (underlined text), "strikethrough" (strikethrough text), "spoiler" (spoiler message), "blockquote" (block quotation), "code" (monowidth string), "pre" (monowidth block), "text_link" (for clickable text URLs), "text_mention" (for users without usernames), "custom_emoji" (for inline custom emoji stickers)
    offset
    url StringOptional. For “text_link” only, URL that will be opened after user taps on the textOptional. For "text_link" only, URL that will be opened after user taps on the text
    user UserOptional. For “text_mention” only, the mentioned userOptional. For "text_mention" only, the mentioned user
    language StringOptional. For “pre” only, the programming language of the entity textOptional. For "pre" only, the programming language of the entity text
    custom_emoji_id StringOptional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the stickerOptional. For "custom_emoji" only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker
    -

    TextQuote

    +

    TextQuote

    This object contains information about the quoted part of a message that is replied to by the given message.

    @@ -1282,7 +1264,7 @@ To learn how to create…">
    -

    ExternalReplyInfo

    +

    ExternalReplyInfo

    This object contains information about a message that is being replied to, which may come from another chat or forum topic.

    @@ -1410,7 +1392,7 @@ To learn how to create…">
    -

    ReplyParameters

    +

    ReplyParameters

    Describes reply parameters for the message that is being sent.

    @@ -1439,7 +1421,7 @@ To learn how to create…"> - + @@ -1458,7 +1440,7 @@ To learn how to create…">
    quote StringOptional. 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.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.
    quote_parse_mode
    -

    MessageOrigin

    +

    MessageOrigin

    This object describes the origin of a message. It can be one of

    -

    MessageOriginUser

    +

    MessageOriginUser

    The message was originally sent by a known user.

    @@ -1480,7 +1462,7 @@ To learn how to create…"> - + @@ -1494,7 +1476,7 @@ To learn how to create…">
    type StringType of the message origin, always “user”Type of the message origin, always "user"
    date
    -

    MessageOriginHiddenUser

    +

    MessageOriginHiddenUser

    The message was originally sent by an unknown user.

    @@ -1508,7 +1490,7 @@ To learn how to create…"> - + @@ -1522,7 +1504,7 @@ To learn how to create…">
    type StringType of the message origin, always “hidden_user”Type of the message origin, always "hidden_user"
    date
    -

    MessageOriginChat

    +

    MessageOriginChat

    The message was originally sent on behalf of a chat to a group chat.

    @@ -1536,7 +1518,7 @@ To learn how to create…"> - + @@ -1555,7 +1537,7 @@ To learn how to create…">
    type StringType of the message origin, always “chat”Type of the message origin, always "chat"
    date
    -

    MessageOriginChannel

    +

    MessageOriginChannel

    The message was originally sent to a channel chat.

    @@ -1569,7 +1551,7 @@ To learn how to create…"> - + @@ -1593,7 +1575,7 @@ To learn how to create…">
    type StringType of the message origin, always “channel”Type of the message origin, always "channel"
    date
    -

    PhotoSize

    +

    PhotoSize

    This object represents one size of a photo or a file / sticker thumbnail.

    @@ -1612,7 +1594,7 @@ To learn how to create…"> - + @@ -1631,7 +1613,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    width
    -

    Animation

    +

    Animation

    This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

    @@ -1650,7 +1632,7 @@ To learn how to create…"> - + @@ -1689,7 +1671,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    width
    -

    Audio

    +

    Audio

    This object represents an audio file to be treated as music by the Telegram clients.

    @@ -1708,7 +1690,7 @@ To learn how to create…"> - + @@ -1747,7 +1729,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    duration
    -

    Document

    +

    Document

    This object represents a general file (as opposed to photos, voice messages and audio files).

    @@ -1766,7 +1748,7 @@ To learn how to create…"> - + @@ -1790,30 +1772,9 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    thumbnail
    -

    Story

    -

    This object represents a story.

    - - - - - - - - - - - - - - - - - - - - -
    FieldTypeDescription
    chatChatChat that posted the story
    idIntegerUnique identifier for the story in the chat
    -

    Video

    +

    Story

    +

    This object represents a message about a forwarded story in the chat. Currently holds no information.

    +

    Video

    This object represents a video file.

    @@ -1832,7 +1793,7 @@ To learn how to create…"> - + @@ -1871,7 +1832,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    width
    -

    VideoNote

    +

    VideoNote

    This object represents a video message (available in Telegram apps as of v.4.0).

    @@ -1890,7 +1851,7 @@ To learn how to create…"> - + @@ -1914,7 +1875,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    length
    -

    Voice

    +

    Voice

    This object represents a voice note.

    @@ -1933,7 +1894,7 @@ To learn how to create…"> - + @@ -1952,7 +1913,7 @@ To learn how to create…">
    file_unique_id StringUnique 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.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.
    duration
    -

    Contact

    +

    Contact

    This object represents a phone contact.

    @@ -1966,22 +1927,22 @@ To learn how to create…"> - + - + - + - + @@ -1990,7 +1951,7 @@ To learn how to create…">
    phone_number StringContact's phone numberContact's phone number
    first_name StringContact's first nameContact's first name
    last_name StringOptional. Contact's last nameOptional. Contact's last name
    user_id IntegerOptional. 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.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.
    vcard
    -

    Dice

    +

    Dice

    This object represents an animated emoji that displays a random value.

    @@ -2009,11 +1970,11 @@ To learn how to create…"> - +
    value IntegerValue of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emojiValue of the dice, 1-6 for "🎲", "🎯" and "🎳" base emoji, 1-5 for "🏀" and "⚽" base emoji, 1-64 for "🎰" base emoji
    -

    PollOption

    +

    PollOption

    This object contains information about one answer option in a poll.

    @@ -2036,7 +1997,7 @@ To learn how to create…">
    -

    PollAnswer

    +

    PollAnswer

    This object represents an answer of a user in a non-anonymous poll.

    @@ -2060,7 +2021,7 @@ To learn how to create…"> - + @@ -2069,7 +2030,7 @@ To learn how to create…">
    user UserOptional. The user that changed the answer to the poll, if the voter isn't anonymousOptional. The user that changed the answer to the poll, if the voter isn't anonymous
    option_ids
    -

    Poll

    +

    Poll

    This object contains information about a poll.

    @@ -2113,7 +2074,7 @@ To learn how to create…"> - + @@ -2147,7 +2108,7 @@ To learn how to create…">
    type StringPoll type, currently can be “regular” or “quiz”Poll type, currently can be "regular" or "quiz"
    allows_multiple_answers
    -

    Location

    +

    Location

    This object represents a point on the map.

    @@ -2159,16 +2120,16 @@ To learn how to create…"> - - - - - + + + + + @@ -2190,7 +2151,7 @@ To learn how to create…">
    latitudeFloatLatitude as defined by sender
    longitude Float Longitude as defined by sender
    latitudeFloatLatitude as defined by sender
    horizontal_accuracy Float Optional. The radius of uncertainty for the location, measured in meters; 0-1500
    -

    Venue

    +

    Venue

    This object represents a venue.

    @@ -2204,7 +2165,7 @@ To learn how to create…"> - + @@ -2224,7 +2185,7 @@ To learn how to create…"> - + @@ -2238,7 +2199,7 @@ To learn how to create…">
    location LocationVenue location. Can't be a live locationVenue location. Can't be a live location
    title
    foursquare_type StringOptional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)Optional. Foursquare type of the venue. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
    google_place_id
    -

    WebAppData

    +

    WebAppData

    Describes data sent from a Web App to the bot.

    @@ -2261,7 +2222,7 @@ To learn how to create…">
    -

    ProximityAlertTriggered

    +

    ProximityAlertTriggered

    This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

    @@ -2289,7 +2250,7 @@ To learn how to create…">
    -

    MessageAutoDeleteTimerChanged

    +

    MessageAutoDeleteTimerChanged

    This object represents a service message about a change in auto-delete timer settings.

    @@ -2307,25 +2268,7 @@ To learn how to create…">
    -

    ChatBoostAdded

    -

    This object represents a service message about a user boosting a chat.

    - - - - - - - - - - - - - - - -
    FieldTypeDescription
    boost_countIntegerNumber of boosts added by the user
    -

    ForumTopicCreated

    +

    ForumTopicCreated

    This object represents a service message about a new forum topic created in the chat.

    @@ -2353,9 +2296,9 @@ To learn how to create…">
    -

    ForumTopicClosed

    +

    ForumTopicClosed

    This object represents a service message about a forum topic closed in the chat. Currently holds no information.

    -

    ForumTopicEdited

    +

    ForumTopicEdited

    This object represents a service message about an edited forum topic.

    @@ -2378,13 +2321,13 @@ To learn how to create…">
    -

    ForumTopicReopened

    +

    ForumTopicReopened

    This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

    -

    GeneralForumTopicHidden

    +

    GeneralForumTopicHidden

    This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

    -

    GeneralForumTopicUnhidden

    +

    GeneralForumTopicUnhidden

    This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

    -

    UsersShared

    +

    UsersShared

    This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

    @@ -2407,7 +2350,7 @@ To learn how to create…">
    -

    ChatShared

    +

    ChatShared

    This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.

    @@ -2430,7 +2373,7 @@ To learn how to create…">
    -

    WriteAccessAllowed

    +

    WriteAccessAllowed

    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.

    @@ -2458,7 +2401,7 @@ To learn how to create…">
    -

    VideoChatScheduled

    +

    VideoChatScheduled

    This object represents a service message about a video chat scheduled in the chat.

    @@ -2476,9 +2419,9 @@ To learn how to create…">
    -

    VideoChatStarted

    +

    VideoChatStarted

    This object represents a service message about a video chat started in the chat. Currently holds no information.

    -

    VideoChatEnded

    +

    VideoChatEnded

    This object represents a service message about a video chat ended in the chat.

    @@ -2496,7 +2439,7 @@ To learn how to create…">
    -

    VideoChatParticipantsInvited

    +

    VideoChatParticipantsInvited

    This object represents a service message about new members invited to a video chat.

    @@ -2514,9 +2457,9 @@ To learn how to create…">
    -

    GiveawayCreated

    +

    GiveawayCreated

    This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.

    -

    Giveaway

    +

    Giveaway

    This object represents a message about a scheduled giveaway.

    @@ -2569,7 +2512,7 @@ To learn how to create…">
    -

    GiveawayWinners

    +

    GiveawayWinners

    This object represents a message about the completion of a giveaway with public winners.

    @@ -2637,7 +2580,7 @@ To learn how to create…">
    -

    GiveawayCompleted

    +

    GiveawayCompleted

    This object represents a service message about the completion of a giveaway without public winners.

    @@ -2661,11 +2604,11 @@ To learn how to create…"> - +
    giveaway_message MessageOptional. Message with the giveaway that was completed, if it wasn't deletedOptional. Message with the giveaway that was completed, if it wasn't deleted
    -

    LinkPreviewOptions

    +

    LinkPreviewOptions

    Describes the options used for link preview generation.

    @@ -2689,12 +2632,12 @@ To learn how to create…"> - + - + @@ -2703,8 +2646,8 @@ To learn how to create…">
    prefer_small_media BooleanOptional. 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 previewOptional. 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
    prefer_large_media BooleanOptional. 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 previewOptional. 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
    show_above_text
    -

    UserProfilePhotos

    -

    This object represent a user's profile pictures.

    +

    UserProfilePhotos

    +

    This object represent a user's profile pictures.

    @@ -2726,7 +2669,7 @@ To learn how to create…">
    -

    File

    +

    File

    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.

    The maximum file size to download is 20 MB

    @@ -2748,7 +2691,7 @@ To learn how to create…"> file_unique_id String -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. +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. file_size @@ -2762,7 +2705,7 @@ To learn how to create…"> -

    WebAppInfo

    +

    WebAppInfo

    Describes a Web App.

    @@ -2780,7 +2723,7 @@ To learn how to create…">
    -

    ReplyKeyboardMarkup

    +

    ReplyKeyboardMarkup

    This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

    @@ -2804,12 +2747,12 @@ To learn how to create…"> - + - + @@ -2819,11 +2762,11 @@ To learn how to create…"> - +
    resize_keyboard BooleanOptional. 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.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.
    one_time_keyboard BooleanOptional. 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.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.
    input_field_placeholder
    selective BooleanOptional. 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.

    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.    		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 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.

    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.
    -

    KeyboardButton

    +

    KeyboardButton

    This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.

    @@ -2842,22 +2785,22 @@ To learn how to create…"> - + - + - + - + @@ -2867,12 +2810,12 @@ To learn how to create…"> - +
    request_users KeyboardButtonRequestUsersOptional. 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.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.
    request_chat KeyboardButtonRequestChatOptional. 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.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.
    request_contact BooleanOptional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
    request_location BooleanOptional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
    request_poll
    web_app WebAppInfoOptional. 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.Optional. 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.

    Note: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

    -

    KeyboardButtonRequestUsers

    +

    KeyboardButtonRequestUsers

    This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »

    @@ -2905,7 +2848,7 @@ To learn how to create…">
    -

    KeyboardButtonRequestChat

    +

    KeyboardButtonRequestChat

    This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats »

    @@ -2958,7 +2901,7 @@ To learn how to create…">
    -

    KeyboardButtonPollType

    +

    KeyboardButtonPollType

    This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

    @@ -2976,7 +2919,7 @@ To learn how to create…">
    -

    ReplyKeyboardRemove

    +

    ReplyKeyboardRemove

    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).

    @@ -2995,11 +2938,11 @@ To learn how to create…"> - +
    selective BooleanOptional. 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.

    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.    		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 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.

    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.
    -

    InlineKeyboardMarkup

    +

    InlineKeyboardMarkup

    This object represents an inline keyboard that appears right next to the message it belongs to.

    @@ -3017,7 +2960,7 @@ To learn how to create…">
    -

    InlineKeyboardButton

    +

    InlineKeyboardButton

    This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

    @@ -3056,17 +2999,17 @@ To learn how to create…"> - + - + - + @@ -3080,12 +3023,11 @@ To learn how to create…">
    switch_inline_query StringOptional. 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.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.
    switch_inline_query_current_chat StringOptional. 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.

    This 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.    		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.

    This 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.
    switch_inline_query_chosen_chat SwitchInlineQueryChosenChatOptional. 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 fieldOptional. 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
    callback_game
    -

    LoginUrl

    +

    LoginUrl

    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:

    - TITLE + TITLE
    -

    Telegram apps support these buttons as of version 5.7.

    Sample bot: @discussbot

    @@ -3112,7 +3054,7 @@ To learn how to create…"> bot_username String -Optional. 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. +Optional. 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. request_write_access @@ -3121,7 +3063,7 @@ To learn how to create…"> -

    SwitchInlineQueryChosenChat

    +

    SwitchInlineQueryChosenChat

    This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

    @@ -3135,7 +3077,7 @@ To learn how to create…"> - + @@ -3159,7 +3101,7 @@ To learn how to create…">
    query StringOptional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be insertedOptional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted
    allow_user_chats
    -

    CallbackQuery

    +

    CallbackQuery

    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.

    @@ -3210,8 +3152,8 @@ To learn how to create…">

    NOTE: 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).

    -

    ForceReply

    -

    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.

    +

    ForceReply

    +

    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.

    @@ -3224,7 +3166,7 @@ To learn how to create…"> - + @@ -3234,7 +3176,7 @@ To learn how to create…"> - +
    force_reply TrueShows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
    input_field_placeholder
    selective BooleanOptional. 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.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 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.
    @@ -3242,11 +3184,11 @@ To learn how to create…">

    Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:

    • 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.
      • -
    • 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'.
      • +
    • 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'.
    -

    The 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.

    +

    The 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.

    -

    ChatPhoto

    +

    ChatPhoto

    This object represents a chat photo.

    @@ -3265,7 +3207,7 @@ To learn how to create…"> - + @@ -3275,11 +3217,11 @@ To learn how to create…"> - +
    small_file_unique_id StringUnique 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.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.
    big_file_id
    big_file_unique_id StringUnique 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.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.
    -

    ChatInviteLink

    +

    ChatInviteLink

    Represents an invite link for a chat.

    @@ -3293,7 +3235,7 @@ To learn how to create…"> - + @@ -3337,7 +3279,7 @@ To learn how to create…">
    invite_link StringThe invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "...".
    creator
    -

    ChatAdministratorRights

    +

    ChatAdministratorRights

    Represents the rights of an administrator in a chat.

    @@ -3351,12 +3293,12 @@ To learn how to create…"> - + - + @@ -3389,43 +3331,43 @@ To learn how to create…"> - - - - - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + - +
    is_anonymous BooleanTrue, if the user's presence in the chat is hiddenTrue, if the user's presence in the chat is hidden
    can_manage_chat BooleanTrue, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
    can_delete_messagesTrue, if the user is allowed to invite new users to the chat
    can_post_storiesBooleanTrue, if the administrator can post stories to the chat
    can_edit_storiesBooleanTrue, if the administrator can edit stories posted by other users
    can_delete_storiesBooleanTrue, if the administrator can delete stories posted by other users
    can_post_messages BooleanOptional. True, if the administrator can post messages in the channel, or access channel statistics; for channels onlyOptional. True, if the administrator can post messages in the channel, or access channel statistics; channels only
    can_edit_messages BooleanOptional. True, if the administrator can edit messages of other users and can pin messages; for channels onlyOptional. True, if the administrator can edit messages of other users and can pin messages; channels only
    can_pin_messages BooleanOptional. True, if the user is allowed to pin messages; for groups and supergroups onlyOptional. True, if the user is allowed to pin messages; groups and supergroups only
    can_post_storiesBooleanOptional. True, if the administrator can post stories in the channel; channels only
    can_edit_storiesBooleanOptional. True, if the administrator can edit stories posted by other users; channels only
    can_delete_storiesBooleanOptional. True, if the administrator can delete stories posted by other users; channels only
    can_manage_topics BooleanOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups onlyOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
    -

    ChatMemberUpdated

    +

    ChatMemberUpdated

    This object represents changes in the status of a chat member.

    @@ -3473,7 +3415,7 @@ To learn how to create…">
    -

    ChatMember

    +

    ChatMember

    This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

    -

    ChatMemberOwner

    +

    ChatMemberOwner

    Represents a chat member that owns the chat and has all administrator privileges.

    @@ -3497,7 +3439,7 @@ To learn how to create…"> - + @@ -3507,7 +3449,7 @@ To learn how to create…"> - + @@ -3516,7 +3458,7 @@ To learn how to create…">
    status StringThe member's status in the chat, always “creator”The member's status in the chat, always "creator"
    user
    is_anonymous BooleanTrue, if the user's presence in the chat is hiddenTrue, if the user's presence in the chat is hidden
    custom_title
    -

    ChatMemberAdministrator

    +

    ChatMemberAdministrator

    Represents a chat member that has some additional privileges.

    @@ -3530,7 +3472,7 @@ To learn how to create…"> - + @@ -3545,12 +3487,12 @@ To learn how to create…"> - + - + @@ -3583,39 +3525,39 @@ To learn how to create…"> - - - - - - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + - + @@ -3624,7 +3566,7 @@ To learn how to create…">
    status StringThe member's status in the chat, always “administrator”The member's status in the chat, always "administrator"
    user
    is_anonymous BooleanTrue, if the user's presence in the chat is hiddenTrue, if the user's presence in the chat is hidden
    can_manage_chat BooleanTrue, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.True, if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
    can_delete_messagesTrue, if the user is allowed to invite new users to the chat
    can_post_storiesBooleanTrue, if the administrator can post stories to the chat
    can_edit_storiesBooleanTrue, if the administrator can edit stories posted by other users
    can_delete_storiesBooleanTrue, if the administrator can delete stories posted by other users
    can_post_messages BooleanOptional. True, if the administrator can post messages in the channel, or access channel statistics; for channels onlyOptional. True, if the administrator can post messages in the channel, or access channel statistics; channels only
    can_edit_messages BooleanOptional. True, if the administrator can edit messages of other users and can pin messages; for channels onlyOptional. True, if the administrator can edit messages of other users and can pin messages; channels only
    can_pin_messages BooleanOptional. True, if the user is allowed to pin messages; for groups and supergroups onlyOptional. True, if the user is allowed to pin messages; groups and supergroups only
    can_post_storiesBooleanOptional. True, if the administrator can post stories in the channel; channels only
    can_edit_storiesBooleanOptional. True, if the administrator can edit stories posted by other users; channels only
    can_delete_storiesBooleanOptional. True, if the administrator can delete stories posted by other users; channels only
    can_manage_topics BooleanOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups onlyOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only
    custom_title
    -

    ChatMemberMember

    +

    ChatMemberMember

    Represents a chat member that has no additional privileges or restrictions.

    @@ -3638,7 +3580,7 @@ To learn how to create…"> - + @@ -3647,7 +3589,7 @@ To learn how to create…">
    status StringThe member's status in the chat, always “member”The member's status in the chat, always "member"
    user
    -

    ChatMemberRestricted

    +

    ChatMemberRestricted

    Represents a chat member that is under certain restrictions in the chat. Supergroups only.

    @@ -3661,7 +3603,7 @@ To learn how to create…"> - + @@ -3750,8 +3692,8 @@ To learn how to create…">
    status StringThe member's status in the chat, always “restricted”The member's status in the chat, always "restricted"
    user
    -

    ChatMemberLeft

    -

    Represents a chat member that isn't currently a member of the chat, but may join it themselves.

    +

    ChatMemberLeft

    +

    Represents a chat member that isn't currently a member of the chat, but may join it themselves.

    @@ -3764,7 +3706,7 @@ To learn how to create…"> - + @@ -3773,8 +3715,8 @@ To learn how to create…">
    status StringThe member's status in the chat, always “left”The member's status in the chat, always "left"
    user
    -

    ChatMemberBanned

    -

    Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

    +

    ChatMemberBanned

    +

    Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

    @@ -3787,7 +3729,7 @@ To learn how to create…"> - + @@ -3801,7 +3743,7 @@ To learn how to create…">
    status StringThe member's status in the chat, always “kicked”The member's status in the chat, always "kicked"
    user
    -

    ChatJoinRequest

    +

    ChatJoinRequest

    Represents a join request sent to a chat.

    @@ -3844,7 +3786,7 @@ To learn how to create…">
    -

    ChatPermissions

    +

    ChatPermissions

    Describes actions that a non-administrator user is allowed to take in a chat.

    @@ -3927,7 +3869,7 @@ To learn how to create…">
    -

    ChatLocation

    +

    ChatLocation

    Represents a location to which a chat is connected.

    @@ -3941,7 +3883,7 @@ To learn how to create…"> - + @@ -3950,13 +3892,13 @@ To learn how to create…">
    location LocationThe location to which the supergroup is connected. Can't be a live location.The location to which the supergroup is connected. Can't be a live location.
    address
    -

    ReactionType

    +

    ReactionType

    This object describes the type of a reaction. Currently, it can be one of

    -

    ReactionTypeEmoji

    +

    ReactionTypeEmoji

    The reaction is based on an emoji.

    @@ -3970,7 +3912,7 @@ To learn how to create…"> - + @@ -3979,7 +3921,7 @@ To learn how to create…">
    type StringType of the reaction, always “emoji”Type of the reaction, always "emoji"
    emoji
    -

    ReactionTypeCustomEmoji

    +

    ReactionTypeCustomEmoji

    The reaction is based on a custom emoji.

    @@ -3993,7 +3935,7 @@ To learn how to create…"> - + @@ -4002,7 +3944,7 @@ To learn how to create…">
    type StringType of the reaction, always “custom_emoji”Type of the reaction, always "custom_emoji"
    custom_emoji_id
    -

    ReactionCount

    +

    ReactionCount

    Represents a reaction added to a message along with the number of times it was added.

    @@ -4025,7 +3967,7 @@ To learn how to create…">
    -

    MessageReactionUpdated

    +

    MessageReactionUpdated

    This object represents a change of a reaction on a message performed by a user.

    @@ -4049,7 +3991,7 @@ To learn how to create…"> - + @@ -4073,7 +4015,7 @@ To learn how to create…">
    user UserOptional. The user that changed the reaction, if the user isn't anonymousOptional. The user that changed the reaction, if the user isn't anonymous
    actor_chat
    -

    MessageReactionCountUpdated

    +

    MessageReactionCountUpdated

    This object represents reaction changes on a message with anonymous reactions.

    @@ -4106,7 +4048,7 @@ To learn how to create…">
    -

    ForumTopic

    +

    ForumTopic

    This object represents a forum topic.

    @@ -4139,7 +4081,7 @@ To learn how to create…">
    -

    BotCommand

    +

    BotCommand

    This object represents a bot command.

    @@ -4162,7 +4104,7 @@ To learn how to create…">
    -

    BotCommandScope

    +

    BotCommandScope

    This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

    -

    Determining list of commands

    +

    Determining list of commands

    The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:

    Commands in the chat with the bot

    -

    BotCommandScopeDefault

    +

    BotCommandScopeDefault

    Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

    @@ -4217,7 +4159,7 @@ To learn how to create…">
    -

    BotCommandScopeAllPrivateChats

    +

    BotCommandScopeAllPrivateChats

    Represents the scope of bot commands, covering all private chats.

    @@ -4235,7 +4177,7 @@ To learn how to create…">
    -

    BotCommandScopeAllGroupChats

    +

    BotCommandScopeAllGroupChats

    Represents the scope of bot commands, covering all group and supergroup chats.

    @@ -4253,7 +4195,7 @@ To learn how to create…">
    -

    BotCommandScopeAllChatAdministrators

    +

    BotCommandScopeAllChatAdministrators

    Represents the scope of bot commands, covering all group and supergroup chat administrators.

    @@ -4271,7 +4213,7 @@ To learn how to create…">
    -

    BotCommandScopeChat

    +

    BotCommandScopeChat

    Represents the scope of bot commands, covering a specific chat.

    @@ -4294,7 +4236,7 @@ To learn how to create…">
    -

    BotCommandScopeChatAdministrators

    +

    BotCommandScopeChatAdministrators

    Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

    @@ -4317,7 +4259,7 @@ To learn how to create…">
    -

    BotCommandScopeChatMember

    +

    BotCommandScopeChatMember

    Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

    @@ -4345,8 +4287,8 @@ To learn how to create…">
    -

    BotName

    -

    This object represents the bot's name.

    +

    BotName

    +

    This object represents the bot's name.

    @@ -4359,12 +4301,12 @@ To learn how to create…"> - +
    name StringThe bot's nameThe bot's name
    -

    BotDescription

    -

    This object represents the bot's description.

    +

    BotDescription

    +

    This object represents the bot's description.

    @@ -4377,12 +4319,12 @@ To learn how to create…"> - +
    description StringThe bot's descriptionThe bot's description
    -

    BotShortDescription

    -

    This object represents the bot's short description.

    +

    BotShortDescription

    +

    This object represents the bot's short description.

    @@ -4395,20 +4337,20 @@ To learn how to create…"> - +
    short_description StringThe bot's short descriptionThe bot's short description
    -

    MenuButton

    -

    This object describes the bot's menu button in a private chat. It should be one of

    +

    MenuButton

    +

    This object describes the bot's menu button in a private chat. It should be one of

    If 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.

    -

    MenuButtonCommands

    -

    Represents a menu button, which opens the bot's list of commands.

    +

    MenuButtonCommands

    +

    Represents a menu button, which opens the bot's list of commands.

    @@ -4425,7 +4367,7 @@ To learn how to create…">
    -

    MenuButtonWebApp

    +

    MenuButtonWebApp

    Represents a menu button, which launches a Web App.

    @@ -4453,7 +4395,7 @@ To learn how to create…">
    -

    MenuButtonDefault

    +

    MenuButtonDefault

    Describes that no specific value for the menu button was set.

    @@ -4471,14 +4413,14 @@ To learn how to create…">
    -

    ChatBoostSource

    +

    ChatBoostSource

    This object describes the source of a chat boost. It can be one of

    -

    ChatBoostSourcePremium

    +

    ChatBoostSourcePremium

    The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

    @@ -4492,7 +4434,7 @@ To learn how to create…"> - + @@ -4501,7 +4443,7 @@ To learn how to create…">
    source StringSource of the boost, always “premium”Source of the boost, always "premium"
    user
    -

    ChatBoostSourceGiftCode

    +

    ChatBoostSourceGiftCode

    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.

    @@ -4515,7 +4457,7 @@ To learn how to create…"> - + @@ -4524,7 +4466,7 @@ To learn how to create…">
    source StringSource of the boost, always “gift_code”Source of the boost, always "gift_code"
    user
    -

    ChatBoostSourceGiveaway

    +

    ChatBoostSourceGiveaway

    The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

    @@ -4538,12 +4480,12 @@ To learn how to create…"> - + - + @@ -4557,7 +4499,7 @@ To learn how to create…">
    source StringSource of the boost, always “giveaway”Source of the boost, always "giveaway"
    giveaway_message_id IntegerIdentifier 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.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.
    user
    -

    ChatBoost

    +

    ChatBoost

    This object contains information about a chat boost.

    @@ -4581,7 +4523,7 @@ To learn how to create…"> - + @@ -4590,7 +4532,7 @@ To learn how to create…">
    expiration_date IntegerPoint in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolongedPoint in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
    source
    -

    ChatBoostUpdated

    +

    ChatBoostUpdated

    This object represents a boost added to a chat or changed.

    @@ -4613,7 +4555,7 @@ To learn how to create…">
    -

    ChatBoostRemoved

    +

    ChatBoostRemoved

    This object represents a boost removed from a chat.

    @@ -4646,7 +4588,7 @@ To learn how to create…">
    -

    UserChatBoosts

    +

    UserChatBoosts

    This object represents a list of boosts added to a chat by a user.

    @@ -4664,7 +4606,7 @@ To learn how to create…">
    -

    ResponseParameters

    +

    ResponseParameters

    Describes why a request was unsuccessful.

    @@ -4687,7 +4629,7 @@ To learn how to create…">
    -

    InputMedia

    +

    InputMedia

    This object represents the content of a media message to be sent. It should be one of

    -

    InputMediaPhoto

    +

    InputMediaPhoto

    Represents a photo to be sent.

    @@ -4715,7 +4657,7 @@ To learn how to create…"> - + @@ -4739,7 +4681,7 @@ To learn how to create…">
    media StringFile 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 »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 »
    caption
    -

    InputMediaVideo

    +

    InputMediaVideo

    Represents a video to be sent.

    @@ -4758,12 +4700,12 @@ To learn how to create…"> - + - + @@ -4807,7 +4749,7 @@ To learn how to create…">
    media StringFile 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 »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 »
    thumbnail InputFile or StringOptional. 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 »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>. More information on Sending Files »
    caption
    -

    InputMediaAnimation

    +

    InputMediaAnimation

    Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

    @@ -4826,12 +4768,12 @@ To learn how to create…"> - + - + @@ -4870,7 +4812,7 @@ To learn how to create…">
    media StringFile 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 »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 »
    thumbnail InputFile or StringOptional. 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 »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>. More information on Sending Files »
    caption
    -

    InputMediaAudio

    +

    InputMediaAudio

    Represents an audio file to be treated as music to be sent.

    @@ -4889,12 +4831,12 @@ To learn how to create…"> - + - + @@ -4928,7 +4870,7 @@ To learn how to create…">
    media StringFile 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 »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 »
    thumbnail InputFile or StringOptional. 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 »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>. More information on Sending Files »
    caption
    -

    InputMediaDocument

    +

    InputMediaDocument

    Represents a general file to be sent.

    @@ -4947,12 +4889,12 @@ To learn how to create…"> - + - + @@ -4976,21 +4918,21 @@ To learn how to create…">
    media StringFile 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 »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 »
    thumbnail InputFile or StringOptional. 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 »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>. More information on Sending Files »
    caption
    -

    InputFile

    +

    InputFile

    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.

    -

    Sending files

    +

    Sending files

    There are three ways to send files (photos, stickers, audio, media, etc.):

      -
    1. If the file is already stored somewhere on the Telegram servers, you don't need to reupload it: each file object has a file_id field, simply pass this file_id as a parameter instead of uploading. There are no limits for files sent this way.
      2. +
    2. If the file is already stored somewhere on the Telegram servers, you don't need to reupload it: each file object has a file_id field, simply pass this file_id as a parameter instead of uploading. There are no limits for files sent this way.
    3. Provide Telegram with an HTTP URL for the file to be sent. Telegram will download and send the file. 5 MB max size for photos and 20 MB max for other types of content.
    4. Post the file using multipart/form-data in the usual way that files are uploaded via the browser. 10 MB max size for photos, 50 MB for other files.

    Sending by file_id

    Sending by URL

    @@ -4998,9 +4940,9 @@ To learn how to create…">
  • When sending by URL the target file must have the correct MIME type (e.g., audio/mpeg for sendAudio, etc.).
  • In sendDocument, sending by URL will currently only work for GIF, PDF and ZIP files.
  • To use sendVoice, the file must have the type audio/ogg and be no more than 1MB in size. 1-20MB voice notes will be sent as files.
    • -
  • Other configurations may work but we can't guarantee that they will.
    • +
  • Other configurations may work but we can't guarantee that they will.
    • -

    Accent colors

    +

    Accent colors

    Colors with identifiers 0 (red), 1 (orange), 2 (purple/violet), 3 (green), 4 (cyan), 5 (blue), 6 (pink) can be customized by app themes. Additionally, the following colors in RGB format are currently in use.

    @@ -5023,7 +4965,7 @@ To learn how to create…">
    201585CF F2AB1D FFFFFF3DA6EB EEA51D FFFFFF

    -

    Profile accent colors

    +

    Profile accent colors

    Currently, the following colors in RGB format are in use for profile backgrounds.

    @@ -5048,19 +4990,20 @@ To learn how to create…">
    15637482 7B8A9753606E 384654

    -

    Inline mode objects

    +

    Inline mode objects

    Objects and methods used in the inline mode are described in the Inline mode section.

    -

    Available methods

    +

    Available methods

    -

    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.
    On successful call, a JSON-object containing the result will be returned.

    +

    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. +On successful call, a JSON-object containing the result will be returned.

    -

    getMe

    -

    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.

    -

    logOut

    +

    getMe

    +

    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.

    +

    logOut

    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.

    -

    close

    -

    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.

    -

    sendMessage

    +

    close

    +

    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.

    +

    sendMessage

    Use this method to send text messages. On success, the sent Message is returned.

    @@ -5134,17 +5077,23 @@ To learn how to create…">
    -

    Formatting options

    -

    The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting.

    -

    Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).

    -

    Message entities can be nested, providing following restrictions are met:
    - If two entities have common characters, then one of them is fully contained inside another.
    - bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
    - blockquote entities can't be nested.
    - All other entities can't contain each other.

    +

    Formatting options

    +

    The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting.

    +

    Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).

    +

    Message entities can be nested, providing following restrictions are met:

    +

    Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username. Please note:

    You can find the list of programming and markup languages for which syntax highlighting is supported at libprisma#supported-languages.

    -
    MarkdownV2 style
    +
    MarkdownV2 style

    To use this mode, pass MarkdownV2 in the parse_mode field. Use the following syntax in your message:

    *bold \*text*
 _italic \*text_
@@ -5164,33 +5113,31 @@ pre-formatted fixed-width code block written in the Python programming language
 ```
 >Block quotation started
 >Block quotation continued
->The last line of the block quotation**
->The second block quotation started right after the previous\r
->The third block quotation started right after the previous
    +>The last line of the block quotation

    Please note:

    -
    HTML style
    +
    HTML style

    To use this mode, pass HTML in the parse_mode field. The following tags are currently supported:

    <b>bold</b>, <strong>bold</strong>
 <i>italic</i>, <em>italic</em>
 <u>underline</u>, <ins>underline</ins>
 <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
-<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
-<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
-<a href="http://www.example.com/">inline URL</a>
-<a href="tg://user?id=123456789">inline mention of a user</a>
-<tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
+<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
+<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
+<a href="http://www.example.com/">inline URL</a>
+<a href="tg://user?id=123456789">inline mention of a user</a>
+<tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
 <code>inline fixed-width code</code>
 <pre>pre-formatted fixed-width code block</pre>
-<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
+<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
 <blockquote>Block quotation started\nBlock quotation continued\nThe last line of the block quotation</blockquote>

    Please note:

    -
    Markdown style
    +
    Markdown style

    This is a legacy mode, retained for backward compatibility. To use this mode, pass Markdown in the parse_mode field. Use the following syntax in your message:

    *bold text*
 _italic text_
@@ -5219,12 +5166,12 @@ pre-formatted fixed-width code block written in the Python programming language
 
    Please note:
    
 
      
 
    • Entities must not be nested, use parse mode MarkdownV2 instead.
      • 
-
    • There is no way to specify “underline”, “strikethrough”, “spoiler”, “blockquote” and “custom_emoji” entities, use parse mode MarkdownV2 instead.
      • 
-
    • To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
      • 
+
    • There is no way to specify "underline", "strikethrough", "spoiler", "blockquote" and "custom_emoji" entities, use parse mode MarkdownV2 instead.
      • 
+
    • To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
      • 
 
    • Escaping inside entities is not allowed, so entity must be closed first and reopened again: use _snake_\__case_ for italic snake_case and *2*\**2=4* for bold 2*2=4.
      • 
 
    
-
    forwardMessage
    
-
    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.
    
+
    forwardMessage
    
+
    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.
    
 
@@ -5273,8 +5220,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    forwardMessages
    
-
    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.
    
+
    forwardMessages
    
+
    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.
    
 
@@ -5307,7 +5254,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5323,8 +5270,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    message_ids
 Array of Integer
 YesA 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.Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
 
    
 
    
 disable_notification
    
 
 
    
-
    copyMessage
    
-
    Use this method to copy messages of any kind. Service 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.
    
+
    copyMessage
    
+
    Use this method to copy messages of any kind. Service 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.
    
 
@@ -5403,8 +5350,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    copyMessages
    
-
    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, 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.
    
+
    copyMessages
    
+
    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, 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.
    
 
@@ -5437,7 +5384,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5459,7 +5406,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    message_ids
 Array of Integer
 YesA 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.Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
 
    
 
    
 disable_notification
    
 
 
    
-
    sendPhoto
    
+
    sendPhoto
    
 
    Use this method to send photos. On success, the sent Message is returned.
    
 
@@ -5487,7 +5434,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5539,7 +5486,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    photo
 InputFile or String
 YesPhoto 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 »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 »
 
    
 
    
 caption
    
 
 
    
-
    sendAudio
    
+
    sendAudio
    
 
    Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
    
 
    For sending voice messages, use the sendVoice method instead.
    
 
@@ -5610,7 +5557,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5638,7 +5585,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    thumbnail
 InputFile or String
 OptionalThumbnail 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 »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 »
 
    
 
    
 disable_notification
    
     
 
    
-
    sendDocument
    
+
    sendDocument
    
 
    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.
    
 
@@ -5672,7 +5619,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5724,7 +5671,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    thumbnail
 InputFile or String
 OptionalThumbnail 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 »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 »
 
    
 
    
 caption
    
 
 
    
-
    sendVideo
    
+
    sendVideo
    
 
    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.
    
 
@@ -5776,7 +5723,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5834,7 +5781,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    thumbnail
 InputFile or String
 OptionalThumbnail 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 »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 »
 
    
 
    
 caption
    
 
 
    
-
    sendAnimation
    
+
    sendAnimation
    
 
    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.
    
 
@@ -5886,7 +5833,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5938,7 +5885,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    thumbnail
 InputFile or String
 OptionalThumbnail 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 »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 »
 
    
 
    
 caption
    
 
 
    
-
    sendVoice
    
+
    sendVoice
    
 
    Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
    
 
@@ -6018,7 +5965,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    sendVideoNote
    
+
    sendVideoNote
    
 
    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.
    
 
@@ -6064,7 +6011,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6092,7 +6039,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    thumbnail
 InputFile or String
 OptionalThumbnail 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 »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 »
 
    
 
    
 disable_notification
    
 
 
    
-
    sendMediaGroup
    
+
    sendMediaGroup
    
 
    Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
    
 
@@ -6142,7 +6089,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    sendLocation
    
+
    sendLocation
    
 
    Use this method to send point on the map. On success, the sent Message is returned.
    
 
@@ -6228,7 +6175,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    sendVenue
    
+
    sendVenue
    
 
    Use this method to send information about a venue. On success, the sent Message is returned.
    
 
@@ -6286,7 +6233,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6326,7 +6273,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    foursquare_type
 String
 OptionalFoursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
 
    
 
    
 google_place_id
    
 
 
    
-
    sendContact
    
+
    sendContact
    
 
    Use this method to send phone contacts. On success, the sent Message is returned.
    
 
@@ -6354,19 +6301,19 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -6400,7 +6347,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    phone_number
 String
 YesContact's phone numberContact's phone number
 
    
 
    
 first_name
 String
 YesContact's first nameContact's first name
 
    
 
    
 last_name
 String
 OptionalContact's last nameContact's last name
 
    
 
    
 vcard
    
 
 
    
-
    sendPoll
    
+
    sendPoll
    
 
    Use this method to send a native poll. On success, the sent Message is returned.
    
 
@@ -6446,7 +6393,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6482,13 +6429,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -6522,7 +6469,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    type
 String
 OptionalPoll type, “quiz” or “regular”, defaults to “regular”Poll type, "quiz" or "regular", defaults to "regular"
 
    
 
    
 allows_multiple_answersopen_period
 Integer
 OptionalAmount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.
 
    
 
    
 close_date
 Integer
 OptionalPoint 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.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.
 
    
 
    
 is_closed
    
 
 
    
-
    sendDice
    
+
    sendDice
    
 
    Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
    
 
@@ -6550,7 +6497,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6578,10 +6525,10 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    emoji
 String
 OptionalEmoji 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 “🎲”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 "🎲"
 
    
 
    
 disable_notification
    
 
 
    
-
    sendChatAction
    
-
    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.
    
+
    sendChatAction
    
+
    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.
    
 
    
-
    Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
    
+
    Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
    
 
    
 
    We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
    
 
@@ -6604,7 +6551,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6614,8 +6561,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    message_thread_id
 Integer
 OptionalUnique identifier for the target message thread; for supergroups onlyUnique identifier for the target message thread; supergroups only
 
    
 
    
 action
    
     
 
    
-
    setMessageReaction
    
-
    Use this method to change the chosen reactions on a message. Service messages 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. Returns True on success.
    
+
    setMessageReaction
    
+
    Use this method to change the chosen reactions on a message. Service messages 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. Returns True on success.
    
 
@@ -6642,7 +6589,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6652,7 +6599,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    reaction
 Array of ReactionType
 OptionalA 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.New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.
 
    
 
    
 is_big
    
 
 
    
-
    getUserProfilePhotos
    
+
    getUserProfilePhotos
    
 
    Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
    
 
@@ -6684,7 +6631,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getFile
    
+
    getFile
    
 
    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.
    
 
@@ -6704,8 +6651,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    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.
    
-
    banChatMember
    
+
    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.
    
+
    banChatMember
    
 
    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.
    
 
@@ -6743,8 +6690,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    unbanChatMember
    
-
    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.
    
+
    unbanChatMember
    
+
    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.
    
 
@@ -6775,7 +6722,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    restrictChatMember
    
+
    restrictChatMember
    
 
    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.
    
 
@@ -6819,7 +6766,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    promoteChatMember
    
+
    promoteChatMember
    
 
    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.
    
 
@@ -6847,13 +6794,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -6892,50 +6839,50 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
    
 
    is_anonymous
 Boolean
 OptionalPass True if the administrator's presence in the chat is hiddenPass True if the administrator's presence in the chat is hidden
 
    
 
    
 can_manage_chat
 Boolean
 OptionalPass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.Pass True if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege
 
    
 
    
 can_delete_messagesPass True if the administrator can invite new users to the chat
 
    
 
    can_post_storiesBooleanOptionalPass True if the administrator can post stories to the chat
    can_edit_storiesBooleanOptionalPass True if the administrator can edit stories posted by other users
    can_delete_storiesBooleanOptionalPass True if the administrator can delete stories posted by other users
    
 can_post_messages
 Boolean
 OptionalPass True if the administrator can post messages in the channel, or access channel statistics; for channels onlyPass True if the administrator can post messages in the channel, or access channel statistics; channels only
 
    
 
    
 can_edit_messages
 Boolean
 OptionalPass True if the administrator can edit messages of other users and can pin messages; for channels onlyPass True if the administrator can edit messages of other users and can pin messages; channels only
 
    
 
    
 can_pin_messages
 Boolean
 OptionalPass True if the administrator can pin messages; for supergroups onlyPass True if the administrator can pin messages, supergroups only
    can_post_storiesBooleanOptionalPass True if the administrator can post stories in the channel; channels only
    can_edit_storiesBooleanOptionalPass True if the administrator can edit stories posted by other users; channels only
    can_delete_storiesBooleanOptionalPass True if the administrator can delete stories posted by other users; channels only
 
    
 
    
 can_manage_topics
 Boolean
 OptionalPass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups onlyPass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only
 
    
 
 
    
-
    setChatAdministratorCustomTitle
    
+
    setChatAdministratorCustomTitle
    
 
    Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
    
 
@@ -6967,8 +6914,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    banChatSenderChat
    
-
    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.
    
+
    banChatSenderChat
    
+
    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.
    
 
@@ -6993,7 +6940,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    unbanChatSenderChat
    
+
    unbanChatSenderChat
    
 
    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.
    
 
@@ -7019,7 +6966,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setChatPermissions
    
+
    setChatPermissions
    
 
    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.
    
 
@@ -7051,7 +6998,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    exportChatInviteLink
    
+
    exportChatInviteLink
    
 
    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.
    
 
@@ -7072,9 +7019,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    
-
    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 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.
    
+
    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 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.
    
 
    
-
    createChatInviteLink
    
+
    createChatInviteLink
    
 
    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.
    
 
@@ -7114,11 +7061,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    creates_join_request
 Boolean
 OptionalTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specifiedTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
 
    
 
 
    
-
    editChatInviteLink
    
+
    editChatInviteLink
    
 
    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.
    
 
@@ -7164,11 +7111,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    creates_join_request
 Boolean
 OptionalTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specifiedTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified
 
    
 
 
    
-
    revokeChatInviteLink
    
+
    revokeChatInviteLink
    
 
    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.
    
 
@@ -7194,7 +7141,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    approveChatJoinRequest
    
+
    approveChatJoinRequest
    
 
    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.
    
 
@@ -7220,7 +7167,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    declineChatJoinRequest
    
+
    declineChatJoinRequest
    
 
    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.
    
 
@@ -7246,8 +7193,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setChatPhoto
    
-
    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.
    
+
    setChatPhoto
    
+
    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.
    
 
@@ -7272,8 +7219,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    deleteChatPhoto
    
-
    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.
    
+
    deleteChatPhoto
    
+
    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.
    
 
@@ -7292,8 +7239,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    setChatTitle
    
-
    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.
    
+
    setChatTitle
    
+
    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.
    
 
@@ -7318,7 +7265,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    setChatDescription
    
+
    setChatDescription
    
 
    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.
    
 
@@ -7344,8 +7291,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    pinChatMessage
    
-
    Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
+
    pinChatMessage
    
+
    Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
 
@@ -7376,8 +7323,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    unpinChatMessage
    
-
    Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
+
    unpinChatMessage
    
+
    Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
 
@@ -7402,8 +7349,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    unpinAllChatMessages
    
-
    Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
+
    unpinAllChatMessages
    
+
    Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
    
 
@@ -7422,7 +7369,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    leaveChat
    
+
    leaveChat
    
 
    Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
    
 
@@ -7442,7 +7389,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getChat
    
+
    getChat
    
 
    Use this method to get up to date information about the chat. Returns a Chat object on success.
    
 
@@ -7462,8 +7409,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getChatAdministrators
    
-
    Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
    
+
    getChatAdministrators
    
+
    Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
    
 
@@ -7482,7 +7429,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getChatMemberCount
    
+
    getChatMemberCount
    
 
    Use this method to get the number of members in a chat. Returns Int on success.
    
 
@@ -7502,7 +7449,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getChatMember
    
+
    getChatMember
    
 
    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.
    
 
@@ -7528,7 +7475,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setChatStickerSet
    
+
    setChatStickerSet
    
 
    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.
    
 
@@ -7554,7 +7501,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    deleteChatStickerSet
    
+
    deleteChatStickerSet
    
 
    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.
    
 
@@ -7574,9 +7521,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getForumTopicIconStickers
    
+
    getForumTopicIconStickers
    
 
    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.
    
-
    createForumTopic
    
+
    createForumTopic
    
 
    Use this method to create a 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 information about the created topic as a ForumTopic object.
    
 
@@ -7614,7 +7561,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    editForumTopic
    
+
    editForumTopic
    
 
    Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
    
 
@@ -7652,7 +7599,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    closeForumTopic
    
+
    closeForumTopic
    
 
    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.
    
 
@@ -7678,7 +7625,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    reopenForumTopic
    
+
    reopenForumTopic
    
 
    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.
    
 
@@ -7704,7 +7651,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    deleteForumTopic
    
+
    deleteForumTopic
    
 
    Use this method to delete a forum topic along with all its messages in a forum 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.
    
 
@@ -7730,7 +7677,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    unpinAllForumTopicMessages
    
+
    unpinAllForumTopicMessages
    
 
    Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
    
 
@@ -7756,8 +7703,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    editGeneralForumTopic
    
-
    Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
    
+
    editGeneralForumTopic
    
+
    Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
    
 
@@ -7782,8 +7729,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    closeGeneralForumTopic
    
-
    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.
    
+
    closeGeneralForumTopic
    
+
    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.
    
 
@@ -7802,8 +7749,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    reopenGeneralForumTopic
    
-
    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.
    
+
    reopenGeneralForumTopic
    
+
    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.
    
 
@@ -7822,8 +7769,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    hideGeneralForumTopic
    
-
    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.
    
+
    hideGeneralForumTopic
    
+
    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.
    
 
@@ -7842,8 +7789,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    unhideGeneralForumTopic
    
-
    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.
    
+
    unhideGeneralForumTopic
    
+
    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.
    
 
@@ -7862,7 +7809,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    unpinAllGeneralForumTopicMessages
    
+
    unpinAllGeneralForumTopicMessages
    
 
    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.
    
 
@@ -7882,7 +7829,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    answerCallbackQuery
    
+
    answerCallbackQuery
    
 
    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.
    
 
    
 
    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 and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
    
@@ -7919,7 +7866,7 @@ pre-formatted fixed-width code block written in the Python programming language
 url
 String
 Optional
-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.

    Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
+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.

    Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
 
 
 cache_time
@@ -7929,7 +7876,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
 
 
-
    getUserChatBoosts
    
+
    getUserChatBoosts
    
 
    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.
    
 
@@ -7955,8 +7902,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setMyCommands
    
-
    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.
    
+
    setMyCommands
    
+
    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.
    
 
@@ -7971,7 +7918,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7987,8 +7934,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    commands
 Array of BotCommand
 YesA JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.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.
 
    
 
    
 scope
    
 
 
    
-
    deleteMyCommands
    
-
    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.
    
+
    deleteMyCommands
    
+
    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.
    
 
@@ -8013,8 +7960,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getMyCommands
    
-
    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.
    
+
    getMyCommands
    
+
    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.
    
 
@@ -8039,8 +7986,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    setMyName
    
-
    Use this method to change the bot's name. Returns True on success.
    
+
    setMyName
    
+
    Use this method to change the bot's name. Returns True on success.
    
 
@@ -8065,7 +8012,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getMyName
    
+
    getMyName
    
 
    Use this method to get the current bot name for the given user language. Returns BotName on success.
    
 
@@ -8085,8 +8032,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setMyDescription
    
-
    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.
    
+
    setMyDescription
    
+
    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.
    
 
@@ -8111,7 +8058,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getMyDescription
    
+
    getMyDescription
    
 
    Use this method to get the current bot description for the given user language. Returns BotDescription on success.
    
 
@@ -8131,8 +8078,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setMyShortDescription
    
-
    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.
    
+
    setMyShortDescription
    
+
    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.
    
 
@@ -8157,7 +8104,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getMyShortDescription
    
+
    getMyShortDescription
    
 
    Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
    
 
@@ -8177,8 +8124,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setChatMenuButton
    
-
    Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
    
+
    setChatMenuButton
    
+
    Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
    
 
@@ -8193,18 +8140,18 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
    
 
 
    chat_id
 Integer
 OptionalUnique identifier for the target private chat. If not specified, default bot's menu button will be changedUnique identifier for the target private chat. If not specified, default bot's menu button will be changed
 
    
 
    
 menu_button
 MenuButton
 OptionalA JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefaultA JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault
 
    
 
 
    
-
    getChatMenuButton
    
-
    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.
    
+
    getChatMenuButton
    
+
    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.
    
 
@@ -8219,12 +8166,12 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
 
    chat_id
 Integer
 OptionalUnique identifier for the target private chat. If not specified, default bot's menu button will be returnedUnique identifier for the target private chat. If not specified, default bot's menu button will be returned
 
    
 
 
    
-
    setMyDefaultAdministratorRights
    
-
    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.
    
+
    setMyDefaultAdministratorRights
    
+
    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.
    
 
@@ -8249,7 +8196,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getMyDefaultAdministratorRights
    
+
    getMyDefaultAdministratorRights
    
 
    Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
    
 
@@ -8269,12 +8216,12 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Inline mode methods
    
+
    Inline mode methods
    
 
    Methods and objects used in the inline mode are described in the Inline mode section.
    
-
    Updating messages
    
+
    Updating messages
    
 
    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.
    
 
    Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards.
    
-
    editMessageText
    
+
    editMessageText
    
 
    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.
    
 
@@ -8336,7 +8283,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    editMessageCaption
    
+
    editMessageCaption
    
 
    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.
    
 
@@ -8392,8 +8339,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    editMessageMedia
    
-
    Use this method to edit animation, audio, document, photo, or video 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.
    
+
    editMessageMedia
    
+
    Use this method to edit animation, audio, document, photo, or video 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.
    
 
@@ -8436,7 +8383,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    editMessageLiveLocation
    
+
    editMessageLiveLocation
    
 
    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.
    
 
@@ -8504,7 +8451,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    stopMessageLiveLocation
    
+
    stopMessageLiveLocation
    
 
    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.
    
 
@@ -8542,7 +8489,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    editMessageReplyMarkup
    
+
    editMessageReplyMarkup
    
 
    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.
    
 
@@ -8580,7 +8527,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    stopPoll
    
+
    stopPoll
    
 
    Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
    
 
@@ -8612,8 +8559,19 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    deleteMessage
    
-
    Use this method to delete a message, including service messages, with the following limitations:
    - A message can only be deleted if it was sent less than 48 hours ago.
    - Service messages about a supergroup, channel, or forum topic creation can't be deleted.
    - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
    - Bots can delete outgoing messages in private chats, groups, and supergroups.
    - Bots can delete incoming messages in private chats.
    - Bots granted can_post_messages permissions can delete outgoing messages in channels.
    - If the bot is an administrator of a group, it can delete any message there.
    - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
    Returns True on success.
    
+
    deleteMessage
    
+
    Use this method to delete a message, including service messages, with the following limitations:
    
+
      
+
    • A message can only be deleted if it was sent less than 48 hours ago.
      • 
+
    • Service messages about a supergroup, channel, or forum topic creation can't be deleted.
      • 
+
    • A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
      • 
+
    • Bots can delete outgoing messages in private chats, groups, and supergroups.
      • 
+
    • Bots can delete incoming messages in private chats.
      • 
+
    • Bots granted can_post_messages permissions can delete outgoing messages in channels.
      • 
+
    • If the bot is an administrator of a group, it can delete any message there.
      • 
+
    • If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
+Returns True on success.
      • 
+
    
 
@@ -8638,8 +8596,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    deleteMessages
    
-
    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.
    
+
    deleteMessages
    
+
    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.
    
 
@@ -8660,13 +8618,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
 
    message_ids
 Array of Integer
 YesA JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deletedIdentifiers of 1-100 messages to delete. See deleteMessage for limitations on which messages can be deleted
 
    
 
 
    
-
    Stickers
    
+
    Stickers
    
 
    The following methods and objects allow your bot to handle stickers and sticker sets.
    
-
    Sticker
    
+
    Sticker
    
 
    This object represents a sticker.
    
 
@@ -8685,12 +8643,12 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -8754,7 +8712,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 file_unique_id
 StringUnique 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.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.
 
    
 
    
 type
 StringType 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.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.
 
    
 
    
 width
    
 
 
    
-
    StickerSet
    
+
    StickerSet
    
 
    This object represents a sticker set.
    
 
@@ -8778,7 +8736,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8802,7 +8760,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 sticker_type
 StringType of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”Type of stickers in the set, currently one of "regular", "mask", "custom_emoji"
 
    
 
    
 is_animated
    
 
 
    
-
    MaskPosition
    
+
    MaskPosition
    
 
    This object describes the position on faces where a mask should be placed by default.
    
 
@@ -8816,7 +8774,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8835,7 +8793,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 point
 StringThe part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.The part of the face relative to which the mask should be placed. One of "forehead", "eyes", "mouth", or "chin".
 
    
 
    
 x_shift
    
 
 
    
-
    InputSticker
    
+
    InputSticker
    
 
    This object describes a sticker to be added to a sticker set.
    
 
@@ -8849,7 +8807,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8859,16 +8817,16 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
    
 
    
 sticker
 InputFile or StringThe 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, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one 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 »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, upload a new one using multipart/form-data, or pass "attach://<file_attach_name>" to upload a new one 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 »
 
    
 
    
 emoji_list
    
 mask_position
 MaskPositionOptional. Position where the mask should be placed on faces. For “mask” stickers only.Optional. Position where the mask should be placed on faces. For "mask" stickers only.
 
    
 
    
 keywords
 Array of StringOptional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.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.
 
    
 
 
    
-
    sendSticker
    
+
    sendSticker
    
 
    Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
    
 
@@ -8896,7 +8854,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8930,7 +8888,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    sticker
 InputFile or String
 YesSticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.
 
    
 
    
 emoji
    
 
 
    
-
    getStickerSet
    
+
    getStickerSet
    
 
    Use this method to get a sticker set. On success, a StickerSet object is returned.
    
 
@@ -8950,7 +8908,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    getCustomEmojiStickers
    
+
    getCustomEmojiStickers
    
 
    Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
    
 
@@ -8966,11 +8924,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    custom_emoji_ids
 Array of String
 YesA JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
 
    
 
 
    
-
    uploadStickerFile
    
+
    uploadStickerFile
    
 
    Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.
    
 
@@ -8992,17 +8950,17 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
    
 
    sticker
 InputFile
 YesA 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 »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 »
 
    
 
    
 sticker_format
 String
 YesFormat of the sticker, must be one of “static”, “animated”, “video”Format of the sticker, must be one of "static", "animated", "video"
 
    
 
 
    
-
    createNewStickerSet
    
+
    createNewStickerSet
    
 
    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.
    
 
@@ -9024,7 +8982,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9042,13 +9000,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -9058,7 +9016,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    name
 String
 YesShort 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.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.
 
    
 
    
 titlesticker_format
 String
 YesFormat of stickers in the set, must be one of “static”, “animated”, “video”Format of stickers in the set, must be one of "static", "animated", "video"
 
    
 
    
 sticker_type
 String
 OptionalType of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.Type of stickers in the set, pass "regular", "mask", or "custom_emoji". By default, a regular sticker set is created.
 
    
 
    
 needs_repainting
    
 
 
    
-
    addStickerToSet
    
+
    addStickerToSet
    
 
    Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
    
 
@@ -9086,11 +9044,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    sticker
 InputSticker
 YesA 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.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.
 
    
 
 
    
-
    setStickerPositionInSet
    
+
    setStickerPositionInSet
    
 
    Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
    
 
@@ -9116,7 +9074,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    deleteStickerFromSet
    
+
    deleteStickerFromSet
    
 
    Use this method to delete a sticker from a set created by the bot. Returns True on success.
    
 
@@ -9136,7 +9094,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setStickerEmojiList
    
+
    setStickerEmojiList
    
 
    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.
    
 
@@ -9162,7 +9120,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setStickerKeywords
    
+
    setStickerKeywords
    
 
    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.
    
 
@@ -9188,7 +9146,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setStickerMaskPosition
    
+
    setStickerMaskPosition
    
 
    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.
    
 
@@ -9214,7 +9172,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setStickerSetTitle
    
+
    setStickerSetTitle
    
 
    Use this method to set the title of a created sticker set. Returns True on success.
    
 
@@ -9240,7 +9198,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    setStickerSetThumbnail
    
+
    setStickerSetThumbnail
    
 
    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.
    
 
@@ -9268,11 +9226,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    thumbnail
 InputFile or String
 OptionalA .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
 
    
 
 
    
-
    setCustomEmojiStickerSetThumbnail
    
+
    setCustomEmojiStickerSetThumbnail
    
 
    Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
    
 
@@ -9298,7 +9256,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    deleteStickerSet
    
+
    deleteStickerSet
    
 
    Use this method to delete a sticker set that was created by the bot. Returns True on success.
    
 
@@ -9318,10 +9276,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Inline mode
    
-
    The following methods and objects allow your bot to work in inline mode.
    Please see our Introduction to Inline bots for more details.
    
-
    To 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.
    
-
    InlineQuery
    
+
    Inline mode
    
+
    The following methods and objects allow your bot to work in inline mode.
+Please see our Introduction to Inline bots for more details.
    
+
    To 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.
    
+
    InlineQuery
    
 
    This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
    
 
@@ -9355,7 +9314,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9364,8 +9323,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 chat_type
 StringOptional. 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 chatOptional. 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
 
    
 
    
 location
    
 
 
    
-
    answerInlineQuery
    
-
    Use this method to send answers to an inline query. On success, True is returned.
    No more than 50 results per query are allowed.
    
+
    answerInlineQuery
    
+
    Use this method to send answers to an inline query. On success, True is returned.
+No more than 50 results per query are allowed.
    
 
@@ -9404,7 +9364,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9414,7 +9374,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    next_offset
 String
 OptionalPass 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.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.
 
    
 
    
 button
    
 
 
    
-
    InlineQueryResultsButton
    
+
    InlineQueryResultsButton
    
 
    This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
    
 
@@ -9438,11 +9398,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    
 start_parameter
 StringOptional. 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.

    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 switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.    		Optional. 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.

    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 switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.    		
 
    
 
 
    
-
    InlineQueryResult
    
+
    InlineQueryResult
    
 
    This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
    
 
 
    Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.
    
-
    InlineQueryResultArticle
    
+
    InlineQueryResultArticle
    
 
    Represents a link to an article or web page.
    
 
@@ -9511,7 +9471,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9535,7 +9495,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 hide_url
 BooleanOptional. Pass True if you don't want the URL to be shown in the messageOptional. Pass True if you don't want the URL to be shown in the message
 
    
 
    
 description
    
 
 
    
-
    InlineQueryResultPhoto
    
+
    InlineQueryResultPhoto
    
 
    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.
    
 
@@ -9613,7 +9573,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultGif
    
+
    InlineQueryResultGif
    
 
    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.
    
 
@@ -9662,7 +9622,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9696,7 +9656,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 thumbnail_mime_type
 StringOptional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”Optional. MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg"
 
    
 
    
 title
    
 
 
    
-
    InlineQueryResultMpeg4Gif
    
+
    InlineQueryResultMpeg4Gif
    
 
    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.
    
 
@@ -9745,7 +9705,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9779,7 +9739,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 thumbnail_mime_type
 StringOptional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”Optional. MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg"
 
    
 
    
 title
    
 
 
    
-
    InlineQueryResultVideo
    
+
    InlineQueryResultVideo
    
 
    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.
    
 
    
 
    If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
    
@@ -9811,7 +9771,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
 mime_type
 String
-MIME type of the content of the video URL, “text/html” or “video/mp4”
+MIME type of the content of the video URL, "text/html" or "video/mp4"
 
 
 thumbnail_url
@@ -9870,7 +9830,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
 
 
-
    InlineQueryResultAudio
    
+
    InlineQueryResultAudio
    
 
    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.
    
 
@@ -9938,7 +9898,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultVoice
    
+
    InlineQueryResultVoice
    
 
    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.
    
 
@@ -10001,7 +9961,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultDocument
    
+
    InlineQueryResultDocument
    
 
    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.
    
 
@@ -10050,7 +10010,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10084,7 +10044,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 mime_type
 StringMIME type of the content of the file, either “application/pdf” or “application/zip”MIME type of the content of the file, either "application/pdf" or "application/zip"
 
    
 
    
 description
    
 
 
    
-
    InlineQueryResultLocation
    
+
    InlineQueryResultLocation
    
 
    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.
    
 
@@ -10167,7 +10127,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultVenue
    
+
    InlineQueryResultVenue
    
 
    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.
    
 
@@ -10216,7 +10176,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10255,7 +10215,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 foursquare_type
 StringOptional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)Optional. Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
 
    
 
    
 google_place_id
    
 
 
    
-
    InlineQueryResultContact
    
+
    InlineQueryResultContact
    
 
    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.
    
 
@@ -10279,17 +10239,17 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -10323,7 +10283,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 phone_number
 StringContact's phone numberContact's phone number
 
    
 
    
 first_name
 StringContact's first nameContact's first name
 
    
 
    
 last_name
 StringOptional. Contact's last nameOptional. Contact's last name
 
    
 
    
 vcard
    
 
 
    
-
    InlineQueryResultGame
    
+
    InlineQueryResultGame
    
 
    Represents a Game.
    
 
@@ -10356,7 +10316,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedPhoto
    
+
    InlineQueryResultCachedPhoto
    
 
    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.
    
 
@@ -10419,7 +10379,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedGif
    
+
    InlineQueryResultCachedGif
    
 
    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.
    
 
@@ -10477,7 +10437,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedMpeg4Gif
    
+
    InlineQueryResultCachedMpeg4Gif
    
 
    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.
    
 
@@ -10535,7 +10495,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedSticker
    
+
    InlineQueryResultCachedSticker
    
 
    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.
    
 
@@ -10573,7 +10533,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedDocument
    
+
    InlineQueryResultCachedDocument
    
 
    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.
    
 
@@ -10636,7 +10596,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedVideo
    
+
    InlineQueryResultCachedVideo
    
 
    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.
    
 
@@ -10699,7 +10659,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedVoice
    
+
    InlineQueryResultCachedVoice
    
 
    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.
    
 
@@ -10757,7 +10717,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InlineQueryResultCachedAudio
    
+
    InlineQueryResultCachedAudio
    
 
    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.
    
 
@@ -10810,7 +10770,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InputMessageContent
    
+
    InputMessageContent
    
 
    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:
    
 
-
    InputTextMessageContent
    
+
    InputTextMessageContent
    
 
    Represents the content of a text message to be sent as the result of an inline query.
    
 
@@ -10852,7 +10812,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InputLocationMessageContent
    
+
    InputLocationMessageContent
    
 
    Represents the content of a location message to be sent as the result of an inline query.
    
 
@@ -10895,7 +10855,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    InputVenueMessageContent
    
+
    InputVenueMessageContent
    
 
    Represents the content of a venue message to be sent as the result of an inline query.
    
 
@@ -10934,7 +10894,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10948,7 +10908,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 foursquare_type
 StringOptional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)Optional. Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
 
    
 
    
 google_place_id
    
 
 
    
-
    InputContactMessageContent
    
+
    InputContactMessageContent
    
 
    Represents the content of a contact message to be sent as the result of an inline query.
    
 
@@ -10962,17 +10922,17 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -10981,7 +10941,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 phone_number
 StringContact's phone numberContact's phone number
 
    
 
    
 first_name
 StringContact's first nameContact's first name
 
    
 
    
 last_name
 StringOptional. Contact's last nameOptional. Contact's last name
 
    
 
    
 vcard
    
 
 
    
-
    InputInvoiceMessageContent
    
+
    InputInvoiceMessageContent
    
 
    Represents the content of an invoice message to be sent as the result of an inline query.
    
 
@@ -11060,32 +11020,32 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -11094,7 +11054,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 need_name
 BooleanOptional. Pass True if you require the user's full name to complete the orderOptional. Pass True if you require the user's full name to complete the order
 
    
 
    
 need_phone_number
 BooleanOptional. Pass True if you require the user's phone number to complete the orderOptional. Pass True if you require the user's phone number to complete the order
 
    
 
    
 need_email
 BooleanOptional. Pass True if you require the user's email address to complete the orderOptional. Pass True if you require the user's email address to complete the order
 
    
 
    
 need_shipping_address
 BooleanOptional. Pass True if you require the user's shipping address to complete the orderOptional. Pass True if you require the user's shipping address to complete the order
 
    
 
    
 send_phone_number_to_provider
 BooleanOptional. Pass True if the user's phone number should be sent to providerOptional. Pass True if the user's phone number should be sent to provider
 
    
 
    
 send_email_to_provider
 BooleanOptional. Pass True if the user's email address should be sent to providerOptional. Pass True if the user's email address should be sent to provider
 
    
 
    
 is_flexible
    
 
 
    
-
    ChosenInlineResult
    
+
    ChosenInlineResult
    
 
    Represents a result of an inline query that was chosen by the user and sent to their chat partner.
    
 
@@ -11133,7 +11093,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.
    
-
    answerWebAppQuery
    
+
    answerWebAppQuery
    
 
    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.
    
 
@@ -11159,7 +11119,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    SentWebAppMessage
    
+
    SentWebAppMessage
    
 
    Describes an inline message sent by a Web App on behalf of a user.
    
 
@@ -11177,9 +11137,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Payments
    
+
    Payments
    
 
    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.
    
-
    sendInvoice
    
+
    sendInvoice
    
 
    Use this method to send invoices. On success, the sent Message is returned.
    
 
@@ -11291,37 +11251,37 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -11351,11 +11311,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    need_name
 Boolean
 OptionalPass True if you require the user's full name to complete the orderPass True if you require the user's full name to complete the order
 
    
 
    
 need_phone_number
 Boolean
 OptionalPass True if you require the user's phone number to complete the orderPass True if you require the user's phone number to complete the order
 
    
 
    
 need_email
 Boolean
 OptionalPass True if you require the user's email address to complete the orderPass True if you require the user's email address to complete the order
 
    
 
    
 need_shipping_address
 Boolean
 OptionalPass True if you require the user's shipping address to complete the orderPass True if you require the user's shipping address to complete the order
 
    
 
    
 send_phone_number_to_provider
 Boolean
 OptionalPass True if the user's phone number should be sent to providerPass True if the user's phone number should be sent to provider
 
    
 
    
 send_email_to_provider
 Boolean
 OptionalPass True if the user's email address should be sent to providerPass True if the user's email address should be sent to provider
 
    
 
    
 is_flexiblereply_markup
 InlineKeyboardMarkup
 OptionalA 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.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.
 
    
 
 
    
-
    createInvoiceLink
    
+
    createInvoiceLink
    
 
    Use this method to create a link for an invoice. Returns the created invoice link as String on success.
    
 
@@ -11449,37 +11409,37 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -11489,7 +11449,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    need_name
 Boolean
 OptionalPass True if you require the user's full name to complete the orderPass True if you require the user's full name to complete the order
 
    
 
    
 need_phone_number
 Boolean
 OptionalPass True if you require the user's phone number to complete the orderPass True if you require the user's phone number to complete the order
 
    
 
    
 need_email
 Boolean
 OptionalPass True if you require the user's email address to complete the orderPass True if you require the user's email address to complete the order
 
    
 
    
 need_shipping_address
 Boolean
 OptionalPass True if you require the user's shipping address to complete the orderPass True if you require the user's shipping address to complete the order
 
    
 
    
 send_phone_number_to_provider
 Boolean
 OptionalPass True if the user's phone number should be sent to the providerPass True if the user's phone number should be sent to the provider
 
    
 
    
 send_email_to_provider
 Boolean
 OptionalPass True if the user's email address should be sent to the providerPass True if the user's email address should be sent to the provider
 
    
 
    
 is_flexible
    
 
 
    
-
    answerShippingQuery
    
+
    answerShippingQuery
    
 
    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.
    
 
@@ -11523,11 +11483,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    error_message
 String
 OptionalRequired 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.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.
 
    
 
 
    
-
    answerPreCheckoutQuery
    
+
    answerPreCheckoutQuery
    
 
    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.
    
 
@@ -11555,11 +11515,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    error_message
 String
 OptionalRequired 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.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.
 
    
 
 
    
-
    LabeledPrice
    
+
    LabeledPrice
    
 
    This object represents a portion of the price for goods or services.
    
 
@@ -11582,7 +11542,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Invoice
    
+
    Invoice
    
 
    This object contains basic information about an invoice.
    
 
@@ -11620,7 +11580,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    ShippingAddress
    
+
    ShippingAddress
    
 
    This object represents a shipping address.
    
 
@@ -11663,7 +11623,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    OrderInfo
    
+
    OrderInfo
    
 
    This object represents information about an order.
    
 
@@ -11682,7 +11642,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -11696,7 +11656,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 phone_number
 StringOptional. User's phone numberOptional. User's phone number
 
    
 
    
 email
    
 
 
    
-
    ShippingOption
    
+
    ShippingOption
    
 
    This object represents one shipping option.
    
 
@@ -11724,7 +11684,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    SuccessfulPayment
    
+
    SuccessfulPayment
    
 
    This object contains basic information about a successful payment.
    
 
@@ -11772,7 +11732,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    ShippingQuery
    
+
    ShippingQuery
    
 
    This object contains information about an incoming shipping query.
    
 
@@ -11805,7 +11765,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    PreCheckoutQuery
    
+
    PreCheckoutQuery
    
 
    This object contains information about an incoming pre-checkout query.
    
 
@@ -11853,9 +11813,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Telegram Passport
    
+
    Telegram Passport
    
 
    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.
    
-
    PassportData
    
+
    PassportData
    
 
    Describes Telegram Passport data shared with the bot by the user.
    
 
@@ -11878,8 +11838,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    PassportFile
    
-
    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.
    
+
    PassportFile
    
+
    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.
    
 
@@ -11897,7 +11857,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -11911,7 +11871,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 file_unique_id
 StringUnique 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.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.
 
    
 
    
 file_size
    
 
 
    
-
    EncryptedPassportElement
    
+
    EncryptedPassportElement
    
 
    Describes documents or other Telegram Passport elements shared with the bot by the user.
    
 
@@ -11925,47 +11885,47 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -11974,7 +11934,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringElement 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”.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".
 
    
 
    
 data
 StringOptional. 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.Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials.
 
    
 
    
 phone_number
 StringOptional. User's verified phone number; available only for “phone_number” typeOptional. User's verified phone number, available only for "phone_number" type
 
    
 
    
 email
 StringOptional. User's verified email address; available only for “email” typeOptional. User's verified email address, available only for "email" type
 
    
 
    
 files
 Array of PassportFileOptional. 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.Optional. Array of encrypted files with documents provided by the user, available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
 
    
 
    
 front_side
 PassportFileOptional. 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.Optional. Encrypted file with the front side of the document, provided by the user. Available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.
 
    
 
    
 reverse_side
 PassportFileOptional. 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.Optional. Encrypted file with the reverse side of the document, provided by the user. Available for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials.
 
    
 
    
 selfie
 PassportFileOptional. 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.Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials.
 
    
 
    
 translation
 Array of PassportFileOptional. 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.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 EncryptedCredentials.
 
    
 
    
 hash
    
 
 
    
-
    EncryptedCredentials
    
+
    EncryptedCredentials
    
 
    Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
    
 
@@ -11988,7 +11948,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -11998,13 +11958,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    
 data
 StringBase64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authenticationBase64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication
 
    
 
    
 hash
    
 secret
 StringBase64-encoded secret, encrypted with the bot's public RSA key, required for data decryptionBase64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
 
    
 
 
    
-
    setPassportDataErrors
    
+
    setPassportDataErrors
    
 
    Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
    
-
    Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
    
+
    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.
    
 
@@ -12029,7 +11989,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    PassportElementError
    
+
    PassportElementError
    
 
    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:
    
 
-
    PassportElementErrorDataField
    
-
    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.
    
+
    PassportElementErrorDataField
    
+
    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.
    
 
@@ -12061,7 +12021,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12080,7 +12040,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 type
 StringThe section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”The section of the user's Telegram Passport which has the error, one of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address"
 
    
 
    
 field_name
    
 
 
    
-
    PassportElementErrorFrontSide
    
+
    PassportElementErrorFrontSide
    
 
    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.
    
 
@@ -12099,7 +12059,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12113,7 +12073,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringThe section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport"
 
    
 
    
 file_hash
    
 
 
    
-
    PassportElementErrorReverseSide
    
+
    PassportElementErrorReverseSide
    
 
    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.
    
 
@@ -12132,7 +12092,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12146,7 +12106,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringThe section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”The section of the user's Telegram Passport which has the issue, one of "driver_license", "identity_card"
 
    
 
    
 file_hash
    
 
 
    
-
    PassportElementErrorSelfie
    
+
    PassportElementErrorSelfie
    
 
    Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
    
 
@@ -12165,7 +12125,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12179,7 +12139,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringThe section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”The section of the user's Telegram Passport which has the issue, one of "passport", "driver_license", "identity_card", "internal_passport"
 
    
 
    
 file_hash
    
 
 
    
-
    PassportElementErrorFile
    
+
    PassportElementErrorFile
    
 
    Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
    
 
@@ -12198,7 +12158,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12212,7 +12172,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringThe section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration"
 
    
 
    
 file_hash
    
 
 
    
-
    PassportElementErrorFiles
    
+
    PassportElementErrorFiles
    
 
    Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
    
 
@@ -12231,7 +12191,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12245,7 +12205,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringThe section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”The section of the user's Telegram Passport which has the issue, one of "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration"
 
    
 
    
 file_hashes
    
 
 
    
-
    PassportElementErrorTranslationFile
    
+
    PassportElementErrorTranslationFile
    
 
    Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
    
 
@@ -12264,7 +12224,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12278,7 +12238,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringType 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”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"
 
    
 
    
 file_hash
    
 
 
    
-
    PassportElementErrorTranslationFiles
    
+
    PassportElementErrorTranslationFiles
    
 
    Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
    
 
@@ -12297,7 +12257,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12311,7 +12271,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringType 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”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"
 
    
 
    
 file_hashes
    
 
 
    
-
    PassportElementErrorUnspecified
    
+
    PassportElementErrorUnspecified
    
 
    Represents an issue in an unspecified place. The error is considered resolved when new data is added.
    
 
@@ -12330,7 +12290,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -12344,20 +12304,20 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
    
 type
 StringType of element of the user's Telegram Passport which has the issueType of element of the user's Telegram Passport which has the issue
 
    
 
    
 element_hash
    
 
 
    
-
    Games
    
+
    Games
    
 
    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.
    
 
      
 
    • Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.
      • 
-
    • 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.
      • 
-
    • 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.
      • 
-
    • 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.
      • 
+
    • 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.
      • 
+
    • 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.
      • 
+
    • 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.
      • 
 
    • To make your game more attractive, you can upload a GIF animation that demostrates the game to the users via BotFather (see Lumberjack for example).
      • 
 
    • 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 edit_message parameter to automatically update the message with the current scoreboard.
      • 
 
    • Use getGameHighScores to get data for in-game high score tables.
      • 
 
    • You can also add an extra sharing button for users to share their best score to different chats.
      • 
 
    • For examples of what can be done using this new stuff, check the @gamebot and @gamee bots.
      • 
 
    
-
    sendGame
    
+
    sendGame
    
 
    Use this method to send a game. On success, the sent Message is returned.
    
 
@@ -12409,11 +12369,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
    
 
    reply_markup
 InlineKeyboardMarkup
 OptionalA 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.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.
 
    
 
 
    
-
    Game
    
+
    Game
    
 
    This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
    
 
@@ -12456,10 +12416,10 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    CallbackGame
    
+
    CallbackGame
    
 
    A placeholder, currently holds no information. Use BotFather to set up your game.
    
-
    setGameScore
    
-
    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.
    
+
    setGameScore
    
+
    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.
    
 
@@ -12514,7 +12474,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    getGameHighScores
    
+
    getGameHighScores
    
 
    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.
    
 
    
 
    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.
    
@@ -12555,7 +12515,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
 
 
-
    GameHighScore
    
+
    GameHighScore
    
 
    This object represents one row of the high scores table for a game.
    
 
@@ -12584,8 +12544,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    
-
    And that's about all we've got for now.
    If you've got any questions, please check out our Bot FAQ »
    
-
    +

    And that's about all we've got for now. +If you've got any questions, please check out our Bot FAQ »

    diff --git a/data/web/corefork.telegram.org/bots/webapps.html b/data/web/corefork.telegram.org/bots/webapps.html index ed27e77184..81379407c0 100644 --- a/data/web/corefork.telegram.org/bots/webapps.html +++ b/data/web/corefork.telegram.org/bots/webapps.html @@ -49,22 +49,21 @@
    +
    -

    To see a Mini App in action, try our sample @DurgerKingBot.

    -

    Recent changes

    -

    December 29, 2023

    +

    Recent changes

    +

    December 29, 2023

    Bot API 7.0

    -

    September 22, 2023

    +

    September 22, 2023

    Bot API 6.9

    -

    April 21, 2023

    +

    April 21, 2023

    Bot API 6.7

    -

    December 30, 2022

    +

    December 30, 2022

    Bot API 6.4

    -

    August 12, 2022

    +

    August 12, 2022

    Bot API 6.2

    -

    June 20, 2022

    +

    June 20, 2022

    Bot API 6.1

    -

    Designing Mini Apps

    -

    Color Schemes

    -

    Mini Apps always receive data about the user's current color theme in real time, so you can adjust the appearance of your interfaces to match it. For example, when users switch between Day and Night modes or use various custom themes.

    +

    Designing Mini Apps

    +

    Color Schemes

    +

    Mini Apps always receive data about the user's current color theme in real time, so you can adjust the appearance of your interfaces to match it. For example, when users switch between Day and Night modes or use various custom themes.

    +
    -

    Jump to technical information

    -

    Design Guidelines

    +

    Design Guidelines

    Telegram apps are known for being snappy, smooth and following a consistent cross-platform design. Your Mini App should ideally reflect these principles.

    -

    Implementing Mini Apps

    -

    Telegram currently supports six different ways of launching Mini Apps: from a keyboard button, from an inline button, from the bot menu button, via inline mode, from a direct link – and even from the attachment menu.

    +

    Implementing Mini Apps

    +

    Telegram currently supports six different ways of launching Mini Apps: from a keyboard button, from an inline button, from the bot menu button, via inline mode, from a direct link – and even from the attachment menu.

    - Types of buttons + Types of buttons
    - -

    Keyboard Button Mini Apps

    +

    Keyboard Button Mini Apps

    TL;DR: Mini Apps launched from a web_app type keyboard button can send data back to the bot in a service message using Telegram.WebApp.sendData. This makes it possible for the bot to produce a response without communicating with any external servers.

    @@ -141,84 +138,84 @@

    To transmit data from the user back to the bot, the Mini App can call the Telegram.WebApp.sendData method. Data will be transmitted to the bot as a String in a service message. The bot can continue communicating with the user after receiving it.

    Good for:

    -

    Inline Button Mini Apps

    +

    Inline Button Mini Apps

    TL;DR: For more interactive Mini Apps like @DurgerKingBot, use a web_app type Inline KeyboardButton, which gets basic user information and can be used to send a message on behalf of the user to the chat with the bot.

    If receiving text data alone is insufficient or you need a more advanced and personalized interface, you can open a Mini App using a web_app type Inline KeyboardButton.

    -

    From the button, a Mini App will open with the URL specified in the button. In addition to the user's theme settings, it will receive basic user information (ID, name, username, language_code) and a unique identifier for the session, query_id, which allows messages on behalf of the user to be sent back to the bot.

    +

    From the button, a Mini App will open with the URL specified in the button. In addition to the user's theme settings, it will receive basic user information (ID, name, username, language_code) and a unique identifier for the session, query_id, which allows messages on behalf of the user to be sent back to the bot.

    The bot can call the Bot API method answerWebAppQuery to send an inline message from the user back to the bot and close the Mini App. After receiving the message, the bot can continue communicating with the user.

    Good for:

    -

    Launching Mini Apps from the Menu Button

    +

    Launching Mini Apps from the Menu Button

    TL;DR: Mini Apps can be launched from a customized menu button. This simply offers a quicker way to access the app and is otherwise identical to launching a mini app from an inline button.

    By default, chats with bots always show a convenient menu button that provides quick access to all listed commands. With Bot API 6.0, this button can be used to launch a Mini App instead.

    - +
    -

    To configure the menu button, you must specify the text it should show and the Mini App URL. There are two ways to set these parameters:

    Apart from this, Mini Apps opened via the menu button work in the exact same way as when using inline buttons.

    @DurgerKingBot allows launching its Mini App both from an inline button and from the menu button.

    -

    Inline Mode Mini Apps

    +

    Inline Mode Mini Apps

    TL;DR: Mini Apps launched via web_app type InlineQueryResultsButton can be used anywhere in inline mode. Users can create content in a web interface and then seamlessly send it to the current chat via inline mode.

    -

    You can use the button parameter in the answerInlineQuery method to display a special 'Switch to Mini App' button either above or in place of the inline results. This button will open a Mini App from the specified URL. Once done, you can call the Telegram.WebApp.switchInlineQuery method to send the user back to inline mode.

    -

    Inline Mini Apps have no access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected to inline mode and actively pick a result.

    +

    You can use the button parameter in the answerInlineQuery method to display a special 'Switch to Mini App' button either above or in place of the inline results. This button will open a Mini App from the specified URL. Once done, you can call the Telegram.WebApp.switchInlineQuery method to send the user back to inline mode.

    +

    Inline Mini Apps have no access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected to inline mode and actively pick a result.

    Good for:

    -

    Direct Link Mini Apps

    +

    Direct Link Mini Apps

    TL;DR: Mini App Bots can be launched from a direct link in any chat. They support a startapp parameter and are aware of the current chat context.

    You can use direct links to open a Mini App directly in the current chat. If a non-empty startapp parameter is included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    In this mode, Mini Apps can use the chat_type and chat_instance parameters to keep track of the current chat context. This introduces support for concurrent and shared usage by multiple chat members – to create live whiteboards, group orders, multiplayer games and similar apps.

    -

    Mini Apps opened from a direct link have no access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected to inline mode and actively pick a result.

    +

    Mini Apps opened from a direct link have no access to the chat – they can't read messages or send new ones on behalf of the user. To send messages, the user must be redirected to inline mode and actively pick a result.

    Examples

    -

    https://t.me/botusername/appname
    https://t.me/botusername/appname?startapp=command

    +

    https://t.me/botusername/appname +https://t.me/botusername/appname?startapp=command

    Good for:

    -

    Launching Mini Apps from the Attachment Menu

    +

    Launching Mini Apps from the Attachment Menu

    -

    TL;DR: Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched from any chat. To try this mode, open this attachment menu link for @DurgerKingBot, then use the Attach menu in any type of chat.

    +

    TL;DR: Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched from any chat. To try this mode, open this attachment menu link for @DurgerKingBot, then use the Attach menu in any type of chat.

    -

    Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched from any type of chat. You can configure in which types of chats your mini app can be started from the attachment menu (private, groups, supergroups or channels).

    -

    Attachment menu integration is currently only available for major advertisers on the Telegram Ad Platform. However, all bots can use it in the test server environment.

    -

    To enable this feature for your bot, open @BotFather from an account on the test server and send the /setattach command – or go to Bot Settings > Configure Attachment Menu. Then specify the URL that will be opened to launch the bot's Mini App via its icon in the attachment menu.

    -

    You can add a 'Settings' item to the context menu of your Mini App using @BotFather. When users select this option from the menu, your bot will receive a settingsButtonClicked event.

    -

    In addition to the user's theme settings, the bot will receive basic user information (ID, name, username, language_code, photo), as well as public info about the chat partner (ID, name, username, photo) or the chat info (ID, type, title, username, photo) and a unique identifier for the web view session query_id, which allows messages of any type to be sent to the chat on behalf of the user that opened the bot.

    +

    Mini App Bots can request to be added directly to a user's attachment menu, allowing them to be quickly launched from any type of chat. You can configure in which types of chats your mini app can be started from the attachment menu (private, groups, supergroups or channels).

    +

    Attachment menu integration is currently only available for major advertisers on the Telegram Ad Platform. However, all bots can use it in the test server environment.

    +

    To enable this feature for your bot, open @BotFather from an account on the test server and send the /setattach command – or go to Bot Settings > Configure Attachment Menu. Then specify the URL that will be opened to launch the bot's Mini App via its icon in the attachment menu.

    +

    You can add a 'Settings' item to the context menu of your Mini App using @BotFather. When users select this option from the menu, your bot will receive a settingsButtonClicked event.

    +

    In addition to the user's theme settings, the bot will receive basic user information (ID, name, username, language_code, photo), as well as public info about the chat partner (ID, name, username, photo) or the chat info (ID, type, title, username, photo) and a unique identifier for the web view session query_id, which allows messages of any type to be sent to the chat on behalf of the user that opened the bot.

    The bot can call the Bot API method answerWebAppQuery, which sends an inline message from the user via the bot to the chat where it was launched and closes the Mini App.

    You can read more about adding bots to the attachment menu here.

    -

    Initializing Mini Apps

    +

    Initializing Mini Apps

    To connect your Mini App to the Telegram client, place the script telegram-web-app.js in the <head> tag before any other scripts, using this code:

    -
    <script src="https://telegram.org/js/telegram-web-app.js"></script>
    +
    <script src="https://telegram.org/js/telegram-web-app.js"></script>

    Once the script is connected, a window.Telegram.WebApp object will become available with the following fields:

    @@ -232,27 +229,27 @@ - + - + - + - + - + @@ -267,12 +264,12 @@ - + - + @@ -300,7 +297,7 @@ - + @@ -317,27 +314,27 @@ - + - + - + - + - + @@ -357,67 +354,67 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -431,8 +428,8 @@
    initData StringA string with raw data transferred to the Mini App, convenient for validating data.
    WARNING: Validate data from this field before using it on the bot's server.    		A string with raw data transferred to the Mini App, convenient for validating data.
    WARNING: Validate data from this field before using it on the bot's server.
    initDataUnsafe WebAppInitDataAn object with input data transferred to the Mini App.
    WARNING: Data from this field should not be trusted. You should only use data from initData on the bot's server and only after it has been validated.    		An object with input data transferred to the Mini App.
    WARNING: Data from this field should not be trusted. You should only use data from initData on the bot's server and only after it has been validated.
    version StringThe version of the Bot API available in the user's Telegram app.The version of the Bot API available in the user's Telegram app.
    platform StringThe name of the platform of the user's Telegram app.The name of the platform of the user's Telegram app.
    colorScheme StringThe color scheme currently used in the Telegram app. Either “light” or “dark”.
    Also available as the CSS variable var(--tg-color-scheme).    		The color scheme currently used in the Telegram app. Either “light” or “dark”.
    Also available as the CSS variable var(--tg-color-scheme).
    themeParams
    viewportHeight FloatThe current height of the visible area of the Mini App. Also available in CSS as the variable var(--tg-viewport-height).

    The application can display just the top part of the Mini App, with its lower part remaining outside the screen area. From this position, the user can “pull” the Mini App to its maximum height, while the bot can do the same by calling the expand() method. As the position of the Mini App changes, the current height value of the visible area will be updated in real time.

    Please note that the refresh rate of this value is not sufficient to smoothly follow the lower border of the window. It should not be used to pin interface elements to the bottom of the visible area. It's more appropriate to use the value of the viewportStableHeight field for this purpose.    		The current height of the visible area of the Mini App. Also available in CSS as the variable var(--tg-viewport-height).

    The application can display just the top part of the Mini App, with its lower part remaining outside the screen area. From this position, the user can "pull" the Mini App to its maximum height, while the bot can do the same by calling the expand() method. As the position of the Mini App changes, the current height value of the visible area will be updated in real time.

    Please note that the refresh rate of this value is not sufficient to smoothly follow the lower border of the window. It should not be used to pin interface elements to the bottom of the visible area. It's more appropriate to use the value of the viewportStableHeight field for this purpose.
    viewportStableHeight FloatThe height of the visible area of the Mini App in its last stable state. Also available in CSS as a variable var(--tg-viewport-stable-height).

    The application can display just the top part of the Mini App, with its lower part remaining outside the screen area. From this position, the user can “pull” the Mini App to its maximum height, while the bot can do the same by calling the expand() method. Unlike the value of viewportHeight, the value of viewportStableHeight does not change as the position of the Mini App changes with user gestures or during animations. The value of viewportStableHeight will be updated after all gestures and animations are completed and the Mini App reaches its final size.

    Note the event viewportChanged with the passed parameter isStateStable=true, which will allow you to track when the stable state of the height of the visible area changes.    		The height of the visible area of the Mini App in its last stable state. Also available in CSS as a variable var(--tg-viewport-stable-height).

    The application can display just the top part of the Mini App, with its lower part remaining outside the screen area. From this position, the user can "pull" the Mini App to its maximum height, while the bot can do the same by calling the expand() method. Unlike the value of viewportHeight, the value of viewportStableHeight does not change as the position of the Mini App changes with user gestures or during animations. The value of viewportStableHeight will be updated after all gestures and animations are completed and the Mini App reaches its final size.

    Note the event viewportChanged with the passed parameter isStateStable=true, which will allow you to track when the stable state of the height of the visible area changes.
    headerColorAn object for controlling the main button, which is displayed at the bottom of the Mini App in the Telegram interface.
    SettingsButton NEWSettingsButton ^==NEW==^ SettingsButton An object for controlling the Settings item in the context menu of the Mini App in the Telegram interface.
    isVersionAtLeast(version) FunctionReturns true if the user's app supports a version of the Bot API that is equal to or higher than the version passed as the parameter.Returns true if the user's app supports a version of the Bot API that is equal to or higher than the version passed as the parameter.
    setHeaderColor(color) FunctionBot API 6.1+ A method that sets the app header color in the #RRGGBB format. You can also use keywords bg_color and secondary_bg_color.

    Up to Bot API 6.9 You can only pass Telegram.WebApp.themeParams.bg_color or Telegram.WebApp.themeParams.secondary_bg_color as a color or bg_color, secondary_bg_color keywords.    		==Bot API 6.1+== A method that sets the app header color in the #RRGGBB format. You can also use keywords bg_color and secondary_bg_color.

    Up to ==Bot API 6.9== You can only pass Telegram.WebApp.themeParams.bg_color or Telegram.WebApp.themeParams.secondary_bg_color as a color or bg_color, secondary_bg_color keywords.
    setBackgroundColor(color) FunctionBot API 6.1+ A method that sets the app background color in the #RRGGBB format. You can also use keywords bg_color and secondary_bg_color.==Bot API 6.1+== A method that sets the app background color in the #RRGGBB format. You can also use keywords bg_color and secondary_bg_color.
    enableClosingConfirmation() FunctionBot API 6.2+ A method that enables a confirmation dialog while the user is trying to close the Mini App.==Bot API 6.2+== A method that enables a confirmation dialog while the user is trying to close the Mini App.
    disableClosingConfirmation() FunctionBot API 6.2+ A method that disables the confirmation dialog while the user is trying to close the Mini App.==Bot API 6.2+== A method that disables the confirmation dialog while the user is trying to close the Mini App.
    onEvent(eventType, eventHandler)
    switchInlineQuery(query[, choose_chat_types]) FunctionBot API 6.7+ A method that inserts the bot's username and the specified inline query in the current chat's input field. Query may be empty, in which case only the bot's username will be inserted. If an optional choose_chat_types parameter was passed, the client prompts the user to choose a specific chat, then opens that chat and inserts the bot's username and the specified inline query in the input field. You can specify which types of chats the user will be able to choose from. It can be one or more of the following types: users, bots, groups, channels.==Bot API 6.7+== A method that inserts the bot's username and the specified inline query in the current chat's input field. Query may be empty, in which case only the bot's username will be inserted. If an optional choose_chat_types parameter was passed, the client prompts the user to choose a specific chat, then opens that chat and inserts the bot's username and the specified inline query in the input field. You can specify which types of chats the user will be able to choose from. It can be one or more of the following types: users, bots, groups, channels.
    openLink(url[, options]) FunctionA method that opens a link in an external browser. The Mini App will not be closed.
    Bot API 6.4+ If the optional options parameter is passed with the field try_instant_view=true, the link will be opened in Instant View mode if possible.

    Note that this method can be called only in response to user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button)    		A method that opens a link in an external browser. The Mini App will not be closed.
    ==Bot API 6.4+== If the optional options parameter is passed with the field try_instant_view=true, the link will be opened in Instant View mode if possible.

    Note that this method can be called only in response to user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button)
    openTelegramLink(url) FunctionA method that opens a telegram link inside the Telegram app. The Mini App will not be closed after this method is called.

    Up to Bot API 7.0 The Mini App will be closed after this method is called.    		A method that opens a telegram link inside the Telegram app. The Mini App will not be closed after this method is called.

    Up to ==Bot API 7.0== The Mini App will be closed after this method is called.
    openInvoice(url[, callback]) FunctionBot API 6.1+ A method that opens an invoice using the link url. The Mini App will receive the event invoiceClosed when the invoice is closed. If an optional callback parameter was passed, the callback function will be called and the invoice status will be passed as the first argument.==Bot API 6.1+== A method that opens an invoice using the link url. The Mini App will receive the event invoiceClosed when the invoice is closed. If an optional callback parameter was passed, the callback function will be called and the invoice status will be passed as the first argument.
    showPopup(params[, callback]) FunctionBot API 6.2+ A method that shows a native popup described by the params argument of the type PopupParams. The Mini App will receive the event popupClosed when the popup is closed. If an optional callback parameter was passed, the callback function will be called and the field id of the pressed button will be passed as the first argument.==Bot API 6.2+== A method that shows a native popup described by the params argument of the type PopupParams. The Mini App will receive the event popupClosed when the popup is closed. If an optional callback parameter was passed, the callback function will be called and the field id of the pressed button will be passed as the first argument.
    showAlert(message[, callback]) FunctionBot API 6.2+ A method that shows message in a simple alert with a 'Close' button. If an optional callback parameter was passed, the callback function will be called when the popup is closed.==Bot API 6.2+== A method that shows message in a simple alert with a 'Close' button. If an optional callback parameter was passed, the callback function will be called when the popup is closed.
    showConfirm(message[, callback]) FunctionBot API 6.2+ A method that shows message in a simple confirmation window with 'OK' and 'Cancel' buttons. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user pressed the 'OK' button.==Bot API 6.2+== A method that shows message in a simple confirmation window with 'OK' and 'Cancel' buttons. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user pressed the 'OK' button.
    showScanQrPopup(params[, callback]) FunctionBot API 6.4+ A method that shows a native popup for scanning a QR code described by the params argument of the type ScanQrPopupParams. The Mini App will receive the event qrTextReceived every time the scanner catches a code with text data. If an optional callback parameter was passed, the callback function will be called and the text from the QR code will be passed as the first argument. Returning true inside this callback function causes the popup to be closed.==Bot API 6.4+== A method that shows a native popup for scanning a QR code described by the params argument of the type ScanQrPopupParams. The Mini App will receive the event qrTextReceived every time the scanner catches a code with text data. If an optional callback parameter was passed, the callback function will be called and the text from the QR code will be passed as the first argument. Returning true inside this callback function causes the popup to be closed.
    closeScanQrPopup() FunctionBot API 6.4+ A method that closes the native popup for scanning a QR code opened with the showScanQrPopup method. Run it if you received valid data in the event qrTextReceived.==Bot API 6.4+== A method that closes the native popup for scanning a QR code opened with the showScanQrPopup method. Run it if you received valid data in the event qrTextReceived.
    readTextFromClipboard([callback]) FunctionBot API 6.4+ A method that requests text from the clipboard. The Mini App will receive the event clipboardTextReceived. If an optional callback parameter was passed, the callback function will be called and the text from the clipboard will be passed as the first argument.

    Note: this method can be called only for Mini Apps launched from the attachment menu and only in response to a user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button).    		==Bot API 6.4+== A method that requests text from the clipboard. The Mini App will receive the event clipboardTextReceived. If an optional callback parameter was passed, the callback function will be called and the text from the clipboard will be passed as the first argument.

    Note: this method can be called only for Mini Apps launched from the attachment menu and only in response to a user interaction with the Mini App interface (e.g. a click inside the Mini App or on the main button).
    requestWriteAccess([callback]) FunctionBot API 6.9+ A method that shows a native popup requesting permission for the bot to send messages to the user. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user granted this access.==Bot API 6.9+== A method that shows a native popup requesting permission for the bot to send messages to the user. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user granted this access.
    requestContact([callback]) FunctionBot API 6.9+ A method that shows a native popup prompting the user for their phone number. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user shared its phone number.==Bot API 6.9+== A method that shows a native popup prompting the user for their phone number. If an optional callback parameter was passed, the callback function will be called when the popup is closed and the first argument will be a boolean indicating whether the user shared its phone number.
    ready() FunctionA method that informs the Telegram app that the Mini App is ready to be displayed.
    It is recommended to call this method as early as possible, as soon as all essential interface elements are loaded. Once this method is called, the loading placeholder is hidden and the Mini App is shown.
    If the method is not called, the placeholder will be hidden only when the page is fully loaded.    		A method that informs the Telegram app that the Mini App is ready to be displayed.
    It is recommended to call this method as early as possible, as soon as all essential interface elements are loaded. Once this method is called, the loading placeholder is hidden and the Mini App is shown.
    If the method is not called, the placeholder will be hidden only when the page is fully loaded.
    expand()
    -

    ThemeParams

    -

    Mini Apps can adjust the appearance of the interface to match the Telegram user's app in real time. This object contains the user's current theme settings:

    +

    ThemeParams

    +

    Mini Apps can adjust the appearance of the interface to match the Telegram user's app in real time. This object contains the user's current theme settings:

    @@ -445,75 +442,74 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
    bg_color StringOptional. Background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-bg-color).    		Optional. Background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-bg-color).
    text_color StringOptional. Main text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-text-color).    		Optional. Main text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-text-color).
    hint_color StringOptional. Hint text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-hint-color).    		Optional. Hint text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-hint-color).
    link_color StringOptional. Link color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-link-color).    		Optional. Link color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-link-color).
    button_color StringOptional. Button color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-button-color).    		Optional. Button color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-button-color).
    button_text_color StringOptional. Button text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-button-text-color).    		Optional. Button text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-button-text-color).
    secondary_bg_color StringOptional. Bot API 6.1+ Secondary background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-secondary-bg-color).    		Optional. ==Bot API 6.1+== Secondary background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-secondary-bg-color).
    header_bg_color NEWheader_bg_color ^==NEW==^ StringOptional. Bot API 7.0+ Header background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-header-bg-color).    		Optional. ==Bot API 7.0+== Header background color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-header-bg-color).
    accent_text_color NEWaccent_text_color ^==NEW==^ StringOptional. Bot API 7.0+ Accent text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-accent-text-color).    		Optional. ==Bot API 7.0+== Accent text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-accent-text-color).
    section_bg_color NEWsection_bg_color ^==NEW==^ StringOptional. Bot API 7.0+ Background color for the section in the #RRGGBB format. It is recommended to use this in conjunction with secondary_bg_color.
    Also available as the CSS variable var(--tg-theme-section-bg-color).    		Optional. ==Bot API 7.0+== Background color for the section in the #RRGGBB format. It is recommended to use this in conjunction with secondary_bg_color.
    Also available as the CSS variable var(--tg-theme-section-bg-color).
    section_header_text_color NEWsection_header_text_color ^==NEW==^ StringOptional. Bot API 7.0+ Header text color for the section in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-section-header-text-color).    		Optional. ==Bot API 7.0+== Header text color for the section in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-section-header-text-color).
    subtitle_text_color NEWsubtitle_text_color ^==NEW==^ StringOptional. Bot API 7.0+ Subtitle text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-subtitle-text-color).    		Optional. ==Bot API 7.0+== Subtitle text color in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-subtitle-text-color).
    destructive_text_color NEWdestructive_text_color ^==NEW==^ StringOptional. Bot API 7.0+ Text color for destructive actions in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-destructive-text-color).    		Optional. ==Bot API 7.0+== Text color for destructive actions in the #RRGGBB format.
    Also available as the CSS variable var(--tg-theme-destructive-text-color).
    - +
    - -

    PopupParams

    +

    PopupParams

    This object describes the native popup.

    @@ -537,11 +533,11 @@ - +
    buttons Array of PopupButtonOptional. List of buttons to be displayed in the popup, 1-3 buttons. Set to [{“type”:“close”}] by default.Optional. List of buttons to be displayed in the popup, 1-3 buttons. Set to [{"type":"close"}] by default.
    -

    ScanQrPopupParams

    +

    ScanQrPopupParams

    This object describes the native popup for scanning QR codes.

    @@ -555,11 +551,11 @@ - +
    text StringOptional. The text to be displayed under the 'Scan QR' heading, 0-64 characters.Optional. The text to be displayed under the 'Scan QR' heading, 0-64 characters.
    -

    PopupButton

    +

    PopupButton

    This object describes the native popup button.

    @@ -573,12 +569,12 @@ - + - + @@ -587,7 +583,7 @@
    id StringOptional. Identifier of the button, 0-64 characters. Set to empty string by default.
    If the button is pressed, its id is returned in the callback and the popupClosed event.    		Optional. Identifier of the button, 0-64 characters. Set to empty string by default.
    If the button is pressed, its id is returned in the callback and the popupClosed event.
    type StringOptional. Type of the button. Set to default by default.
    Can be one of these values:
    - default, a button with the default style,
    - ok, a button with the localized text “OK”,
    - close, a button with the localized text “Close”,
    - cancel, a button with the localized text “Cancel”,
    - destructive, a button with a style that indicates a destructive action (e.g. “Remove”, “Delete”, etc.).    		Optional. Type of the button. Set to default by default.
    Can be one of these values:
    - default, a button with the default style,
    - ok, a button with the localized text "OK",
    - close, a button with the localized text "Close",
    - cancel, a button with the localized text "Cancel",
    - destructive, a button with a style that indicates a destructive action (e.g. "Remove", "Delete", etc.).
    text
    -

    BackButton

    +

    BackButton

    This object controls the back button, which can be displayed in the header of the Mini App in the Telegram interface.

    @@ -606,27 +602,27 @@ - + - + - + - +
    onClick(callback) FunctionBot API 6.1+ A method that sets the button press event handler. An alias for Telegram.WebApp.onEvent('backButtonClicked', callback)==Bot API 6.1+== A method that sets the button press event handler. An alias for Telegram.WebApp.onEvent('backButtonClicked', callback)
    offClick(callback) FunctionBot API 6.1+ A method that removes the button press event handler. An alias for Telegram.WebApp.offEvent('backButtonClicked', callback)==Bot API 6.1+== A method that removes the button press event handler. An alias for Telegram.WebApp.offEvent('backButtonClicked', callback)
    show() FunctionBot API 6.1+ A method to make the button active and visible.==Bot API 6.1+== A method to make the button active and visible.
    hide() FunctionBot API 6.1+ A method to hide the button.==Bot API 6.1+== A method to hide the button.

    All these methods return the BackButton object so they can be chained.

    -

    MainButton

    +

    MainButton

    This object controls the main button, which is displayed at the bottom of the Mini App in the Telegram interface.

    @@ -675,17 +671,17 @@ - + - + - + @@ -705,7 +701,7 @@ - + @@ -715,13 +711,13 @@ - +
    onClick(callback) FunctionA method that sets the button press event handler. An alias for Telegram.WebApp.onEvent('mainButtonClicked', callback)A method that sets the button press event handler. An alias for Telegram.WebApp.onEvent('mainButtonClicked', callback)
    offClick(callback) FunctionA method that removes the button press event handler. An alias for Telegram.WebApp.offEvent('mainButtonClicked', callback)A method that removes the button press event handler. An alias for Telegram.WebApp.offEvent('mainButtonClicked', callback)
    show() FunctionA method to make the button visible.
    Note that opening the Mini App from the attachment menu hides the main button until the user interacts with the Mini App interface.    		A method to make the button visible.
    Note that opening the Mini App from the attachment menu hides the main button until the user interacts with the Mini App interface.
    hide()
    showProgress(leaveActive) FunctionA method to show a loading indicator on the button.
    It is recommended to display loading progress if the action tied to the button may take a long time. By default, the button is disabled while the action is in progress. If the parameter leaveActive=true is passed, the button remains enabled.    		A method to show a loading indicator on the button.
    It is recommended to display loading progress if the action tied to the button may take a long time. By default, the button is disabled while the action is in progress. If the parameter leaveActive=true is passed, the button remains enabled.
    hideProgress()
    setParams(params) FunctionA method to set the button parameters. The params parameter is an object containing one or several fields that need to be changed:
    text - button text;
    color - button color;
    text_color - button text color;
    is_active - enable the button;
    is_visible - show the button.    		A method to set the button parameters. The params parameter is an object containing one or several fields that need to be changed:
    text - button text;
    color - button color;
    text_color - button text color;
    is_active - enable the button;
    is_visible - show the button.

    All these methods return the MainButton object so they can be chained.

    -

    SettingsButton

    -

    NEW This object controls the Settings item in the context menu of the Mini App in the Telegram interface.

    +

    SettingsButton

    +

    ^==NEW==^ This object controls the Settings item in the context menu of the Mini App in the Telegram interface.

    @@ -739,27 +735,27 @@ - + - + - + - +
    onClick(callback) FunctionBot API 7.0+ A method that sets the press event handler for the Settings item in the context menu. An alias for Telegram.WebApp.onEvent('settingsButtonClicked', callback)==Bot API 7.0+== A method that sets the press event handler for the Settings item in the context menu. An alias for Telegram.WebApp.onEvent('settingsButtonClicked', callback)
    offClick(callback) FunctionBot API 7.0+ A method that removes the press event handler from the Settings item in the context menu. An alias for Telegram.WebApp.offEvent('settingsButtonClicked', callback)==Bot API 7.0+== A method that removes the press event handler from the Settings item in the context menu. An alias for Telegram.WebApp.offEvent('settingsButtonClicked', callback)
    show() FunctionBot API 7.0+ A method to make the Settings item in the context menu visible.==Bot API 7.0+== A method to make the Settings item in the context menu visible.
    hide() FunctionBot API 7.0+ A method to hide the Settings item in the context menu.==Bot API 7.0+== A method to hide the Settings item in the context menu.

    All these methods return the SettingsButton object so they can be chained.

    -

    HapticFeedback

    +

    HapticFeedback

    This object controls haptic feedback.

    @@ -773,22 +769,22 @@ - + - + - +
    impactOccurred(style) FunctionBot API 6.1+ A method tells that an impact occurred. The Telegram app may play the appropriate haptics based on style value passed. Style can be one of these values:
    - light, indicates a collision between small or lightweight UI objects,
    - medium, indicates a collision between medium-sized or medium-weight UI objects,
    - heavy, indicates a collision between large or heavyweight UI objects,
    - rigid, indicates a collision between hard or inflexible UI objects,
    - soft, indicates a collision between soft or flexible UI objects.    		==Bot API 6.1+== A method tells that an impact occurred. The Telegram app may play the appropriate haptics based on style value passed. Style can be one of these values:
    - light, indicates a collision between small or lightweight UI objects,
    - medium, indicates a collision between medium-sized or medium-weight UI objects,
    - heavy, indicates a collision between large or heavyweight UI objects,
    - rigid, indicates a collision between hard or inflexible UI objects,
    - soft, indicates a collision between soft or flexible UI objects.
    notificationOccurred(type) FunctionBot API 6.1+ A method tells that a task or action has succeeded, failed, or produced a warning. The Telegram app may play the appropriate haptics based on type value passed. Type can be one of these values:
    - error, indicates that a task or action has failed,
    - success, indicates that a task or action has completed successfully,
    - warning, indicates that a task or action produced a warning.    		==Bot API 6.1+== A method tells that a task or action has succeeded, failed, or produced a warning. The Telegram app may play the appropriate haptics based on type value passed. Type can be one of these values:
    - error, indicates that a task or action has failed,
    - success, indicates that a task or action has completed successfully,
    - warning, indicates that a task or action produced a warning.
    selectionChanged() FunctionBot API 6.1+ A method tells that the user has changed a selection. The Telegram app may play the appropriate haptics.

    Do not use this feedback when the user makes or confirms a selection; use it only when the selection changes.    		==Bot API 6.1+== A method tells that the user has changed a selection. The Telegram app may play the appropriate haptics.

    Do not use this feedback when the user makes or confirms a selection; use it only when the selection changes.

    All these methods return the HapticFeedback object so they can be chained.

    -

    CloudStorage

    +

    CloudStorage

    This object controls the cloud storage. Each bot can store up to 1024 items per user in the cloud storage.

    @@ -802,37 +798,37 @@ - + - + - + - + - + - +
    setItem(key, value[, callback]) FunctionBot API 6.9+ A method that stores a value in the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. The value should contain 0-4096 characters. You can store up to 1024 keys in the cloud storage. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the value was stored.==Bot API 6.9+== A method that stores a value in the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. The value should contain 0-4096 characters. You can store up to 1024 keys in the cloud storage. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the value was stored.
    getItem(key, callback) FunctionBot API 6.9+ A method that receives a value from the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the value will be passed as the second argument.==Bot API 6.9+== A method that receives a value from the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the value will be passed as the second argument.
    getItems(keys, callback) FunctionBot API 6.9+ A method that receives values from the cloud storage using the specified keys. The keys should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the values will be passed as the second argument.==Bot API 6.9+== A method that receives values from the cloud storage using the specified keys. The keys should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the values will be passed as the second argument.
    removeItem(key[, callback]) FunctionBot API 6.9+ A method that removes a value from the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the value was removed.==Bot API 6.9+== A method that removes a value from the cloud storage using the specified key. The key should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the value was removed.
    removeItems(keys[, callback]) FunctionBot API 6.9+ A method that removes values from the cloud storage using the specified keys. The keys should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the values were removed.==Bot API 6.9+== A method that removes values from the cloud storage using the specified keys. The keys should contain 1-128 characters, only A-Z, a-z, 0-9, _ and - are allowed. If an optional callback parameter was passed, the callback function will be called. In case of an error, the first argument will contain the error. In case of success, the first argument will be null and the second argument will be a boolean indicating whether the values were removed.
    getKeys(callback) FunctionBot API 6.9+ A method that receives the list of all keys stored in the cloud storage. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the list of keys will be passed as the second argument.==Bot API 6.9+== A method that receives the list of all keys stored in the cloud storage. In case of an error, the callback function will be called and the first argument will contain the error. In case of success, the first argument will be null and the list of keys will be passed as the second argument.

    All these methods return the CloudStorage object, so they can be chained.

    -

    WebAppInitData

    +

    WebAppInitData

    This object contains data that is transferred to the Mini App when it is opened. It is empty if the Mini App was launched from a keyboard button or from inline mode.

    @@ -866,7 +862,7 @@ - + @@ -876,7 +872,7 @@ - + @@ -895,7 +891,7 @@
    chat_type StringOptional. Type of the chat from which the Mini App was opened. Can be either “sender” for a private chat with the user opening the link, “private”, “group”, “supergroup”, or “channel”. Returned only for Mini Apps launched from direct links.Optional. Type of the chat from which the Mini App was opened. Can be either "sender" for a private chat with the user opening the link, "private", "group", "supergroup", or "channel". Returned only for Mini Apps launched from direct links.
    chat_instance
    start_param StringOptional. The value of the startattach parameter, passed via link. Only returned for Mini Apps when launched from the attachment menu via link.

    The value of the start_param parameter will also be passed in the GET-parameter tgWebAppStartParam, so the Mini App can load the correct interface right away.    		Optional. The value of the startattach parameter, passed via link. Only returned for Mini Apps when launched from the attachment menu via link.

    The value of the start_param parameter will also be passed in the GET-parameter tgWebAppStartParam, so the Mini App can load the correct interface right away.
    can_send_after
    -

    WebAppUser

    +

    WebAppUser

    This object contains the data of the Mini App user.

    @@ -934,7 +930,7 @@ - + @@ -958,7 +954,7 @@
    language_code StringOptional. IETF language tag of the user's language. Returns in user field only.Optional. IETF language tag of the user's language. Returns in user field only.
    is_premium
    -

    WebAppChat

    +

    WebAppChat

    This object represents a chat.

    @@ -977,7 +973,7 @@ - + @@ -996,19 +992,19 @@
    type StringType of chat, can be either “group”, “supergroup” or “channel”Type of chat, can be either "group", "supergroup" or "channel"
    title
    -

    Validating data received via the Mini App

    -

    To validate data received via the Mini App, one should send the data from the Telegram.WebApp.initData field to the bot's backend. The data is a query string, which is composed of a series of field-value pairs.

    -

    You can verify the integrity of the data received by comparing the received hash parameter with the hexadecimal representation of the HMAC-SHA-256 signature of the data-check-string with the secret key, which is the HMAC-SHA-256 signature of the bot's token with the constant string WebAppData used as a key.

    -

    Data-check-string is a chain of all received fields, sorted alphabetically, in the format key=<value> with a line feed character ('\n', 0x0A) used as separator – e.g., 'auth_date=<auth_date>\nquery_id=<query_id>\nuser=<user>'.

    +

    Validating data received via the Mini App

    +

    To validate data received via the Mini App, one should send the data from the Telegram.WebApp.initData field to the bot's backend. The data is a query string, which is composed of a series of field-value pairs.

    +

    You can verify the integrity of the data received by comparing the received hash parameter with the hexadecimal representation of the HMAC-SHA-256 signature of the data-check-string with the secret key, which is the HMAC-SHA-256 signature of the bot's token with the constant string WebAppData used as a key.

    +

    Data-check-string is a chain of all received fields, sorted alphabetically, in the format key=<value> with a line feed character ('\n', 0x0A) used as separator – e.g., 'auth_date=<auth_date>\nquery_id=<query_id>\nuser=<user>'.

    The full check might look like:

    data_check_string = ...
-secret_key = HMAC_SHA256(<bot_token>, "WebAppData")
+secret_key = HMAC_SHA256(<bot_token>, "WebAppData")
 if (hex(HMAC_SHA256(data_check_string, secret_key)) == hash) {
   // data is from Telegram
 }

    To prevent the use of outdated data, you can additionally check the auth_date field, which contains a Unix timestamp of when it was received by the Mini App.

    Once validated, the data may be used on your server. Complex data types are represented as JSON-serialized objects.

    -

    Events Available for Mini Apps

    +

    Events Available for Mini Apps

    The Mini App can receive events from the Telegram app, onto which a handler can be attached using the Telegram.WebApp.onEvent(eventType, eventHandler) method. Inside eventHandler the this object refers to Telegram.WebApp, the set of parameters sent to the handler depends on the event type. Below is a list of possible events:

    @@ -1020,66 +1016,72 @@ if (hex(HMAC_SHA256(data_check_string, secret_key)) == hash) { - + - + - + - + - + - + - + - + - + - + - +
    themeChangedOccurs whenever theme settings are changed in the user's Telegram app (including switching to night mode).
    eventHandler receives no parameters, new theme settings and color scheme can be received via this.themeParams and this.colorScheme respectively.    		Occurs whenever theme settings are changed in the user's Telegram app (including switching to night mode).
    eventHandler receives no parameters, new theme settings and color scheme can be received via this.themeParams and this.colorScheme respectively.
    viewportChangedOccurs when the visible section of the Mini App is changed.
    eventHandler receives an object with the single field isStateStable. If isStateStable is true, the resizing of the Mini App is finished. If it is false, the resizing is ongoing (the user is expanding or collapsing the Mini App or an animated object is playing). The current value of the visible section’s height is available in this.viewportHeight.    		Occurs when the visible section of the Mini App is changed.
    eventHandler receives an object with the single field isStateStable. If isStateStable is true, the resizing of the Mini App is finished. If it is false, the resizing is ongoing (the user is expanding or collapsing the Mini App or an animated object is playing). The current value of the visible section’s height is available in this.viewportHeight.
    mainButtonClickedOccurs when the main button is pressed.
    eventHandler receives no parameters.    		Occurs when the main button is pressed.
    eventHandler receives no parameters.
    backButtonClickedBot API 6.1+ Occurrs when the back button is pressed.
    eventHandler receives no parameters.    		==Bot API 6.1+== Occurrs when the back button is pressed.
    eventHandler receives no parameters.
    settingsButtonClickedBot API 6.1+ Occurrs when the Settings item in context menu is pressed.
    eventHandler receives no parameters.    		==Bot API 6.1+== Occurrs when the Settings item in context menu is pressed.
    eventHandler receives no parameters.
    invoiceClosedBot API 6.1+ Occurrs when the opened invoice is closed.
    eventHandler receives an object with the two fields: url – invoice link provided and status – one of the invoice statuses:
    - paid – invoice was paid successfully,
    - cancelled – user closed this invoice without paying,
    - failed – user tried to pay, but the payment was failed,
    - pending – the payment is still processing. The bot will receive a service message about a successful payment when the payment is successfully paid.    		==Bot API 6.1+== Occurrs when the opened invoice is closed.
    eventHandler receives an object with the two fields: url – invoice link provided and status – one of the invoice statuses:
    - paid – invoice was paid successfully,
    - cancelled – user closed this invoice without paying,
    - failed – user tried to pay, but the payment was failed,
    - pending – the payment is still processing. The bot will receive a service message about a successful payment when the payment is successfully paid.
    popupClosedBot API 6.2+ Occurrs when the opened popup is closed.
    eventHandler receives an object with the single field button_id – the value of the field id of the pressed button. If no buttons were pressed, the field button_id will be null.    		==Bot API 6.2+== Occurrs when the opened popup is closed.
    eventHandler receives an object with the single field button_id – the value of the field id of the pressed button. If no buttons were pressed, the field button_id will be null.
    qrTextReceivedBot API 6.4+ Occurs when the QR code scanner catches a code with text data.
    eventHandler receives an object with the single field data containing text data from the QR code.    		==Bot API 6.4+== Occurs when the QR code scanner catches a code with text data.
    eventHandler receives an object with the single field data containing text data from the QR code.
    clipboardTextReceivedBot API 6.4+ Occurrs when the readTextFromClipboard method is called.
    eventHandler receives an object with the single field data containing text data from the clipboard. If the clipboard contains non-text data, the field data will be an empty string. If the Mini App has no access to the clipboard, the field data will be null.    		==Bot API 6.4+== Occurrs when the readTextFromClipboard method is called.
    eventHandler receives an object with the single field data containing text data from the clipboard. If the clipboard contains non-text data, the field data will be an empty string. If the Mini App has no access to the clipboard, the field data will be null.
    writeAccessRequestedBot API 6.9+ Occurs when the write permission was requested.
    eventHandler receives an object with the single field status containing one of the statuses:
    - allowed – user granted write permission to the bot,
    - cancelled – user declined this request.    		==Bot API 6.9+== Occurs when the write permission was requested.
    eventHandler receives an object with the single field status containing one of the statuses:
    - allowed – user granted write permission to the bot,
    - cancelled – user declined this request.
    contactRequestedBot API 6.9+ Occurrs when the user's phone number was requested.
    eventHandler receives an object with the single field status containing one of the statuses:
    - sent – user shared their phone number with the bot,
    - cancelled – user declined this request.    		==Bot API 6.9+== Occurrs when the user's phone number was requested.
    eventHandler receives an object with the single field status containing one of the statuses:
    - sent – user shared their phone number with the bot,
    - cancelled – user declined this request.
    -

    Adding Bots to the Attachment Menu

    -

    Attachment menu integration is currently only available for major advertisers on the Telegram Ad Platform. However, all bots can use it in the test server environment. Talk to Botfather on the test server to set up the integration.

    +

    Adding Bots to the Attachment Menu

    +

    Attachment menu integration is currently only available for major advertisers on the Telegram Ad Platform. However, all bots can use it in the test server environment. Talk to Botfather on the test server to set up the integration.

    A special link is used to add bots to the attachment menu:

    -

    https://t.me/botusername?startattach
    or
    https://t.me/botusername?startattach=command

    +

    https://t.me/botusername?startattach +or +https://t.me/botusername?startattach=command

    -

    For example, open this attachment menu link for @DurgerKingBot, then use the Attach menu in any private chat.

    +

    For example, open this attachment menu link for @DurgerKingBot, then use the Attach menu in any private chat.

    Opening the link prompts the user to add the bot to their attachment menu. If the bot has already been added, the attachment menu will open in the current chat and redirect to the bot there (if the link is opened from a 1-on-1 chat). If a non-empty startattach parameter was included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    The following link formats are also supported:

    -

    https://t.me/username?attach=botusername
    https://t.me/username?attach=botusername&startattach=command
    https://t.me/+1234567890?attach=botusername
    https://t.me/+1234567890?attach=botusername&startattach=command

    -

    These links open the Mini App in the attachment menu in the chat with a specific user. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. If a non-empty startattach parameter was included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    -

    Bot API 6.1+ supports a new link format:

    -

    https://t.me/botusername?startattach&choose=users+bots
    https://t.me/botusername?startattach=command&choose=groups+channels

    -

    Opening such a link prompts the user to choose a specific chat and opens the attachment menu in that chat. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. You can specify which types of chats the user will be able to choose from. It can be one or more of the following types: users, bots, groups, channels separated by a + sign. If a non-empty startattach parameter was included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    -

    Testing Mini Apps

    -

    Using bots in the test environment

    +

    https://t.me/username?attach=botusername +https://t.me/username?attach=botusername&startattach=command +https://t.me/+1234567890?attach=botusername +https://t.me/+1234567890?attach=botusername&startattach=command

    +

    These links open the Mini App in the attachment menu in the chat with a specific user. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. If a non-empty startattach parameter was included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    +

    ==Bot API 6.1+== supports a new link format:

    +

    https://t.me/botusername?startattach&choose=users+bots +https://t.me/botusername?startattach=command&choose=groups+channels

    +

    Opening such a link prompts the user to choose a specific chat and opens the attachment menu in that chat. If the bot wasn't already added to the attachment menu, the user will be prompted to do so. You can specify which types of chats the user will be able to choose from. It can be one or more of the following types: users, bots, groups, channels separated by a + sign. If a non-empty startattach parameter was included in the link, it will be passed to the Mini App in the start_param field and in the GET parameter tgWebAppStartParam.

    +

    Testing Mini Apps

    +

    Using bots in the test environment

    To log in to the test environment, use either of the following: