From 5bff5d2eb01bf1c8068a696494e270a48da6646c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 8 Jun 2023 15:59:27 +0000 Subject: [PATCH] Update content of files --- data/web/corefork.telegram.org/api/links.html | 23 +- .../bots/api-changelog.html | 291 +++-- data/web/corefork.telegram.org/bots/api.html | 1150 +++++++++-------- .../corefork.telegram.org/bots/features.html | 270 ++-- .../bots/html5-games.html | 118 -- .../corefork.telegram.org/bots/samples.html | 353 +++-- .../corefork.telegram.org/bots/webapps.html | 275 ++-- .../constructor/messageEntityUrl.html | 2 +- .../type/MessageEntity.html | 2 +- 9 files changed, 1308 insertions(+), 1176 deletions(-) delete mode 100644 data/web/corefork.telegram.org/bots/html5-games.html diff --git a/data/web/corefork.telegram.org/api/links.html b/data/web/corefork.telegram.org/api/links.html index c7c5b27b4e..774c199ef5 100644 --- a/data/web/corefork.telegram.org/api/links.html +++ b/data/web/corefork.telegram.org/api/links.html @@ -58,7 +58,7 @@
  • tg:path?query
  • tg://path?query
    • -

    The #fragment part is always ignored.

    +

    The #fragment part is always ignored when parsing Telegram deep links.

    Also note that whenever a <username>.t.me link is encountered and <username> is not equal to www, is not a single letter and is a valid username, it should be treated exactly as a t.me/<username>/ link (generate a t.me/<username>/ link and append the rest of the path (if present) and the query string (if present)).

    Public username links

    Used to link to public users, groups and channels, see here for more info on how to handle them ».

    @@ -1224,6 +1224,27 @@ tg://resolve?domain=<bot_username>&startattach=<start_parameter> +

    Emoji links

    +

    Emoji links are merely an abstraction offered by the bot API to simplify construction of messageEntityCustomEmoji constructors, and should be ignored by normal clients.

    +

    tg: syntax:

    +
    tg://emoji?id=<id>
    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameOptionalDescription
    idRequiredCustom emoji ID

    Unsupported links

    If a client encounters a tg: link type not listed on this page, help.getDeepLinkInfo should be invoked with just the path component of the link.

    Schema:

    diff --git a/data/web/corefork.telegram.org/bots/api-changelog.html b/data/web/corefork.telegram.org/bots/api-changelog.html index cbc813cf18..7dc431f077 100644 --- a/data/web/corefork.telegram.org/bots/api-changelog.html +++ b/data/web/corefork.telegram.org/bots/api-changelog.html @@ -47,15 +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

    -

    2023

    -

    April 21, 2023

    +

    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 912918a21b..93bbd2d1bb 100644 --- a/data/web/corefork.telegram.org/bots/api.html +++ b/data/web/corefork.telegram.org/bots/api.html @@ -47,13 +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

    -

    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

    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:

    @@ -118,17 +119,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.

    @@ -159,7 +161,7 @@ To learn how to create…"> - + @@ -219,12 +221,12 @@ To learn how to create…"> - + - + @@ -233,7 +235,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 ID 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 ID 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
    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.

    @@ -267,16 +269,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 (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 (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.

    @@ -309,13 +313,13 @@ To learn how to create…"> - + - + @@ -327,15 +331,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 (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 (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.

    @@ -355,9 +364,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.

    @@ -415,13 +424,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.

    @@ -445,22 +454,22 @@ To learn how to create…"> - + - + - + - + @@ -489,7 +498,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.

    @@ -508,7 +517,7 @@ To learn how to create…"> - + @@ -618,7 +627,7 @@ To learn how to create…"> - + @@ -642,7 +651,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
    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.
    sticker_set_name
    -

    Message

    +

    Message

    This object represents a message.

    @@ -706,7 +715,7 @@ To learn how to create…"> - + @@ -741,7 +750,7 @@ To learn how to create…"> - + @@ -881,12 +890,12 @@ To learn how to create…"> - + - + @@ -946,7 +955,7 @@ To learn how to create…"> - + @@ -971,12 +980,12 @@ To learn how to create…"> - + - + @@ -1010,7 +1019,7 @@ To learn how to create…">
    forward_sender_name StringOptional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messagesOptional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages
    forward_date
    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.Optional. 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
    video_chat_scheduled
    -

    MessageId

    +

    MessageId

    This object represents a unique message identifier.

    @@ -1028,7 +1037,7 @@ To learn how to create…">
    -

    MessageEntity

    +

    MessageEntity

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

    @@ -1042,7 +1051,7 @@ To learn how to create…"> - + @@ -1057,26 +1066,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), “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), "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
    -

    PhotoSize

    +

    PhotoSize

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

    @@ -1095,7 +1104,7 @@ To learn how to create…"> - + @@ -1114,7 +1123,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).

    @@ -1133,7 +1142,7 @@ To learn how to create…"> - + @@ -1172,7 +1181,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.

    @@ -1191,7 +1200,7 @@ To learn how to create…"> - + @@ -1230,7 +1239,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).

    @@ -1249,7 +1258,7 @@ To learn how to create…"> - + @@ -1273,7 +1282,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.
    thumbnail
    -

    Video

    +

    Video

    This object represents a video file.

    @@ -1292,7 +1301,7 @@ To learn how to create…"> - + @@ -1331,7 +1340,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).

    @@ -1350,7 +1359,7 @@ To learn how to create…"> - + @@ -1374,7 +1383,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.

    @@ -1393,7 +1402,7 @@ To learn how to create…"> - + @@ -1412,7 +1421,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.

    @@ -1426,22 +1435,22 @@ To learn how to create…"> - + - + - + - + @@ -1450,7 +1459,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.

    @@ -1469,11 +1478,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.

    @@ -1496,7 +1505,7 @@ To learn how to create…">
    -

    PollAnswer

    +

    PollAnswer

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

    @@ -1524,7 +1533,7 @@ To learn how to create…">
    -

    Poll

    +

    Poll

    This object contains information about a poll.

    @@ -1568,7 +1577,7 @@ To learn how to create…"> - + @@ -1602,7 +1611,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.

    @@ -1645,7 +1654,7 @@ To learn how to create…">
    -

    Venue

    +

    Venue

    This object represents a venue.

    @@ -1659,7 +1668,7 @@ To learn how to create…"> - + @@ -1679,7 +1688,7 @@ To learn how to create…"> - + @@ -1693,7 +1702,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.

    @@ -1716,7 +1725,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.

    @@ -1744,7 +1753,7 @@ To learn how to create…">
    -

    MessageAutoDeleteTimerChanged

    +

    MessageAutoDeleteTimerChanged

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

    @@ -1762,7 +1771,7 @@ To learn how to create…">
    -

    ForumTopicCreated

    +

    ForumTopicCreated

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

    @@ -1790,9 +1799,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.

    @@ -1815,13 +1824,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.

    -

    UserShared

    +

    UserShared

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

    @@ -1844,7 +1853,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.

    @@ -1867,7 +1876,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 the bot to the attachment menu or launching a Web App from a link.

    @@ -1885,7 +1894,7 @@ To learn how to create…">
    -

    VideoChatScheduled

    +

    VideoChatScheduled

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

    @@ -1903,9 +1912,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.

    @@ -1923,7 +1932,7 @@ To learn how to create…">
    -

    VideoChatParticipantsInvited

    +

    VideoChatParticipantsInvited

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

    @@ -1941,8 +1950,8 @@ To learn how to create…">
    -

    UserProfilePhotos

    -

    This object represent a user's profile pictures.

    +

    UserProfilePhotos

    +

    This object represent a user's profile pictures.

    @@ -1964,7 +1973,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

    @@ -1986,7 +1995,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 @@ -2000,7 +2009,7 @@ To learn how to create…"> -

    WebAppInfo

    +

    WebAppInfo

    Describes a Web App.

    @@ -2018,7 +2027,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).

    @@ -2042,12 +2051,12 @@ To learn how to create…"> - + - + @@ -2057,11 +2066,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 (has reply_to_message_id), 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 (has reply_to_message_id), 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_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.

    @@ -2080,22 +2089,22 @@ To learn how to create…"> - + - + - + - + @@ -2105,12 +2114,15 @@ To learn how to create…"> - +
    request_user KeyboardButtonRequestUserOptional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only.Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a "user_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_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
    Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
    Note: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
    Note: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

    -

    KeyboardButtonRequestUser

    +

    Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. +Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message. +Note: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message. +Note: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

    +

    KeyboardButtonRequestUser

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

    @@ -2138,7 +2150,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 »

    @@ -2191,7 +2203,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.

    @@ -2209,7 +2221,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).

    @@ -2228,11 +2240,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 (has reply_to_message_id), 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 (has reply_to_message_id), 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.

    @@ -2251,7 +2263,7 @@ To learn how to create…">

    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.

    -

    InlineKeyboardButton

    +

    InlineKeyboardButton

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

    @@ -2290,17 +2302,17 @@ To learn how to create…"> - + - + - + @@ -2314,12 +2326,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.

    Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.    		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.

    Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm... actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
    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

    @@ -2346,7 +2357,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 @@ -2355,7 +2366,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.

    @@ -2369,7 +2380,7 @@ To learn how to create…"> - + @@ -2393,7 +2404,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.

    @@ -2444,8 +2455,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.

    @@ -2458,7 +2469,7 @@ To learn how to create…"> - + @@ -2468,7 +2479,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 (has reply_to_message_id), 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 (has reply_to_message_id), sender of the original message.
    @@ -2476,11 +2487,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.

    @@ -2499,7 +2510,7 @@ To learn how to create…"> - + @@ -2509,11 +2520,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.

    @@ -2527,7 +2538,7 @@ To learn how to create…"> - + @@ -2571,7 +2582,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.

    @@ -2585,7 +2596,7 @@ To learn how to create…"> - + @@ -2644,7 +2655,7 @@ 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
    -

    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.

    @@ -2668,7 +2679,7 @@ To learn how to create…"> - + @@ -2678,7 +2689,7 @@ To learn how to create…"> - + @@ -2687,7 +2698,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.

    @@ -2701,7 +2712,7 @@ To learn how to create…"> - + @@ -2716,7 +2727,7 @@ To learn how to create…"> - + @@ -2780,7 +2791,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
    -

    ChatMemberMember

    +

    ChatMemberMember

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

    @@ -2794,7 +2805,7 @@ To learn how to create…"> - + @@ -2803,7 +2814,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.

    @@ -2817,7 +2828,7 @@ To learn how to create…"> - + @@ -2906,8 +2917,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.

    @@ -2920,7 +2931,7 @@ To learn how to create…"> - + @@ -2929,8 +2940,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.

    @@ -2943,7 +2954,7 @@ To learn how to create…"> - + @@ -2957,7 +2968,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
    -

    ChatMemberUpdated

    +

    ChatMemberUpdated

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

    @@ -3005,7 +3016,7 @@ To learn how to create…">
    -

    ChatJoinRequest

    +

    ChatJoinRequest

    Represents a join request sent to a chat.

    @@ -3048,7 +3059,7 @@ To learn how to create…">
    -

    ChatPermissions

    +

    ChatPermissions

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

    @@ -3131,7 +3142,7 @@ To learn how to create…">
    -

    ChatLocation

    +

    ChatLocation

    Represents a location to which a chat is connected.

    @@ -3145,7 +3156,7 @@ To learn how to create…"> - + @@ -3154,7 +3165,7 @@ 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
    -

    ForumTopic

    +

    ForumTopic

    This object represents a forum topic.

    @@ -3187,7 +3198,7 @@ To learn how to create…">
    -

    BotCommand

    +

    BotCommand

    This object represents a bot command.

    @@ -3210,7 +3221,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

      @@ -3247,7 +3258,7 @@ To learn how to create…">
    • botCommandScopeDefault + language_code
    • botCommandScopeDefault
    -

    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.

    @@ -3265,7 +3276,7 @@ To learn how to create…">
    -

    BotCommandScopeAllPrivateChats

    +

    BotCommandScopeAllPrivateChats

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

    @@ -3283,7 +3294,7 @@ To learn how to create…">
    -

    BotCommandScopeAllGroupChats

    +

    BotCommandScopeAllGroupChats

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

    @@ -3301,7 +3312,7 @@ To learn how to create…">
    -

    BotCommandScopeAllChatAdministrators

    +

    BotCommandScopeAllChatAdministrators

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

    @@ -3319,7 +3330,7 @@ To learn how to create…">
    -

    BotCommandScopeChat

    +

    BotCommandScopeChat

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

    @@ -3342,7 +3353,7 @@ To learn how to create…">
    -

    BotCommandScopeChatAdministrators

    +

    BotCommandScopeChatAdministrators

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

    @@ -3365,7 +3376,7 @@ To learn how to create…">
    -

    BotCommandScopeChatMember

    +

    BotCommandScopeChatMember

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

    @@ -3393,8 +3404,8 @@ To learn how to create…">
    -

    BotName

    -

    This object represents the bot's name.

    +

    BotName

    +

    This object represents the bot's name.

    @@ -3407,12 +3418,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.

    @@ -3425,12 +3436,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.

    @@ -3443,20 +3454,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.

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

    MenuButtonWebApp

    +

    MenuButtonWebApp

    Represents a menu button, which launches a Web App.

    @@ -3501,7 +3512,7 @@ To learn how to create…">
    -

    MenuButtonDefault

    +

    MenuButtonDefault

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

    @@ -3519,7 +3530,7 @@ To learn how to create…">
    -

    ResponseParameters

    +

    ResponseParameters

    Describes why a request was unsuccessful.

    @@ -3542,7 +3553,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.

    @@ -3570,7 +3581,7 @@ To learn how to create…"> - + @@ -3594,7 +3605,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.

    @@ -3613,12 +3624,12 @@ To learn how to create…"> - + - + @@ -3662,7 +3673,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.

    @@ -3681,12 +3692,12 @@ To learn how to create…"> - + - + @@ -3725,7 +3736,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.

    @@ -3744,12 +3755,12 @@ To learn how to create…"> - + - + @@ -3783,7 +3794,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.

    @@ -3802,12 +3813,12 @@ To learn how to create…"> - + - + @@ -3831,21 +3842,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

      -
    • It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
      • +
    • It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
    • It is not possible to resend thumbnails.
    • Resending a photo by file_id will send all of its sizes.
      • -
    • file_id is unique for each individual bot and can't be transferred from one bot to another.
      • +
    • file_id is unique for each individual bot and can't be transferred from one bot to another.
    • file_id uniquely identifies a file, but a file can have different valid file_ids even for the same bot.

    Sending by URL

    @@ -3853,21 +3864,22 @@ 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.
    • -

    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.

    @@ -3947,16 +3959,21 @@ To learn how to create…">
    -

    Formatting options

    -

    The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, and spoiler text, 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.
    - 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, and spoiler text, 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.
      • +
    • All other entities can't contain each other.
      • +

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

    • These links will work only if they are used inside an inline link or in an inline keyboard button. For example, they will not work, when used in a message text.
      • -
    • Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
      • +
    • Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
    -
    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_
@@ -3976,28 +3993,28 @@ pre-formatted fixed-width code block written in the Python programming language
 ```

    Please note:

      -
    • Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
      • -
    • Inside pre and code entities, all '`' and '\' characters must be escaped with a preceding '\' character.
      • -
    • Inside the (...) part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.
      • -
    • In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
      • +
    • Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
      • +
    • Inside pre and code entities, all '`' and '\' characters must be escaped with a preceding '\' character.
      • +
    • Inside the (...) part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.
      • +
    • In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
    • In case of ambiguity between italic and underline entities __ is always greadily treated from left to right as beginning or end of underline entity, so instead of ___italic underline___ use ___italic underline_\r__, where \r is a character with code 13, which will be ignored.
    • A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
    • Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
    -
    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>

    Please note:

    • Only the tags mentioned above are currently supported.
      • @@ -4005,11 +4022,11 @@ pre-formatted fixed-width code block written in the Python programming language
    • All numerical HTML entities are supported.
    • The API currently supports only the following named HTML entities: &lt;, &gt;, &amp; and &quot;.
    • Use nested pre and code tags, to define programming language for pre entity.
      • -
    • Programming language can't be specified for standalone code tags.
      • +
    • Programming language can't be specified for standalone code tags.
    • A valid emoji must be used as the content of the tg-emoji tag. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
    • Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
    -
    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_
@@ -4026,11 +4043,11 @@ pre-formatted fixed-width code block written in the Python programming language
 
      
 
    • Entities must not be nested, use parse mode MarkdownV2 instead.
      • 
 
    • There is no way to specify underline and strikethrough entities, use parse mode MarkdownV2 instead.
      • 
-
    • To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
      • 
+
    • 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 can't be forwarded. On success, the sent Message is returned.
    
+
    forwardMessage
    
+
    Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
    
 
@@ -4079,8 +4096,8 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    copyMessage
    
-
    Use this method to copy messages of any kind. Service 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 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.
    
 
@@ -4165,7 +4182,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    sendPhoto
    
+
    sendPhoto
    
 
    Use this method to send photos. On success, the sent Message is returned.
    
 
@@ -4193,7 +4210,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4251,7 +4268,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.
    
 
@@ -4322,7 +4339,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4356,7 +4373,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.
    
 
@@ -4390,7 +4407,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4448,7 +4465,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.
    
 
@@ -4500,7 +4517,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4564,7 +4581,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.
    
 
@@ -4616,7 +4633,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4674,7 +4691,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.
    
 
@@ -4760,7 +4777,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.
    
 
@@ -4806,7 +4823,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4840,7 +4857,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.
    
 
@@ -4896,7 +4913,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.
    
 
@@ -4988,7 +5005,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.
    
 
@@ -5046,7 +5063,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5092,7 +5109,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.
    
 
@@ -5120,19 +5137,19 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -5172,7 +5189,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.
    
 
@@ -5218,7 +5235,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5254,13 +5271,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -5300,7 +5317,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.
    
 
@@ -5328,7 +5345,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5362,10 +5379,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.
    
 
@@ -5398,7 +5415,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
-
    getUserProfilePhotos
    
+
    getUserProfilePhotos
    
 
    Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
    
 
@@ -5430,7 +5447,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.
    
 
@@ -5450,8 +5467,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.
    
 
@@ -5489,8 +5506,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.
    
 
@@ -5521,7 +5538,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.
    
 
@@ -5565,7 +5582,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.
    
 
@@ -5593,7 +5610,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5663,7 +5680,7 @@ 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
    
 
 
    
-
    setChatAdministratorCustomTitle
    
+
    setChatAdministratorCustomTitle
    
 
    Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
    
 
@@ -5695,8 +5712,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.
    
 
@@ -5721,7 +5738,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.
    
 
@@ -5747,7 +5764,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.
    
 
@@ -5779,7 +5796,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.
    
 
@@ -5800,9 +5817,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.
    
 
@@ -5842,11 +5859,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.
    
 
@@ -5892,11 +5909,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.
    
 
@@ -5922,7 +5939,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.
    
 
@@ -5948,7 +5965,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.
    
 
@@ -5974,8 +5991,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.
    
 
@@ -6000,8 +6017,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.
    
 
@@ -6020,8 +6037,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.
    
 
@@ -6046,7 +6063,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.
    
 
@@ -6072,8 +6089,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.
    
 
@@ -6104,8 +6121,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.
    
 
@@ -6130,8 +6147,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.
    
 
@@ -6150,7 +6167,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.
    
 
@@ -6170,7 +6187,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 (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
    
 
@@ -6190,8 +6207,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.
    
 
@@ -6210,7 +6227,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.
    
 
@@ -6230,7 +6247,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.
    
 
@@ -6256,7 +6273,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.
    
 
@@ -6282,7 +6299,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.
    
 
@@ -6302,9 +6319,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.
    
 
@@ -6342,7 +6359,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.
    
 
@@ -6380,7 +6397,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.
    
 
@@ -6406,7 +6423,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.
    
 
@@ -6432,7 +6449,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.
    
 
@@ -6458,7 +6475,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.
    
 
@@ -6484,8 +6501,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.
    
 
@@ -6510,8 +6527,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.
    
 
@@ -6530,8 +6547,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.
    
 
@@ -6550,8 +6567,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.
    
 
@@ -6570,8 +6587,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.
    
 
@@ -6590,7 +6607,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.
    
@@ -6627,7 +6644,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
@@ -6637,8 +6654,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.
    
 
@@ -6653,7 +6670,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -6669,8 +6686,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.
    
 
@@ -6695,8 +6712,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.
    
 
@@ -6721,8 +6738,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.
    
 
@@ -6747,7 +6764,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.
    
 
@@ -6767,8 +6784,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.
    
 
@@ -6793,7 +6810,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.
    
 
@@ -6813,8 +6830,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.
    
 
@@ -6839,7 +6856,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.
    
 
@@ -6859,8 +6876,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.
    
 
@@ -6875,18 +6892,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.
    
 
@@ -6901,12 +6918,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.
    
 
@@ -6931,7 +6948,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.
    
 
@@ -6951,12 +6968,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.
    
 
@@ -7018,7 +7035,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.
    
 
@@ -7074,8 +7091,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.
    
 
@@ -7118,7 +7135,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.
    
 
@@ -7186,7 +7203,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.
    
 
@@ -7224,7 +7241,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.
    
 
@@ -7262,7 +7279,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.
    
 
@@ -7294,8 +7311,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.
      • 
+
    
 
@@ -7320,9 +7348,9 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
 
    
-
    Stickers
    
+
    Stickers
    
 
    The following methods and objects allow your bot to handle stickers and sticker sets.
    
-
    Sticker
    
+
    Sticker
    
 
    This object represents a sticker.
    
 
@@ -7341,12 +7369,12 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -7410,7 +7438,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.
    
 
@@ -7434,7 +7462,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7458,7 +7486,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.
    
 
@@ -7472,7 +7500,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7491,7 +7519,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.
    
 
@@ -7505,7 +7533,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7515,16 +7543,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.
    
 
@@ -7552,7 +7580,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7592,7 +7620,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.
    
 
@@ -7612,7 +7640,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.
    
 
@@ -7632,7 +7660,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    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.
    
 
@@ -7654,17 +7682,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.
    
 
@@ -7686,7 +7714,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -7704,13 +7732,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -7720,7 +7748,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.
    
 
@@ -7748,11 +7776,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.
    
 
@@ -7778,7 +7806,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.
    
 
@@ -7798,7 +7826,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.
    
 
@@ -7824,7 +7852,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.
    
 
@@ -7850,7 +7878,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.
    
 
@@ -7876,7 +7904,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.
    
 
@@ -7902,7 +7930,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.
    
 
@@ -7930,11 +7958,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.
    
 
@@ -7960,7 +7988,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.
    
 
@@ -7980,10 +8008,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.
    
 
@@ -8017,7 +8046,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8026,8 +8055,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.
    
 
@@ -8066,7 +8096,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8076,7 +8106,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.
    
 
@@ -8100,11 +8130,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.
    
 
@@ -8173,7 +8203,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8197,7 +8227,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.
    
 
@@ -8275,7 +8305,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.
    
 
@@ -8324,7 +8354,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8358,7 +8388,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.
    
 
@@ -8407,7 +8437,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8441,7 +8471,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.
    
@@ -8473,7 +8503,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
@@ -8532,7 +8562,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.
    
 
@@ -8601,7 +8631,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -8665,7 +8695,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -8714,7 +8744,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8749,7 +8779,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
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -8833,7 +8863,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -8882,7 +8912,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -8922,7 +8952,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
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -8946,17 +8976,17 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -8991,7 +9021,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
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    InlineQueryResultGame
    
+
    InlineQueryResultGame
    
 
    Represents a Game.
    
 
@@ -9025,7 +9055,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.
    
-
    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.
    
 
@@ -9088,7 +9118,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.
    
 
@@ -9146,7 +9176,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.
    
 
@@ -9204,7 +9234,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.
    
 
@@ -9243,7 +9273,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.
    
-
    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.
    
 
@@ -9307,7 +9337,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -9370,7 +9400,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.
    
 
@@ -9429,7 +9459,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -9483,7 +9513,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
    
 
    Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
    
-
    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.
    
 
@@ -9525,7 +9555,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.
    
 
@@ -9568,7 +9598,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.
    
 
@@ -9607,7 +9637,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -9621,7 +9651,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.
    
 
@@ -9635,17 +9665,17 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -9654,7 +9684,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.
    
 
@@ -9733,32 +9763,32 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -9767,7 +9797,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.
    
 
@@ -9806,7 +9836,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.
    
 
@@ -9832,7 +9862,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.
    
 
@@ -9850,9 +9880,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. Please note that users will need Telegram v.4.0 or higher to use payments (released on May 18, 2017).
    
-
    sendInvoice
    
+
    sendInvoice
    
 
    Use this method to send invoices. On success, the sent Message is returned.
    
 
@@ -9964,37 +9994,37 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -10030,11 +10060,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.
    
 
@@ -10128,37 +10158,37 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
@@ -10168,7 +10198,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.
    
 
@@ -10202,11 +10232,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.
    
 
@@ -10234,11 +10264,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.
    
 
@@ -10261,7 +10291,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    Invoice
    
+
    Invoice
    
 
    This object contains basic information about an invoice.
    
 
@@ -10299,7 +10329,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    ShippingAddress
    
+
    ShippingAddress
    
 
    This object represents a shipping address.
    
 
@@ -10342,7 +10372,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    OrderInfo
    
+
    OrderInfo
    
 
    This object represents information about an order.
    
 
@@ -10361,7 +10391,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10375,7 +10405,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.
    
 
@@ -10403,7 +10433,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    SuccessfulPayment
    
+
    SuccessfulPayment
    
 
    This object contains basic information about a successful payment.
    
 
@@ -10451,7 +10481,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
    
 
 
 
    
-
    ShippingQuery
    
+
    ShippingQuery
    
 
    This object contains information about an incoming shipping query.
    
 
@@ -10484,7 +10514,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.
    
 
@@ -10532,9 +10562,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.
    
 
@@ -10557,8 +10587,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.
    
 
@@ -10576,7 +10606,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10590,7 +10620,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.
    
 
@@ -10604,47 +10634,47 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -10653,7 +10683,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 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 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 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 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 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.
    
 
@@ -10667,7 +10697,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10677,13 +10707,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.
    
 
@@ -10708,7 +10738,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.
    
 
@@ -10740,7 +10770,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10759,7 +10789,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.
    
 
@@ -10778,7 +10808,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10792,7 +10822,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.
    
 
@@ -10811,7 +10841,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10825,7 +10855,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.
    
 
@@ -10844,7 +10874,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10858,7 +10888,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.
    
 
@@ -10877,7 +10907,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10891,7 +10921,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.
    
 
@@ -10910,7 +10940,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10924,7 +10954,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.
    
 
@@ -10943,7 +10973,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10957,7 +10987,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.
    
 
@@ -10976,7 +11006,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -10990,7 +11020,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.
    
 
@@ -11009,7 +11039,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -11023,20 +11053,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.
    
 
@@ -11094,11 +11124,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.
    
 
@@ -11141,10 +11171,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.
    
 
@@ -11199,7 +11229,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.
    
@@ -11240,7 +11270,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.
    
 
@@ -11269,8 +11299,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/features.html b/data/web/corefork.telegram.org/bots/features.html index c1ba4d69f3..ab39cc4672 100644 --- a/data/web/corefork.telegram.org/bots/features.html +++ b/data/web/corefork.telegram.org/bots/features.html @@ -49,7 +49,7 @@
  • A General Bot Platform Overview
  • Full API Reference for Developers
    • -

    What features do bots have?

    +

    What features do bots have?

    -

    Inputs

    -

    Users can send messages of all types to bots, including text, files, locations, stickers, voice messages and even dice if they're feeling lucky. However, Telegram bots offer many other tools for building flexible interfaces tailored to your specific needs:

    +

    Inputs

    +

    Users can send messages of all types to bots, including text, files, locations, stickers, voice messages and even dice if they're feeling lucky. However, Telegram bots offer many other tools for building flexible interfaces tailored to your specific needs:

    For even more flexibility, Web Apps support 100% custom interfaces with JavaScript.

    - +
    -
    -

    Note: Telegram bots can support multiple languages that adapt to the users' language settings in the app.

    +

    Note: Telegram bots can support multiple languages that adapt to the users' language settings in the app.

    -

    Commands

    +

    Commands

    A command is a simple /keyword that tells the bot what to do. Telegram apps will:

    -

    Commands should be as specific as possible – for example /newlocation or /newrule is better than a /new command that then requires an additional parameter from the user like "location“ or ”rule".

    +

    Commands should be as specific as possible – for example /newlocation or /newrule is better than a /new command that then requires an additional parameter from the user like "location" or "rule".

    - +
    -

    We require all developers to support several Global Commands to make sure Telegram bots offer a consistent and user-friendly experience.

    -
    Command Scopes
    -

    Your bot is able to show different commands to different users and groups – you can control this using scopes. For example, your bot could show additional commands to group admins or translate the list based on the user’s language_code.

    +
    Command Scopes
    +

    Your bot is able to show different commands to different users and groups – you can control this using scopes. For example, your bot could show additional commands to group admins or translate the list based on the user’s language_code.

    Keep in mind that Bot API updates will not contain any information about the scope of a command sent by the user – in fact, they may contain commands that don’t exist at all in your bot. Your backend should always verify that received commands are valid and that the user was authorized to use them regardless of scope.

    +
    +

    Bots with privacy mode enabled will only receive commands in groups under special conditions, see here.

    -

    Keyboards

    +

    Keyboards

    Bots are able to interpret free text input from users, but offering specific suggestions is often more intuitive – this is where custom keyboards can be extremely useful.

    Whenever your bot sends a message, it can display a special keyboard with predefined reply options (see ReplyKeyboardMarkup). Telegram apps that receive the message will display your keyboard to the user. Using any of the buttons will immediately send the respective text. This way you can drastically simplify and streamline user interaction with your bot.

    - +
    -
    -

    Check out the one_time_keyboard parameter to automatically hide your bot's keyboard as soon as it's been used.

    +

    Check out the one_time_keyboard parameter to automatically hide your bot's keyboard as soon as it's been used.

    You can also customize the text placeholder in the input field by setting the input_field_placeholder parameter.

    -

    Inline Keyboards

    -

    There are times when you'd prefer to do things without sending any messages to the chat – like when a user is changing settings, toggling options or navigating search results. In such cases, you can use Inline Keyboards that are shown directly below their relevant messages.

    -

    Unlike with custom reply keyboards, pressing buttons on inline keyboards doesn't send messages to the chat. Instead, inline keyboards support buttons that can work behind the scenes or open different interfaces: callback buttons, URL buttons, switch-to-inline buttons, game buttons and payment buttons.

    +

    Inline Keyboards

    +

    There are times when you'd prefer to do things without sending any messages to the chat – like when a user is changing settings, toggling options or navigating search results. In such cases, you can use Inline Keyboards that are shown directly below their relevant messages.

    +

    Unlike with custom reply keyboards, pressing buttons on inline keyboards doesn't send messages to the chat. Instead, inline keyboards support buttons that can work behind the scenes or open different interfaces: callback buttons, URL buttons, switch-to-inline buttons, game buttons and payment buttons.

    - +
    -

    To provide a better user experience, consider editing your keyboard when the user toggles a setting button or navigates to a new page – this is both faster and smoother than sending a whole new message and deleting the previous one.

    -

    Menu Button

    -

    In all bot chats, a menu button appears near the message field. By default, tapping this button opens a menu that can hold some or all of a bot's commands, including a short description for each. Users can then select a command from the menu without needing to type it out.

    +

    Menu Button

    +

    In all bot chats, a menu button appears near the message field. By default, tapping this button opens a menu that can hold some or all of a bot's commands, including a short description for each. Users can then select a command from the menu without needing to type it out.

    You can set different texts of the menu button and its command descriptions for various individual users or groups of users – for example, showing translated text based on the user’s language, as explained here.

    +
    -

    The menu button can alternatively be used to launch a Web App.

    -

    Global Commands

    +

    Global Commands

    To make basic interactions more uniform, we ask all developers to support a few basic commands. Telegram apps will have interface shortcuts for these commands.

    -

    Users will see a Start button the first time they open a chat with your bot. Help and Settings links will be available in the menu on the bot's profile page if you add them in @BotFather.

    -

    Chat and User Selection

    +

    Users will see a Start button the first time they open a chat with your bot. Help and Settings links will be available in the menu on the bot's profile page if you add them in @BotFather.

    +

    Chat and User Selection

    Bots can present the user with a friendly and intuitive interface that lists any number of groups, channels or other users according to a custom set of criteria. Tapping on a chat will send its identifier to the bot in a service message and seamlessly close the interface.

    A group management bot is the perfect example: an admin could select a chat the bot should manage, and then select a user it should promote – this would happen without ever typing any text.

    Here is a quick start guide to use this feature:

    @@ -175,75 +171,74 @@ width=44% />
  • Pick a set of criteria and store them in a KeyboardButtonRequestChat object (or KeyboardButtonRequestUser for users).
  • Create a KeyboardButton and store the criteria under request_chat or request_user respectively.
  • Send a ReplyKeyboardMarkup that contains the button you just created.
    • -
  • When the user selects a chat, you'll receive its identifier in a chat_shared or user_shared service message.
    • +
  • When the user selects a chat, you'll receive its identifier in a chat_shared or user_shared service message.
    • +
    -

    Keep in mind that the bot may not be able to use the identifier it receives if the corresponding chat or user is not already known or accessible by some other means.

    -

    Interactions

    +

    Interactions

    In addition to sending commands and messages to the chat with the bot, there are several ways of interacting with them without opening any specific chat or group.

    -

    Inline Requests

    -

    Users can interact with your bot via inline queries straight from the message field in any chat. All they need to do is start a message with your bot's @username and enter a keyword.

    +

    Inline Requests

    +

    Users can interact with your bot via inline queries straight from the message field in any chat. All they need to do is start a message with your bot's @username and enter a keyword.

    Having received the query, your bot can return some results. As soon as the user selects one, it is sent to the relevant chat. This way, people can request and send content from your bot in any of their chats, groups or channels.

    Remember that inline functionality has to be enabled via @BotFather, or your bot will not receive inline Updates.

    - +
    -

    Examples of inline bots include @gif, @bing and @wiki. Web App bots can also be used inline – try typing @durgerkingbot in any chat.

    -

    Deep Linking

    -

    Telegram bots have a deep linking mechanism that allows additional parameters to be passed to the bot on startup. It could be a command that launches the bot – or an authentication token to connect the user's Telegram account to their account on another platform.

    +

    Deep Linking

    +

    Telegram bots have a deep linking mechanism that allows additional parameters to be passed to the bot on startup. It could be a command that launches the bot – or an authentication token to connect the user's Telegram account to their account on another platform.

    Each bot has a link that opens a conversation with it in Telegram – https://t.me/<bot_username>. Parameters can be added directly to this link to let your bot work with additional information on the fly, without any user input.

    A-Z, a-z, 0-9, _ and - are allowed. We recommend using base64url to encode parameters with binary and other types of content. The parameter can be up to 64 characters long.

    -

    Private Chats
    In private chats, you can use the start parameter to automatically pass any value to your bot whenever a user presses the link. For example, you could use:

    +

    Private Chats +In private chats, you can use the start parameter to automatically pass any value to your bot whenever a user presses the link. For example, you could use:

    https://t.me/your_bot?start=airplane

    When someone opens a chat with your bot via this link, you will receive:

    /start airplane
    -

    Groups
    In groups, you can add the parameter startgroup to this link. For example:

    +

    Groups +In groups, you can add the parameter startgroup to this link. For example:

    https://t.me/your_bot?startgroup=spaceship

    Following a link with this parameter prompts the user to select a group to add the bot to – the resulting update will contain text in the form:

    /start@your_bot spaceship

    Web Apps also support deep linking, for more information check out our dedicated guide.

    -

    Attachment Menu

    +

    Attachment Menu

    Certain bots can be added directly to a user’s attachment menu – giving them easy access to the bot in any chat. Currently, this option is restricted to certain approved bots, but may be expanded later.

    +
    -

    Try adding @DurgerKingBot to your attachment menu.

    -

    Integration

    +

    Integration

    There are various ways of futher integrating bots with Telegram and other services.

    -

    Web Apps

    +

    Web Apps

    Bots can easily process complex inputs of any kind and dynamic interaction flows via Web Apps. With this unique feature, you can develop any number of flexible, streamlined interfaces in JavaScript.

    Web Apps are covered in detail in our dedicated guide – you should read it carefully to learn the wide variety of features they can offer.

    @@ -251,15 +246,14 @@ width=44% />
    +
    - -

    If you develop a Web App, be sure to follow our design guidelines – you'll want your custom interface to seamlessly integrate into the app to provide users the best possible experience.

    -

    Payments

    -

    Telegram bots can accept payments with a sleek, streamlined interface that collects all necessary data from the user. Telegram doesn't collect any payment data – like the user's credit card information – and sends it directly to one of the supported payment providers.

    +

    If you develop a Web App, be sure to follow our design guidelines – you'll want your custom interface to seamlessly integrate into the app to provide users the best possible experience.

    +

    Payments

    +

    Telegram bots can accept payments with a sleek, streamlined interface that collects all necessary data from the user. Telegram doesn't collect any payment data – like the user's credit card information – and sends it directly to one of the supported payment providers.

    Here is a quick start guide to implement payments:

    @@ -272,38 +266,37 @@ width=44% />

    A full and exhaustive guide, including live checklist, parameters and in-depth method descriptions is available here. We strongly recommend that you read the full guide before going live.

    - +
    -
    -

    Telegram does not directly process the payments, does not store data about orders and does not collect any fees. Invoices are forwarded directly to the payment provider.
    For this reason, disputes must be solved between the user, the bot developer and the payment provider. You can read more about this in the Privacy Policy.

    +

    Telegram does not directly process the payments, does not store data about orders and does not collect any fees. Invoices are forwarded directly to the payment provider. +For this reason, disputes must be solved between the user, the bot developer and the payment provider. You can read more about this in the Privacy Policy.

    -

    Web Login

    +

    Web Login

    Telegram offers a flexible, lightweight and free framework to authenticate users on any website and app. This can be used to bridge your platform with Telegram, providing a smooth experience to your users. You can also freely rely on this framework to implement a fast and signup-free login on your site, regardless of its connection to Telegram.

    -

    Widgets

    +

    Widgets

    The Telegram login widget is a simple and secure way to authorize users on your website.

    1. Choose a bot – ideally its name and profile pic should match the website title and logo.
    2. Use the /setdomain command in @BotFather to pair the bot with your website domain.
    3. Configure your widget using our dedicated tool and embed it on your website.
    -

    Inline Login

    -

    When users open your website via an inline button, you can use the login_url parameter as an alternative to login widgets. This way, you'll be able to seamlessly authorize them on your website or app before the page even loads.

    +

    Inline Login

    +

    When users open your website via an inline button, you can use the login_url parameter as an alternative to login widgets. This way, you'll be able to seamlessly authorize them on your website or app before the page even loads.

    - +
    -

    Make sure to review our guide on authenticating the received data as well as our sample code.

    -

    HTML5 Games

    +

    HTML5 Games

    Bots can serve as standalone gaming platforms – with our HTML5 Gaming API you can develop multiplayer or single-player games and let your users have fun comparing ranks, scores and much more.

    To get started, follow these simple steps:

    • Send the /newgame command to @BotFather
    • Provide a description text, an image or an optional gif to showcase its gameplay
    • Send the game to users via the sendGame method or via an inline query
      • -
    • When someone wants to play, you'll receive the appropriate game_short_name in a CallbackQuery
      • +
    • When someone wants to play, you'll receive the appropriate game_short_name in a CallbackQuery
    • To launch the game, provide the HTML5 Game URL as the url param of answerCallbackQuery

    Then, to handle highscores:

    @@ -317,49 +310,50 @@ width=44% />
  • HTML5 Games Bot API Docs
    • - +
    -

    Check out @GameBot and @gamee for examples of what you can do using our Gaming Platform.

    -

    Stickers and Custom Emoji

    +

    Stickers and Custom Emoji

    Stickers and Custom Emoji are a distinctive Telegram feature used by millions of users to share artwork every day. Stickers and custom emoji take many forms – ranging from basic images to smooth vector animations and high-detail .WEBM videos.

    -

    All these formats are supported by our Bot API, which allows bots to create, edit, delete and share new artwork packs on the fly. Telegram's Import API lets users migrate packs from other platforms and sticker apps.

    -

    Creating a new pack
    To create a new pack, simply:

    +

    All these formats are supported by our Bot API, which allows bots to create, edit, delete and share new artwork packs on the fly. Telegram's Import API lets users migrate packs from other platforms and sticker apps.

    +

    Creating a new pack +To create a new pack, simply:

    • Prepare your artwork following our technical requirements.
    • Create a new sticker pack via createStickerSet. Set sticker_type to regular to create a sticker pack or to custom emoji to create a pack of custom emoji. Attach the files you wish to include in the pack as an array of InputSticker
    • You can use addStickerToSet to add stickers or emoji later on.
    -

    Additional features
    Regular stickers and custom emoji support keywords that users can type to quickly find the respective artwork – this can be useful when a sticker doesn't have obvious ties to a specific emoji. You can use the keywords parameter in InputSticker to specify them.

    +

    Additional features +Regular stickers and custom emoji support keywords that users can type to quickly find the respective artwork – this can be useful when a sticker doesn't have obvious ties to a specific emoji. You can use the keywords parameter in InputSticker to specify them.

    Custom emoji additionally support adaptive colors – they will always match the current context (e.g., white on photos, accent color when used as status, etc.); to enable this feature, use the needs_repainting parameter in createStickerSet.

    -

    Once you're done creating and sharing your artwork, don't forget to check out our remaining sticker methods to find out how to edit, delete and even reorder your pack.

    +

    Once you're done creating and sharing your artwork, don't forget to check out our remaining sticker methods to find out how to edit, delete and even reorder your pack.

    Note that these methods will only work on packs created by the bot that is calling them.

    -

    Language Support

    +

    Language Support

    Bots can tailor their interfaces to support multiple languages – updating inputs and information on the fly. A user’s language_code is included in every relevant update as an IETF language tag, allowing bots to adapt accordingly.

    We recommend that you follow our guidelines to provide the best user experience.

    • Your interfaces, texts and inline results should adapt seamlessly to the language_code, without user intervention.
      • -
    • Connected WebApps will receive the user's language_code – your HTML page should account for it.
      • -
    • HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery.
      • -
    • The bot's Name, Description and About text can be natively localized with the respective methods.
      • +
    • Connected WebApps will receive the user's language_code – your HTML page should account for it.
      • +
    • HTML5 Games can obtain language information if you specify it as a URL parameter. You can generate this parameter from the language_code field in the User object served with the initial game CallbackQuery.
      • +
    • The bot's Name, Description and About text can be natively localized with the respective methods.
    • Command lists can also be specified for individual languages – more on this here.
    +
    -
    -

    The language_code is an optional field – it could be empty.
    If you target the general public, your code should always fall back to either the last recorded language tag or English (in this order) when the field is missing for a specific user.

    +

    The language_code is an optional field – it could be empty. +If you target the general public, your code should always fall back to either the last recorded language tag or English (in this order) when the field is missing for a specific user.

    -

    Bot Management

    -

    Privacy Mode

    +

    Bot Management

    +

    Privacy Mode

    Bots are frequently added to groups to perform basic tasks or assist moderators – like automatically posting company announcements or even celebrating birthdays. By default, all bots added to groups run in Privacy Mode and only see relevant messages and commands:

    • Commands explicitly meant for them (e.g., /command@this_bot).
      • @@ -373,21 +367,20 @@ width=44% />
    • All messages from private chats.
    • All messages from channels where they are a member.
    -

    Privacy mode is enabled by default for all bots, except bots that were added to a group as admins (bot admins always receive all messages). It can be disabled so that the bot receives all messages like an ordinary user (the bot will need to be re-added to the group for this change to take effect). We only recommend doing this in cases where it is absolutely necessary for your bot to work. In most cases, using the force reply option for the bot's messages should be more than enough.

    +

    Privacy mode is enabled by default for all bots, except bots that were added to a group as admins (bot admins always receive all messages). It can be disabled so that the bot receives all messages like an ordinary user (the bot will need to be re-added to the group for this change to take effect). We only recommend doing this in cases where it is absolutely necessary for your bot to work. In most cases, using the force reply option for the bot's messages should be more than enough.

    - +
    -

    This mode not only increases user privacy, but also makes the bot more efficient by reducing the number of inputs it needs to process. Users can always see a bot’s current privacy setting in the list of group members.

    -

    Testing your bot

    +

    Testing your bot

    You can quickly test your bot without interfering with its users by simply running another instance of your code on a different bot account. To do so, create a new bot via @BotFather, obtain its token and use it in the testing instance of your code.

    All further testing and debugging can happen privately on the new bot, without affecting the original instance.

    If you need to share file references across bots, note that the file_id field is tied to a single bot id, so your test instance cannot use a shared file_id database to quickly send media – files must be individually reuploaded.

    -

    Dedicated test environment

    +

    Dedicated test environment

    Telegram also offers a dedicated test environment suitable for more advanced testing. Bots and users in this environment generally have more flexible restrictions – for example:

    • When working with the test environment, you may use HTTP links without TLS to test your Web Apps or Web Login.
      • @@ -396,55 +389,62 @@ width=44% />

      Flood limits are not raised in the test environment, and may at times be stricter. To minimize how this impacts your bot, you should make sure that it handles errors with retry policies and does not depend on hardcoded limit values.

      -

      Creating a bot in the test environment

      +

      Creating a bot in the test environment

      The test environment is completely separate from the main environment, so you will need to create a new user account and a new bot with @BotFather.

      To create an account and log in, use either of the following:

      • iOS: tap 10 times on the Settings icon > Accounts > Login to another account > Test.
        • -
      • Telegram Desktop: open ☰ Settings > Shift + Alt + Right click 'Add Account' and select 'Test Server'.
        • -
      • macOS: click the Settings icon 10 times to open the Debug Menu, ⌘ + click 'Add Account' and log in via phone number.
        • +
      • Telegram Desktop: open ☰ Settings > Shift + Alt + Right click 'Add Account' and select 'Test Server'.
        • +
      • macOS: click the Settings icon 10 times to open the Debug Menu, ⌘ + click 'Add Account' and log in via phone number.

      After logging in, simply create a new bot following the standard procedure and send your requests to the Test Bot API in this format:

      https://api.telegram.org/bot<token>/test/METHOD_NAME

      When working with the test environment, you may use HTTP links without TLS in the url field of both LoginUrl and WebAppInfo.

      -

      Status alerts

      +

      Status alerts

      Millions choose Telegram for its speed. To best benefit users, your bot also needs to be responsive. In order to help developers keep their bots in shape, @BotFather will send status alerts if it sees something is wrong.

      We check the number of replies and the request/response conversion rate for popular bots (~300 requests per minute, this value may change in the future). If your bot returns an abnormally low number, you will receive a notification from @BotFather.

      -
      Responding to alerts
      +
      Responding to alerts

      By default, you will only get one alert per bot per hour.

      Each alert has the following buttons:

      • Fixed - Use this if you found an issue with your bot and fixed it. If you press the fix button, we will resume sending alerts in the regular way so that you can see if your fix worked within 5-10 minutes instead of having to wait for an hour.
        • -
      • Support - Use this to open a chat with @BotSupport if you don't see any issues with your bot or if you think the problem is on our side.
        • -
      • Mute for 8h/1w - Use this if you can't fix your bot at the moment. This will disable all alerts for the bot in question for the specified period of time. We do not recommend using this option since your users may migrate to a more stable bot. You can unmute alerts in your bot's settings via @BotFather.
        • +
      • Support - Use this to open a chat with @BotSupport if you don't see any issues with your bot or if you think the problem is on our side.
        • +
      • Mute for 8h/1w - Use this if you can't fix your bot at the moment. This will disable all alerts for the bot in question for the specified period of time. We do not recommend using this option since your users may migrate to a more stable bot. You can unmute alerts in your bot's settings via @BotFather.
      -
      Monitored issues
      +
      Monitored issues

      We currently notify you about the following issues:

        -

      • Too few private messages are sent. Value: {value} - Your bot is sending far fewer messages than it did in previous weeks. This is useful for newsletter-style bots that send messages without prompts from users. The larger the value, the more significant the difference.

        +
      • +

        Too few private messages are sent. Value: {value} - Your bot is sending far fewer messages than it did in previous weeks. This is useful for newsletter-style bots that send messages without prompts from users. The larger the value, the more significant the difference.

        • -

      • Too few replies to incoming private messages. Conversion rate: {value} - Your bot is not replying to all messages that are being sent to it (the request/response conversion rate for your bot was too low for at least two of the last three 5-minute periods).

        +
      • +

        Too few replies to incoming private messages. Conversion rate: {value} - Your bot is not replying to all messages that are being sent to it (the request/response conversion rate for your bot was too low for at least two of the last three 5-minute periods).

      To provide a good user experience, please respond to all messages that are sent to your bot. Respond to message updates by calling send… methods (e.g. sendMessage).

        -
      • Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to inline_query updates by calling answerInlineQuery.
        • +
      • +

        Too few answers to inline queries. Conversion rate: {value} - Your bot is not replying to all inline queries that are being sent to it, calculated in the same way as above. Respond to inline_query updates by calling answerInlineQuery.

        +
        • +
      • +

        Too few answers to callback queries. Conversion rate: {value}

        +
        • +
      • +

        Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to callback_query updates by calling answerCallbackQuery.

        +
      -
        -
      • Too few answers to callback queries. Conversion rate: {value}
        • -
      • Too few answers to callback game queries. Conversion rate: {value} - Your bot is not replying to all callback queries that are being sent to it (with or without games), calculated in the same way as above. Respond to callback_query updates by calling answerCallbackQuery.
        • -
      -

      Local Bot API

      -

      You can host and work with your own instance of our open-source Bot API.
      The source code is available here, along with a quick installation guide.

      +

      Local Bot API

      +

      You can host and work with your own instance of our open-source Bot API. +The source code is available here, along with a quick installation guide.

      After installing the server, remember to use the logOut method before redirecting requests to your new local API URL.

      Your local instance runs on port 8081 by default and will only accept HTTP requests, so a TLS termination proxy has to be used to handle remote HTTPS requests.

      -

      By hosting our API locally you'll gain access to some upgrades, including:

      +

      By hosting our API locally you'll gain access to some upgrades, including:

      @@ -476,31 +476,36 @@ width=44% />
      -

      You can find an exhaustive list here.
      All limits may be subject to change in the future, so make sure to follow @BotNews.

      +

      You can find an exhaustive list here. +All limits may be subject to change in the future, so make sure to follow @BotNews.

      -

      BotFather

      +

      BotFather

      Below is a detailed guide to using @BotFather, Telegram’s tool for creating and managing bots.

      -

      Creating a new bot

      +

      Creating a new bot

      Use the /newbot command to create a new bot. @BotFather will ask you for a name and username, then generate an authentication token for your new bot.

        -

      • The name of your bot is displayed in contact details and elsewhere.

        +
      • +

        The name of your bot is displayed in contact details and elsewhere.

        • -

      • The username is a short name, used in search, mentions and t.me links. Usernames are 5-32 characters long and not case sensitive – but may only include Latin characters, numbers, and underscores. Your bot's username must end in 'bot’, like 'tetris_bot' or 'TetrisBot'.

        +
      • +

        The username is a short name, used in search, mentions and t.me links. Usernames are 5-32 characters long and not case sensitive – but may only include Latin characters, numbers, and underscores. Your bot's username must end in 'bot’, like 'tetris_bot' or 'TetrisBot'.

        • -

      • The token is a string, like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw, which is required to authorize the bot and send requests to the Bot API. Keep your token secure and store it safely, it can be used by anyone to control your bot.

        +
      • +

        The token is a string, like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw, which is required to authorize the bot and send requests to the Bot API. Keep your token secure and store it safely, it can be used by anyone to control your bot.

      -

      Unlike the bot’s name, the username cannot be changed later – so choose it carefully.
      When sending a request to api.telegram.org, remember to prefix the word ‘bot’ to your token.

      +

      Unlike the bot’s name, the username cannot be changed later – so choose it carefully. +When sending a request to api.telegram.org, remember to prefix the word ‘bot’ to your token.

      -

      About text, description and profile media

      -

      When new users open your bot, they will be met with a helpful description in a box titled “What can this bot do?”.

      +

      About text, description and profile media

      +

      When new users open your bot, they will be met with a helpful description in a box titled "What can this bot do?".

      Properly setting this field in @BotFather allows everyone to immediately get an idea of what your bot can do – your description should be brief, to the point and on topic.

      You can also add a photo or video to this field with Edit Description Picture in @BotFather.

      -

      Additionally, just like normal users, bots also come with a short bio available on their profile. If you didn't specify this field while first creating your bot, you can set it at any time with the /setabouttext command in @BotFather. Users can interact with many bots and they won't have access to their description after starting them – having a quick reminder of the bot's purpose can be very useful.

      +

      Additionally, just like normal users, bots also come with a short bio available on their profile. If you didn't specify this field while first creating your bot, you can set it at any time with the /setabouttext command in @BotFather. Users can interact with many bots and they won't have access to their description after starting them – having a quick reminder of the bot's purpose can be very useful.

      Note that both the Description and the About text can be natively localized – each user will automatically see the correct translation for their language.

      @@ -508,36 +513,38 @@ width=44% />

      Starting from April 21, 2023 (Telegram 9.6), you can edit your bot directly from its profile page – including setting a custom profile video.

      -

      Generating an authentication token

      +

      Generating an authentication token

      If your existing token is compromised or you lost it for some reason, use the /token command to generate a new one.

      -

      Transfer ownership

      -

      You can transfer ownership of your bot to another user.
      To do this, send /mybots, select your bot, then transfer ownership.
      You can only transfer a bot to users who have interacted with it at least once.

      +

      Transfer ownership

      +

      You can transfer ownership of your bot to another user. +To do this, send /mybots, select your bot, then transfer ownership. +You can only transfer a bot to users who have interacted with it at least once.

      Transferring ownership will give full control of the bot to another user – they will be able to access the bot’s messages and even delete it. The transfer is permanent, so please consider it carefully.

      -

      BotFather commands

      +

      BotFather commands

      The remaining commands are pretty self-explanatory:

      • /mybots – returns a list of your bots with handy controls to edit their settings.
      • /mygames – does the same for your games.
      -

      Edit bots

      +

      Edit bots

      To edit your bot, you have two options.

      You can use the available commands:

        -
      • /setname – change your bot's name.
        • -
      • /setdescription – change the bot's description (short text up to 512 characters). Users will see this text at the beginning of the conversation with the bot, titled 'What can this bot do?'.
        • -
      • /setabouttext – change the bot's about info, a shorter text up to 120 characters. Users will see this text on the bot's profile page. When they share your bot with someone, this text is sent together with the link.
        • -
      • /setuserpic – change the bot's profile picture.
        • +
      • /setname – change your bot's name.
        • +
      • /setdescription – change the bot's description (short text up to 512 characters). Users will see this text at the beginning of the conversation with the bot, titled 'What can this bot do?'.
        • +
      • /setabouttext – change the bot's about info, a shorter text up to 120 characters. Users will see this text on the bot's profile page. When they share your bot with someone, this text is sent together with the link.
        • +
      • /setuserpic – change the bot's profile picture.
      • /setcommands – change the list of commands supported by your bot. Users will see these commands as suggestions when they type / in the chat with your bot. See commands for more info.
        • -
      • /setdomain – link a website domain to your bot. See the login widget section.
        • +
      • /setdomain – link a website domain to your bot. See the login widget section.
      • /deletebot – delete your bot and free its username. Cannot be undone.

      Or you can use the /mybots command, tap on your bot and use the modern inline interface to edit it.

      -

      Starting from April 21, 2023 (Telegram 9.6), you can edit your bot's public-facing info directly from its profile page – including setting a custom profile video.

      +

      Starting from April 21, 2023 (Telegram 9.6), you can edit your bot's public-facing info directly from its profile page – including setting a custom profile video.

      -

      Edit settings

      +

      Edit settings

      • /setinline – toggle inline mode for your bot.
      • /setinlinegeo – request location data to provide location-based inline results.
        • @@ -545,7 +552,7 @@ width=44% />
      • /setinlinefeedback – toggle whether the API should send updates about the results chosen by users. See an in-depth explanation here.
      • /setprivacy – set which messages your bot will receive when added to a group. See privacy-mode for more info.
      -

      Manage games

      +

      Manage games

      • /newgame – create a new game.
      • /listgames – see a list of your games.
        • @@ -559,9 +566,8 @@ width=44% />

        With this information, you are ready to proceed to our Full API Reference for Developers.

        • If you have any questions, check out our Bot FAQ.
          • -
        • If you're experiencing issues with our API, please contact @BotSupport on Telegram.
          • -
        - +
      • If you're experiencing issues with our API, please contact @BotSupport on Telegram.
        • +
      diff --git a/data/web/corefork.telegram.org/bots/html5-games.html b/data/web/corefork.telegram.org/bots/html5-games.html deleted file mode 100644 index 8d90079bac..0000000000 --- a/data/web/corefork.telegram.org/bots/html5-games.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - Page not found - - - - - - - - - - - - - - - - -
      -
      -
      -
      - - -
      -
      -
      -
      -
      -
      -
      -

      Page not found

      - -
      The page has not been saved
      - -
      - -
      -
      -
      -
      -
      -
      Telegram
      -
      - Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed. -
      - -
      -
      About
      - -
      -
      -
      Mobile Apps
      - -
      -
      -
      Desktop Apps
      - -
      -
      -
      Platform
      - -
      -
      -
      -
      -
      About
      -
      -
      -
      Blog
      -
      -
      -
      Apps
      -
      -
      -
      Platform
      -
      -
      -
      Twitter
      -
      -
      -
      -
      - - - - - - diff --git a/data/web/corefork.telegram.org/bots/samples.html b/data/web/corefork.telegram.org/bots/samples.html index 9a30b409d3..d4a862e987 100644 --- a/data/web/corefork.telegram.org/bots/samples.html +++ b/data/web/corefork.telegram.org/bots/samples.html @@ -47,208 +47,369 @@

    This page lists some libraries and frameworks developed by the Telegram community – you should take care to report any bugs you may find to the respective developers, as these projects are not maintained by Telegram.

    Ping us on @BotSupport if you would like your library to appear on this page.

    -

    PHP

    +

    PHP

    -

    Go

    +

    Go

    -

    Python

    +

    Python

    -

    Rust

    +

    Rust

    -

    Kotlin

    +

    Kotlin

    -

    Node.js

    +

    Node.js

    -

    .NET

    +

    .NET

    -

    Swift

    +

    Swift

    -

    TypeScript

    +

    TypeScript

    -

    Java

    +

    Java

    -

    Scala

    +

    Scala

    -

    Ruby

    +

    Ruby

    -

    Other Languages

    +

    Other Languages

    - + diff --git a/data/web/corefork.telegram.org/bots/webapps.html b/data/web/corefork.telegram.org/bots/webapps.html index 14ba25cbe6..20e3662d44 100644 --- a/data/web/corefork.telegram.org/bots/webapps.html +++ b/data/web/corefork.telegram.org/bots/webapps.html @@ -49,34 +49,33 @@
    +
    -

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

    -

    Recent changes

    -

    April 21, 2023

    +

    Recent changes

    +

    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 Web Apps

    -

    Color Schemes

    -

    Web 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 Web Apps

    +

    Color Schemes

    +

    Web 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 Web App should ideally reflect these principles.

    -

    Implementing Web Apps

    -

    Telegram currently supports six different ways of launching Web 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 Web Apps

    +

    Telegram currently supports six different ways of launching Web 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 Web Apps

    +

    Keyboard Button Web Apps

    TL;DR: Web 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.

    @@ -125,84 +122,84 @@

    To transmit data from the user back to the bot, the Web 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 Web Apps

    +

    Inline Button Web Apps

    TL;DR: For more interactive Web 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 Web App using a web_app type Inline KeyboardButton.

    -

    From the button, a Web 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 Web 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 Web App. After receiving the message, the bot can continue communicating with the user.

    Good for:

    -

    Launching Web Apps from the Menu Button

    +

    Launching Web Apps from the Menu Button

    TL;DR: Web 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 Web 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 Web App instead.

    - +
    -

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

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

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

    -

    Inline Mode Web Apps

    +

    Inline Mode Web Apps

    TL;DR: Web 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.

    -

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

    -

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

    +

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

    +

    Inline Web 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 Web Apps

    +

    Direct Link Web Apps

    TL;DR: Web 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.

    -

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

    +

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

    In this mode, Web 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.

    -

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

    +

    Web 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 Web Apps from the Attachment Menu

    +

    Launching Web Apps from the Attachment Menu

    -

    TL;DR: Web 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: Web 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.

    -

    Web 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 web 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 Web App via its icon in the attachment menu.

    -

    You can add a 'Settings' item to the context menu of your Web 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.

    +

    Web 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 web 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 Web App via its icon in the attachment menu.

    +

    You can add a 'Settings' item to the context menu of your Web 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 Web App.

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

    -

    Initializing Web Apps

    +

    Initializing Web Apps

    To connect your Web 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:

    @@ -216,27 +213,27 @@ - + - + - + - + - + @@ -251,12 +248,12 @@ - + - + @@ -291,27 +288,27 @@ - + - + - + - + - + @@ -329,14 +326,14 @@ - + - + - + @@ -346,42 +343,42 @@ - + - + - + - + - + - + - + - + @@ -395,8 +392,8 @@
    initData StringA string with raw data transferred to the Web 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 Web 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 Web 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 Web 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 Web App. Also available in CSS as the variable var(--tg-viewport-height).

    The application can display just the top part of the Web App, with its lower part remaining outside the screen area. From this position, the user can “pull” the Web App to its maximum height, while the bot can do the same by calling the expand() method. As the position of the Web 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 Web App. Also available in CSS as the variable var(--tg-viewport-height).

    The application can display just the top part of the Web App, with its lower part remaining outside the screen area. From this position, the user can "pull" the Web App to its maximum height, while the bot can do the same by calling the expand() method. As the position of the Web 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 Web 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 Web App, with its lower part remaining outside the screen area. From this position, the user can “pull” the Web 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 Web App changes with user gestures or during animations. The value of viewportStableHeight will be updated after all gestures and animations are completed and the Web 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 Web 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 Web App, with its lower part remaining outside the screen area. From this position, the user can "pull" the Web 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 Web App changes with user gestures or during animations. The value of viewportStableHeight will be updated after all gestures and animations are completed and the Web 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.
    headerColor
    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. You can only pass Telegram.WebApp.themeParams.bg_color or Telegram.WebApp.themeParams.secondary_bg_color as a color or you can use keywords bg_color, secondary_bg_color instead.==Bot API 6.1+== A method that sets the app header color. You can only pass Telegram.WebApp.themeParams.bg_color or Telegram.WebApp.themeParams.secondary_bg_color as a color or you can use keywords bg_color, secondary_bg_color instead.
    setBackgroundColor(color) FunctionBot API 6.1+ A method that sets the app background color in the #RRGGBB format or you can use keywords bg_color, secondary_bg_color instead.==Bot API 6.1+== A method that sets the app background color in the #RRGGBB format or you can use keywords bg_color, secondary_bg_color instead.
    enableClosingConfirmation() FunctionBot API 6.2+ A method that enables a confirmation dialog while the user is trying to close the Web App.==Bot API 6.2+== A method that enables a confirmation dialog while the user is trying to close the Web App.
    disableClosingConfirmation() FunctionBot API 6.2+ A method that disables the confirmation dialog while the user is trying to close the Web App.==Bot API 6.2+== A method that disables the confirmation dialog while the user is trying to close the Web App.
    onEvent(eventType, eventHandler)A method used to send data to the bot. When this method is called, a service message is sent to the bot containing the data data of the length up to 4096 bytes, and the Web App is closed. See the field web_app_data in the class Message.

    This method is only available for Web Apps launched via a Keyboard button.
    switchInlineQuery(query[, choose_chat_types]) NEWswitchInlineQuery(query[, choose_chat_types]) ^==NEW==^ 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 Web 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 Web App interface (e.g. a click inside the Web App or on the main button)    		A method that opens a link in an external browser. The Web 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 Web App interface (e.g. a click inside the Web App or on the main button)
    openTelegramLink(url)
    openInvoice(url[, callback]) FunctionBot API 6.1+ A method that opens an invoice using the link url. The Web 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 Web 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 Web 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 Web 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 Web 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 Web 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 Web 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 Web Apps launched from the attachment menu and only in response to a user interaction with the Web App interface (e.g. a click inside the Web App or on the main button).    		==Bot API 6.4+== A method that requests text from the clipboard. The Web 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 Web Apps launched from the attachment menu and only in response to a user interaction with the Web App interface (e.g. a click inside the Web App or on the main button).
    ready() FunctionA method that informs the Telegram app that the Web 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 Web 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 Web 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 Web App is shown.
    If the method is not called, the placeholder will be hidden only when the page is fully loaded.
    expand()
    -

    ThemeParams

    -

    Web 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

    +

    Web 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:

    @@ -409,45 +406,44 @@ - + - + - + - + - + - + - +
    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).
    - +
    - -

    PopupParams

    +

    PopupParams

    This object describes the native popup.

    @@ -471,11 +467,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.

    @@ -489,11 +485,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.

    @@ -507,12 +503,12 @@ - + - + @@ -521,7 +517,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 Web App in the Telegram interface.

    @@ -540,27 +536,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 Web App in the Telegram interface.

    @@ -609,17 +605,17 @@ - + - + - + @@ -639,7 +635,7 @@ - + @@ -649,12 +645,12 @@ - +
    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 Web App from the attachment menu hides the main button until the user interacts with the Web App interface.    		A method to make the button visible.
    Note that opening the Web App from the attachment menu hides the main button until the user interacts with the Web 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.

    -

    HapticFeedback

    +

    HapticFeedback

    This object controls haptic feedback.

    @@ -668,22 +664,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.

    -

    WebAppInitData

    +

    WebAppInitData

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

    @@ -715,19 +711,19 @@ - + - + - + - + @@ -746,7 +742,7 @@
    Optional. An object containing data about the chat where the bot was launched via the attachment menu. Returned for supergroups, channels and group chats – only for Web Apps launched via the attachment menu.
    chat_type NEWchat_type ^==NEW==^ StringOptional. Type of the chat from which the Web 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 Web Apps launched from direct links.Optional. Type of the chat from which the Web 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 Web Apps launched from direct links.
    chat_instance NEWchat_instance ^==NEW==^ String Optional. Global identifier, uniquely corresponding to the chat from which the Web App was opened. Returned only for Web Apps launched from a direct link.
    start_param StringOptional. The value of the startattach parameter, passed via link. Only returned for Web 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 Web App can load the correct interface right away.    		Optional. The value of the startattach parameter, passed via link. Only returned for Web 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 Web App can load the correct interface right away.
    can_send_after
    -

    WebAppUser

    +

    WebAppUser

    This object contains the data of the Web App user.

    @@ -785,7 +781,7 @@ - + @@ -799,7 +795,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.

    @@ -818,7 +814,7 @@ - + @@ -837,19 +833,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 Web App

    -

    To validate data received via the Web 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 Web App

    +

    To validate data received via the Web 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(;, "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 Web App.

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

    -

    Events Available for Web Apps

    +

    Events Available for Web Apps

    The Web 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:

    @@ -861,58 +857,64 @@ 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 Web App is changed.
    eventHandler receives an object with the single field isStateStable. If isStateStable is true, the resizing of the Web App is finished. If it is false, the resizing is ongoing (the user is expanding or collapsing the Web 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 Web App is changed.
    eventHandler receives an object with the single field isStateStable. If isStateStable is true, the resizing of the Web App is finished. If it is false, the resizing is ongoing (the user is expanding or collapsing the Web 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 Web 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 Web App has no access to the clipboard, the field data will be null.
    -

    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 Web 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 Web 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 Web 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 Web App in the start_param field and in the GET parameter tgWebAppStartParam.

    -

    Testing Web 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 Web 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 Web 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 Web App in the start_param field and in the GET parameter tgWebAppStartParam.

    +

    Testing Web Apps

    +

    Using bots in the test environment

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