From bca72f4ddf2e1aa0ef7d5afffccde05fb781122d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 16 Mar 2022 20:39:35 +0000 Subject: [PATCH] Update content of files --- data/core.telegram.org/bots/api.html | 943 +++++++++++------------ data/corefork.telegram.org/bots/api.html | 943 +++++++++++------------ 2 files changed, 916 insertions(+), 970 deletions(-) diff --git a/data/core.telegram.org/bots/api.html b/data/core.telegram.org/bots/api.html index 1a5b8552a9..62231bcc4f 100644 --- a/data/core.telegram.org/bots/api.html +++ b/data/core.telegram.org/bots/api.html @@ -44,33 +44,32 @@ 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

-

January 31, 2022

+

January 31, 2022

Bot API 5.7

-

December 30, 2021

+

December 30, 2021

Bot API 5.6

-

December 7, 2021

+

December 7, 2021

Bot API 5.5

-

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.

@@ -3169,21 +3159,16 @@ On successful call, a JSON-object containing the result will be returned.

-

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 use either 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:

- +

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 use either 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:

-
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_
@@ -3202,25 +3187,25 @@ pre-formatted fixed-width code block written in the Python programming language
 ```

Please note:

-
HTML style
+
HTML style

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

<b>bold</b>, <strong>bold</strong>
 <i>italic</i>, <em>italic</em>
 <u>underline</u>, <ins>underline</ins>
 <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
-<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
-<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
-<a href="http://www.example.com/">inline URL</a>
-<a href="tg://user?id=123456789">inline mention of a user</a>
+<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>
 <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:

-
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_
@@ -3247,11 +3232,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.

 
@@ -3294,8 +3279,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. 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. 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.

 
@@ -3374,7 +3359,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.

 
@@ -3396,7 +3381,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3448,7 +3433,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 info 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 info 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.

 
@@ -3513,7 +3498,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3547,7 +3532,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
thumb
 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 info 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 info 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.

 
@@ -3575,7 +3560,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3633,7 +3618,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
thumb
 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 info 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 info on Sending Files »
 

 

 caption

 
 

-
sendVideo

+
sendVideo

 
Use this method to send video files, Telegram clients support mp4 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.

 
@@ -3679,7 +3664,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3737,7 +3722,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -3783,7 +3768,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3835,7 +3820,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -3915,7 +3900,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 mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

 
@@ -3955,7 +3940,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3989,7 +3974,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -4039,7 +4024,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.

 
@@ -4125,7 +4110,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.

 
@@ -4193,7 +4178,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.

 
@@ -4231,7 +4216,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.

 
@@ -4283,7 +4268,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4329,7 +4314,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.

 
@@ -4351,19 +4336,19 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -4403,7 +4388,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.

 
@@ -4443,7 +4428,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4479,13 +4464,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -4525,7 +4510,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.

 
@@ -4547,7 +4532,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4581,10 +4566,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.

 
@@ -4611,7 +4596,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.

 
@@ -4643,7 +4628,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
 
 

-
getFile

+
getFile

 
Use this method to get basic info 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.

 
@@ -4663,8 +4648,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.

 
@@ -4702,8 +4687,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.

 
@@ -4734,7 +4719,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.

 
@@ -4772,7 +4757,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.

 
@@ -4800,7 +4785,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4864,7 +4849,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.

 
@@ -4896,8 +4881,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.

 
@@ -4922,7 +4907,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.

 
@@ -4948,7 +4933,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.

 
@@ -4974,7 +4959,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.

 
@@ -4995,9 +4980,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.

 
@@ -5037,11 +5022,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.

 
@@ -5087,11 +5072,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.

 
@@ -5117,7 +5102,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.

 
@@ -5143,7 +5128,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.

 
@@ -5169,8 +5154,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.

 
@@ -5195,8 +5180,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.

 
@@ -5215,8 +5200,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.

 
@@ -5241,7 +5226,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.

 
@@ -5267,8 +5252,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.

 
@@ -5299,8 +5284,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.

 
@@ -5325,8 +5310,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.

 
@@ -5345,7 +5330,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.

 
@@ -5365,7 +5350,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.

 
@@ -5385,7 +5370,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
 
 

-
getChatAdministrators

+
getChatAdministrators

 
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

 
@@ -5405,7 +5390,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.

 
@@ -5425,7 +5410,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. Returns a ChatMember object on success.

 
@@ -5451,7 +5436,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.

 
@@ -5477,7 +5462,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.

 
@@ -5497,7 +5482,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.

@@ -5534,7 +5519,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
@@ -5544,8 +5529,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 https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

+
setMyCommands

+
Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

 
@@ -5560,7 +5545,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5576,8 +5561,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.

 
@@ -5602,8 +5587,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 Array of BotCommand on success. 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 Array of BotCommand on success. If commands aren't set, an empty list is returned.

 
@@ -5628,12 +5613,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.

 
@@ -5695,7 +5680,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.

 
@@ -5751,8 +5736,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.

 
@@ -5795,7 +5780,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.

 
@@ -5833,7 +5818,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.

 
@@ -5865,18 +5850,8 @@ 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.
    • 
-
  • 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.
- 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.

 
@@ -5901,9 +5876,9 @@ Returns True on success.

 
 

 

 
 

-
Stickers

+
Stickers

 
The following methods and objects allow your bot to handle stickers and sticker sets.

-
Sticker

+
Sticker

 
This object represents a sticker.

 
@@ -5922,7 +5897,7 @@ Returns True on success.
-
+
@@ -5971,7 +5946,7 @@ Returns True on success.

 
 

 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
 

 
 

-
StickerSet

+
StickerSet

 
This object represents a sticker set.

 
@@ -6019,7 +5994,7 @@ Returns True on success.

 
 
 
 

-
MaskPosition

+
MaskPosition

 
This object describes the position on faces where a mask should be placed by default.

 
@@ -6033,7 +6008,7 @@ Returns True on success.
-
+
@@ -6052,7 +6027,7 @@ Returns True on success.

 
 

 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
 

 
 

-
sendSticker

+
sendSticker

 
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

 
@@ -6108,7 +6083,7 @@ Returns True on success.

 
 
 
 

-
getStickerSet

+
getStickerSet

 
Use this method to get a sticker set. On success, a StickerSet object is returned.

 
@@ -6128,7 +6103,7 @@ Returns True on success.

 
 
 
 

-
uploadStickerFile

+
uploadStickerFile

 
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.

 
@@ -6154,7 +6129,7 @@ Returns True on success.

 
 
 
 

-
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. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.

 
@@ -6176,7 +6151,7 @@ Returns True on success.
-
+
@@ -6194,13 +6169,13 @@ Returns True on success.
-
+
-
+
@@ -6222,7 +6197,7 @@ Returns True on success.

 
 
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.
 

 

 title
 tgs_sticker
 InputFile
 OptionalTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirementsTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements
 

 

 webm_sticker
 InputFile
 OptionalWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirementsWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements
 

 

 emojis
 

 
 

-
addStickerToSet

+
addStickerToSet

 
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

 
@@ -6256,13 +6231,13 @@ Returns True on success.
-
+
-
+
@@ -6278,7 +6253,7 @@ Returns True on success.

 
 
tgs_sticker
 InputFile
 OptionalTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirementsTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements
 

 

 webm_sticker
 InputFile
 OptionalWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirementsWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements
 

 

 emojis
 

 
 

-
setStickerPositionInSet

+
setStickerPositionInSet

 
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

 
@@ -6304,7 +6279,7 @@ Returns True on success.

 
 
 
 

-
deleteStickerFromSet

+
deleteStickerFromSet

 
Use this method to delete a sticker from a set created by the bot. Returns True on success.

 
@@ -6324,7 +6299,7 @@ Returns True on success.

 
 
 
 

-
setStickerSetThumb

+
setStickerSetThumb

 
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.

 
@@ -6352,15 +6327,14 @@ Returns True on success.
-
+

 
 
thumb
 InputFile or String
 OptionalA PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.
 

 
 

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

 
@@ -6394,7 +6368,7 @@ Please see our Introduction to Inline bots for more d
 
-
+
@@ -6403,9 +6377,8 @@ Please see our Introduction to Inline bots for more d
 

 

 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.

 
@@ -6444,7 +6417,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6456,11 +6429,11 @@ No more than 50 results per query are allowed.

-
+

 
 

 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.
 

 

 switch_pm_text
 switch_pm_parameter
 String
 OptionalDeep-linking parameter for the /start message sent to the bot when user presses the switch 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.		Deep-linking parameter for the /start message sent to the bot when user presses the switch 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.

 
@@ -6529,7 +6502,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6553,7 +6526,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -6631,7 +6604,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -6680,7 +6653,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6714,7 +6687,7 @@ No more than 50 results per query are allowed.

 
 

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

 
@@ -6763,7 +6736,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6797,7 +6770,7 @@ No more than 50 results per query are allowed.

 
 

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

@@ -6829,7 +6802,7 @@ No more than 50 results per query are allowed.

 
 mime_type
 String
-Mime type of the content of video url, "text/html" or "video/mp4"
+Mime type of the content of video url, “text/html” or “video/mp4”
 
 
 thumb_url
@@ -6888,7 +6861,7 @@ No more than 50 results per query are allowed.

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

 
@@ -6957,7 +6930,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7021,7 +6994,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7070,7 +7043,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7105,7 +7078,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7189,7 +7162,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7238,7 +7211,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7278,7 +7251,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7302,17 +7275,17 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
@@ -7347,7 +7320,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7381,7 +7354,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7444,7 +7417,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7502,7 +7475,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7560,7 +7533,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7599,7 +7572,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7663,7 +7636,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7726,7 +7699,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7785,7 +7758,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7839,7 +7812,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7881,7 +7854,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
InputLocationMessageContent

+
InputLocationMessageContent

 
Represents the content of a location message to be sent as the result of an inline query.

 
@@ -7924,7 +7897,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
InputVenueMessageContent

+
InputVenueMessageContent

 
Represents the content of a venue message to be sent as the result of an inline query.

 
@@ -7963,7 +7936,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7977,7 +7950,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7991,17 +7964,17 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
@@ -8010,7 +7983,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -8089,32 +8062,32 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
@@ -8123,7 +8096,7 @@ No more than 50 results per query are allowed.

 
 

 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 user's phone number should be sent to providerOptional. Pass True, if user's phone number should be sent to provider
 

 

 send_email_to_provider
 BooleanOptional. Pass True, if user's email address should be sent to providerOptional. Pass True, if 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.

 
@@ -8162,9 +8135,9 @@ No more than 50 results per query are allowed.

 
 
 

 
Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.

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

 
@@ -8270,37 +8243,37 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
@@ -8336,11 +8309,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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 user's phone number should be sent to providerPass True, if user's phone number should be sent to provider
 

 

 send_email_to_provider
 Boolean
 OptionalPass True, if user's email address should be sent to providerPass True, if user's email address should be sent to provider
 

 

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

 
 

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

 
@@ -8374,11 +8347,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -8406,11 +8379,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -8433,7 +8406,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
Invoice

+
Invoice

 
This object contains basic information about an invoice.

 
@@ -8471,7 +8444,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
ShippingAddress

+
ShippingAddress

 
This object represents a shipping address.

 
@@ -8514,7 +8487,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
OrderInfo

+
OrderInfo

 
This object represents information about an order.

 
@@ -8533,7 +8506,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8547,7 +8520,7 @@ No more than 50 results per query are allowed.

 
 

 phone_number
 StringOptional. User's phone numberOptional. User's phone number
 

 

 email
 

 
 

-
ShippingOption

+
ShippingOption

 
This object represents one shipping option.

 
@@ -8575,7 +8548,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
SuccessfulPayment

+
SuccessfulPayment

 
This object contains basic information about a successful payment.

 
@@ -8623,7 +8596,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
ShippingQuery

+
ShippingQuery

 
This object contains information about an incoming shipping query.

 
@@ -8656,7 +8629,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
PreCheckoutQuery

+
PreCheckoutQuery

 
This object contains information about an incoming pre-checkout query.

 
@@ -8704,9 +8677,9 @@ No more than 50 results per query are allowed.

 
 
 
 

-
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

 
Contains information about Telegram Passport data shared with the bot by the user.

 
@@ -8729,8 +8702,8 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -8748,7 +8721,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8762,7 +8735,7 @@ No more than 50 results per query are allowed.

 
 

 

 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

 
Contains information about documents or other Telegram Passport elements shared with the bot by the user.

 
@@ -8776,47 +8749,47 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -8825,7 +8798,7 @@ No more than 50 results per query are allowed.

 
 

 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

 
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

 
@@ -8839,7 +8812,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8849,13 +8822,13 @@ No more than 50 results per query are allowed.

-
+

 
 

 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.

 
@@ -8880,7 +8853,7 @@ No more than 50 results per query are allowed.

 
 

 

 
 

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

 
@@ -8912,7 +8885,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8931,7 +8904,7 @@ No more than 50 results per query are allowed.

 
 

 

 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.

 
@@ -8950,7 +8923,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8964,7 +8937,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -8983,7 +8956,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8997,7 +8970,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9016,7 +8989,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9030,7 +9003,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9049,7 +9022,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9063,7 +9036,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9082,7 +9055,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9096,7 +9069,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9115,7 +9088,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9129,7 +9102,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9148,7 +9121,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9162,7 +9135,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9181,7 +9154,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9195,20 +9168,20 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9260,11 +9233,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -9307,10 +9280,10 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -9365,7 +9338,7 @@ No more than 50 results per query are allowed.

 
 

 

 
 

-
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. On success, 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 his neighbors are not among them. Please note that this behavior is subject to change.

@@ -9406,7 +9379,7 @@ No more than 50 results per query are allowed.

 
 
 
-
GameHighScore

+
GameHighScore

 
This object represents one row of the high scores table for a game.

 
@@ -9435,8 +9408,8 @@ No more than 50 results per query are allowed.

 
 
 

 

-
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/corefork.telegram.org/bots/api.html b/data/corefork.telegram.org/bots/api.html index 4643338ce5..1998198ec8 100644 --- a/data/corefork.telegram.org/bots/api.html +++ b/data/corefork.telegram.org/bots/api.html @@ -44,33 +44,32 @@ 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

-

January 31, 2022

+

January 31, 2022

Bot API 5.7

-

December 30, 2021

+

December 30, 2021

Bot API 5.6

-

December 7, 2021

+

December 7, 2021

Bot API 5.5

    -
  • Bots are now allowed to contact users who sent a join request to a chat where the bot is an administrator with the can_invite_users administrator right – even if the user never interacted with the bot before.
    • +
  • Bots are now allowed to contact users who sent a join request to a chat where the bot is an administrator with the can_invite_users administrator right – even if the user never interacted with the bot before.
  • Added support for mentioning users by their ID in inline keyboards. This will only work in Telegram versions released after December 7, 2021. Older clients will display unsupported message.
  • Added the methods banChatSenderChat and unbanChatSenderChat for banning and unbanning channel chats in supergroups and channels.
  • Added the field has_private_forwards to the class Chat for private chats, which can be used to check the possibility of mentioning the user by their ID.
    • @@ -80,7 +79,7 @@ To learn how to create and set up a bot, please consult our Message and Chat to check this.

    Note: After this update users are able to send messages on behalf of channels they own. Bots are expected to use the field sender_chat in the class Message to correctly support such messages.

    Note: As previously announced, user identifiers can now have up to 52 significant bits and require a 64-bit integer or double-precision float type to be stored safely.

    -

    November 5, 2021

    +

    November 5, 2021

    Bot API 5.4

    • Added the the parameter creates_join_request to the methods createChatInviteLink and editChatInviteLink for managing chat invite links that create join requests (read more about this on our blog).
      • @@ -91,9 +90,9 @@ To learn how to create and set up a bot, please consult our sendChatAction.

    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:

    @@ -103,17 +102,17 @@ To learn how to create and set up a bot, please consult our 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.

    • All methods in the Bot API are case-insensitive.
    • All queries must be made using UTF-8.
    -

    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:

    • Download files without a size limit.
      • @@ -125,14 +124,13 @@ To learn how to create and set up a bot, please consult our getFile request.
    -

    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.

    @@ -145,7 +143,7 @@ At most one of the optional parameters can be present in any gi - + @@ -205,12 +203,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -219,7 +217,7 @@ At most one of the optional parameters can be present in any gi
    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). An Array of Update objects is returned.

    @@ -253,18 +251,16 @@ At most one of the optional parameters can be present in any gi - +
    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 request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.

    +

    If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot's token, you can be pretty sure it's us.

    @@ -297,13 +293,13 @@ At most one of the optional parameters can be present in any gi - + - + @@ -314,15 +310,10 @@ At most one of the optional parameters can be present in any gi
    max_connections Integer OptionalMaximum 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.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_updates
    -

    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.

    +

    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.

    +

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

    -
    -

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

    -
    -

    deleteWebhook

    +

    deleteWebhook

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

    @@ -342,9 +333,9 @@ At most one of the optional parameters can be present in any gi
    -

    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

    Contains information about the current status of a webhook.

    @@ -397,13 +388,13 @@ At most one of the optional parameters can be present in any gi
    -

    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.

    @@ -427,22 +418,22 @@ At most one of the optional parameters can be present in any gi - + - + - + - + @@ -461,7 +452,7 @@ At most one of the optional parameters can be present in any gi
    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
    can_join_groups
    -

    Chat

    +

    Chat

    This object represents a chat.

    @@ -480,7 +471,7 @@ At most one of the optional parameters can be present in any gi - + @@ -550,7 +541,7 @@ At most one of the optional parameters can be present in any gi - + @@ -574,7 +565,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -633,7 +624,7 @@ At most one of the optional parameters can be present in any gi - + @@ -663,7 +654,7 @@ At most one of the optional parameters can be present in any gi - + @@ -798,12 +789,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -848,7 +839,7 @@ At most one of the optional parameters can be present in any gi - + @@ -877,7 +868,7 @@ At most one of the optional parameters can be present in any gi
    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.
    voice_chat_scheduled
    -

    MessageId

    +

    MessageId

    This object represents a unique message identifier.

    @@ -895,7 +886,7 @@ At most one of the optional parameters can be present in any gi
    -

    MessageEntity

    +

    MessageEntity

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

    @@ -909,7 +900,7 @@ At most one of the optional parameters can be present in any gi - + @@ -924,21 +915,21 @@ At most one of the optional parameters can be present in any gi - + - + - +
    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)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)
    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
    -

    PhotoSize

    +

    PhotoSize

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

    @@ -957,7 +948,7 @@ At most one of the optional parameters can be present in any gi - + @@ -976,7 +967,7 @@ At most one of the optional parameters can be present in any gi
    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).

    @@ -995,7 +986,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1034,7 +1025,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -1053,7 +1044,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1092,7 +1083,7 @@ At most one of the optional parameters can be present in any gi
    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).

    @@ -1111,7 +1102,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1135,7 +1126,7 @@ At most one of the optional parameters can be present in any gi
    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.
    thumb
    -

    Video

    +

    Video

    This object represents a video file.

    @@ -1154,7 +1145,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1193,7 +1184,7 @@ At most one of the optional parameters can be present in any gi
    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).

    @@ -1212,7 +1203,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1236,7 +1227,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -1255,7 +1246,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1274,7 +1265,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -1288,22 +1279,22 @@ At most one of the optional parameters can be present in any gi - + - + - + - + @@ -1312,7 +1303,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -1331,11 +1322,11 @@ At most one of the optional parameters can be present in any gi - +
    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.

    @@ -1358,7 +1349,7 @@ At most one of the optional parameters can be present in any gi
    -

    PollAnswer

    +

    PollAnswer

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

    @@ -1386,7 +1377,7 @@ At most one of the optional parameters can be present in any gi
    -

    Poll

    +

    Poll

    This object contains information about a poll.

    @@ -1430,7 +1421,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1464,7 +1455,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -1507,7 +1498,7 @@ At most one of the optional parameters can be present in any gi
    -

    Venue

    +

    Venue

    This object represents a venue.

    @@ -1521,7 +1512,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1541,7 +1532,7 @@ At most one of the optional parameters can be present in any gi - + @@ -1555,7 +1546,7 @@ At most one of the optional parameters can be present in any gi
    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
    -

    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.

    @@ -1583,7 +1574,7 @@ At most one of the optional parameters can be present in any gi
    -

    MessageAutoDeleteTimerChanged

    +

    MessageAutoDeleteTimerChanged

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

    @@ -1601,7 +1592,7 @@ At most one of the optional parameters can be present in any gi
    -

    VoiceChatScheduled

    +

    VoiceChatScheduled

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

    @@ -1619,9 +1610,9 @@ At most one of the optional parameters can be present in any gi
    -

    VoiceChatStarted

    +

    VoiceChatStarted

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

    -

    VoiceChatEnded

    +

    VoiceChatEnded

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

    @@ -1639,7 +1630,7 @@ At most one of the optional parameters can be present in any gi
    -

    VoiceChatParticipantsInvited

    +

    VoiceChatParticipantsInvited

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

    @@ -1657,8 +1648,8 @@ At most one of the optional parameters can be present in any gi
    -

    UserProfilePhotos

    -

    This object represent a user's profile pictures.

    +

    UserProfilePhotos

    +

    This object represent a user's profile pictures.

    @@ -1680,7 +1671,7 @@ At most one of the optional parameters can be present in any gi
    -

    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.

    Maximum file size to download is 20 MB

    @@ -1702,7 +1693,7 @@ At most one of the optional parameters can be present in any gi 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 @@ -1716,7 +1707,7 @@ At most one of the optional parameters can be present in any gi -

    ReplyKeyboardMarkup

    +

    ReplyKeyboardMarkup

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

    @@ -1735,12 +1726,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -1750,11 +1741,11 @@ At most one of the optional parameters can be present in any gi - +
    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 text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.

    @@ -1773,12 +1764,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -1787,9 +1778,8 @@ At most one of the optional parameters can be present in any gi
    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 onlyOptional. 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 onlyOptional. If True, the user's current location will be sent when the button is pressed. Available in private chats only
    request_poll
    -

    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.

    -

    KeyboardButtonPollType

    +

    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.

    +

    KeyboardButtonPollType

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

    @@ -1807,7 +1797,7 @@ At most one of the optional parameters can be present in any gi
    -

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

    @@ -1826,11 +1816,11 @@ At most one of the optional parameters can be present in any gi - +
    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.

    @@ -1849,7 +1839,7 @@ At most one of the optional parameters can be present in any gi

    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.

    @@ -1883,12 +1873,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -1902,11 +1892,12 @@ At most one of the optional parameters can be present in any gi
    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. Can 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. Can 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. Can 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. Can 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.
    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

    @@ -1933,7 +1924,7 @@ At most one of the optional parameters can be present in any gi 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 @@ -1942,7 +1933,7 @@ At most one of the optional parameters can be present in any gi -

    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.

    @@ -1993,8 +1984,8 @@ At most one of the optional parameters can be present in any gi

    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.

    @@ -2007,7 +1998,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2017,7 +2008,7 @@ At most one of the optional parameters can be present in any gi - +
    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.
    @@ -2025,11 +2016,11 @@ At most one of the optional parameters can be present in any gi

    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.

    @@ -2048,7 +2039,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2058,11 +2049,11 @@ At most one of the optional parameters can be present in any gi - +
    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.

    @@ -2076,7 +2067,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2120,7 +2111,7 @@ At most one of the optional parameters can be present in any gi
    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
    -

    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.

    @@ -2144,7 +2135,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2154,7 +2145,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2163,7 +2154,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2177,7 +2168,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2192,7 +2183,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2251,7 +2242,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2265,7 +2256,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2274,7 +2265,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2288,7 +2279,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2347,8 +2338,8 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2361,7 +2352,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2370,8 +2361,8 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2384,7 +2375,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2398,7 +2389,7 @@ At most one of the optional parameters can be present in any gi
    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.

    @@ -2441,7 +2432,7 @@ At most one of the optional parameters can be present in any gi
    -

    ChatJoinRequest

    +

    ChatJoinRequest

    Represents a join request sent to a chat.

    @@ -2479,7 +2470,7 @@ At most one of the optional parameters can be present in any gi
    -

    ChatPermissions

    +

    ChatPermissions

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

    @@ -2532,7 +2523,7 @@ At most one of the optional parameters can be present in any gi
    -

    ChatLocation

    +

    ChatLocation

    Represents a location to which a chat is connected.

    @@ -2546,7 +2537,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2555,7 +2546,7 @@ At most one of the optional parameters can be present in any gi
    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
    -

    BotCommand

    +

    BotCommand

    This object represents a bot command.

    @@ -2578,7 +2569,7 @@ At most one of the optional parameters can be present in any gi
    -

    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

      @@ -2615,7 +2606,7 @@ At most one of the optional parameters can be present in any gi
    • 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.

    @@ -2633,7 +2624,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeAllPrivateChats

    +

    BotCommandScopeAllPrivateChats

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

    @@ -2651,7 +2642,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeAllGroupChats

    +

    BotCommandScopeAllGroupChats

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

    @@ -2669,7 +2660,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeAllChatAdministrators

    +

    BotCommandScopeAllChatAdministrators

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

    @@ -2687,7 +2678,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeChat

    +

    BotCommandScopeChat

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

    @@ -2710,7 +2701,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeChatAdministrators

    +

    BotCommandScopeChatAdministrators

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

    @@ -2733,7 +2724,7 @@ At most one of the optional parameters can be present in any gi
    -

    BotCommandScopeChatMember

    +

    BotCommandScopeChatMember

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

    @@ -2761,7 +2752,7 @@ At most one of the optional parameters can be present in any gi
    -

    ResponseParameters

    +

    ResponseParameters

    Contains information about why a request was unsuccessful.

    @@ -2784,7 +2775,7 @@ At most one of the optional parameters can be present in any gi
    -

    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.

    @@ -2812,7 +2803,7 @@ At most one of the optional parameters can be present in any gi - + @@ -2831,7 +2822,7 @@ At most one of the optional parameters can be present in any gi
    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 info 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 info on Sending Files »
    caption
    -

    InputMediaVideo

    +

    InputMediaVideo

    Represents a video to be sent.

    @@ -2850,12 +2841,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -2894,7 +2885,7 @@ At most one of the optional parameters can be present in any gi
    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 info 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 info on Sending Files »
    thumb 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 info 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 info on Sending Files »
    caption
    -

    InputMediaAnimation

    +

    InputMediaAnimation

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

    @@ -2913,12 +2904,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -2952,7 +2943,7 @@ At most one of the optional parameters can be present in any gi
    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 info 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 info on Sending Files »
    thumb 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 info 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 info on Sending Files »
    caption
    -

    InputMediaAudio

    +

    InputMediaAudio

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

    @@ -2971,12 +2962,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -3010,7 +3001,7 @@ At most one of the optional parameters can be present in any gi
    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 info 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 info on Sending Files »
    thumb 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 info 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 info on Sending Files »
    caption
    -

    InputMediaDocument

    +

    InputMediaDocument

    Represents a general file to be sent.

    @@ -3029,12 +3020,12 @@ At most one of the optional parameters can be present in any gi - + - + @@ -3058,21 +3049,21 @@ At most one of the optional parameters can be present in any gi
    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 info 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 info on Sending Files »
    thumb 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 info 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 info 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

    -

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

    +

    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

    @@ -3080,22 +3071,21 @@ At most one of the optional parameters can be present in any gi
  • 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.

@@ -3169,21 +3159,16 @@ On successful call, a JSON-object containing the result will be returned.

-

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 use either 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 use either 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.
  • These mentions are only guaranteed to work if the user has contacted the bot in the past, has sent a callback query to the bot via an inline button or is a member in the group where he was mentioned.
-
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_
@@ -3202,25 +3187,25 @@ 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 (...) part of inline link 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 (...) part of inline link 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.
-
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>
+<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>
 <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:

-
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_
@@ -3247,11 +3232,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.

 
@@ -3294,8 +3279,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. 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. 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.

 
@@ -3374,7 +3359,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.

 
@@ -3396,7 +3381,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3448,7 +3433,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 info 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 info 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.

 
@@ -3513,7 +3498,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3547,7 +3532,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
thumb
 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 info 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 info 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.

 
@@ -3575,7 +3560,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3633,7 +3618,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
thumb
 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 info 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 info on Sending Files »
 

 

 caption

 
 

-
sendVideo

+
sendVideo

 
Use this method to send video files, Telegram clients support mp4 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.

 
@@ -3679,7 +3664,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3737,7 +3722,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -3783,7 +3768,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3835,7 +3820,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -3915,7 +3900,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 mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

 
@@ -3955,7 +3940,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -3989,7 +3974,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

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

 
@@ -4039,7 +4024,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.

 
@@ -4125,7 +4110,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.

 
@@ -4193,7 +4178,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.

 
@@ -4231,7 +4216,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.

 
@@ -4283,7 +4268,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4329,7 +4314,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.

 
@@ -4351,19 +4336,19 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
-
+
@@ -4403,7 +4388,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.

 
@@ -4443,7 +4428,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4479,13 +4464,13 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
-
+
@@ -4525,7 +4510,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.

 
@@ -4547,7 +4532,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4581,10 +4566,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.

 
@@ -4611,7 +4596,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.

 
@@ -4643,7 +4628,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
 
 

-
getFile

+
getFile

 
Use this method to get basic info 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.

 
@@ -4663,8 +4648,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.

 
@@ -4702,8 +4687,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.

 
@@ -4734,7 +4719,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.

 
@@ -4772,7 +4757,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.

 
@@ -4800,7 +4785,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -4864,7 +4849,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.

 
@@ -4896,8 +4881,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.

 
@@ -4922,7 +4907,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.

 
@@ -4948,7 +4933,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.

 
@@ -4974,7 +4959,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.

 
@@ -4995,9 +4980,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.

 
@@ -5037,11 +5022,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.

 
@@ -5087,11 +5072,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.

 
@@ -5117,7 +5102,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.

 
@@ -5143,7 +5128,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.

 
@@ -5169,8 +5154,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.

 
@@ -5195,8 +5180,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.

 
@@ -5215,8 +5200,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.

 
@@ -5241,7 +5226,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.

 
@@ -5267,8 +5252,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.

 
@@ -5299,8 +5284,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.

 
@@ -5325,8 +5310,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.

 
@@ -5345,7 +5330,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.

 
@@ -5365,7 +5350,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.

 
@@ -5385,7 +5370,7 @@ pre-formatted fixed-width code block written in the Python programming language
 

 
 
 

-
getChatAdministrators

+
getChatAdministrators

 
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.

 
@@ -5405,7 +5390,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.

 
@@ -5425,7 +5410,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. Returns a ChatMember object on success.

 
@@ -5451,7 +5436,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.

 
@@ -5477,7 +5462,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.

 
@@ -5497,7 +5482,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.

@@ -5534,7 +5519,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
@@ -5544,8 +5529,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 https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

+
setMyCommands

+
Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.

 
@@ -5560,7 +5545,7 @@ pre-formatted fixed-width code block written in the Python programming language
 
-
+
@@ -5576,8 +5561,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.

 
@@ -5602,8 +5587,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 Array of BotCommand on success. 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 Array of BotCommand on success. If commands aren't set, an empty list is returned.

 
@@ -5628,12 +5613,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.

 
@@ -5695,7 +5680,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.

 
@@ -5751,8 +5736,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.

 
@@ -5795,7 +5780,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.

 
@@ -5833,7 +5818,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.

 
@@ -5865,18 +5850,8 @@ 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.
    • 
-
  • 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.
- 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.

 
@@ -5901,9 +5876,9 @@ Returns True on success.

 
 

 

 
 

-
Stickers

+
Stickers

 
The following methods and objects allow your bot to handle stickers and sticker sets.

-
Sticker

+
Sticker

 
This object represents a sticker.

 
@@ -5922,7 +5897,7 @@ Returns True on success.
-
+
@@ -5971,7 +5946,7 @@ Returns True on success.

 
 

 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
 

 
 

-
StickerSet

+
StickerSet

 
This object represents a sticker set.

 
@@ -6019,7 +5994,7 @@ Returns True on success.

 
 
 
 

-
MaskPosition

+
MaskPosition

 
This object describes the position on faces where a mask should be placed by default.

 
@@ -6033,7 +6008,7 @@ Returns True on success.
-
+
@@ -6052,7 +6027,7 @@ Returns True on success.

 
 

 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
 

 
 

-
sendSticker

+
sendSticker

 
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

 
@@ -6108,7 +6083,7 @@ Returns True on success.

 
 
 
 

-
getStickerSet

+
getStickerSet

 
Use this method to get a sticker set. On success, a StickerSet object is returned.

 
@@ -6128,7 +6103,7 @@ Returns True on success.

 
 
 
 

-
uploadStickerFile

+
uploadStickerFile

 
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.

 
@@ -6154,7 +6129,7 @@ Returns True on success.

 
 
 
 

-
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. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.

 
@@ -6176,7 +6151,7 @@ Returns True on success.
-
+
@@ -6194,13 +6169,13 @@ Returns True on success.
-
+
-
+
@@ -6222,7 +6197,7 @@ Returns True on success.

 
 
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.
 

 

 title
 tgs_sticker
 InputFile
 OptionalTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirementsTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements
 

 

 webm_sticker
 InputFile
 OptionalWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirementsWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements
 

 

 emojis
 

 
 

-
addStickerToSet

+
addStickerToSet

 
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.

 
@@ -6256,13 +6231,13 @@ Returns True on success.
-
+
-
+
@@ -6278,7 +6253,7 @@ Returns True on success.

 
 
tgs_sticker
 InputFile
 OptionalTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirementsTGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements
 

 

 webm_sticker
 InputFile
 OptionalWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirementsWEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements
 

 

 emojis
 

 
 

-
setStickerPositionInSet

+
setStickerPositionInSet

 
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

 
@@ -6304,7 +6279,7 @@ Returns True on success.

 
 
 
 

-
deleteStickerFromSet

+
deleteStickerFromSet

 
Use this method to delete a sticker from a set created by the bot. Returns True on success.

 
@@ -6324,7 +6299,7 @@ Returns True on success.

 
 
 
 

-
setStickerSetThumb

+
setStickerSetThumb

 
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.

 
@@ -6352,15 +6327,14 @@ Returns True on success.
-
+

 
 
thumb
 InputFile or String
 OptionalA PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.
 

 
 

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

 
@@ -6394,7 +6368,7 @@ Please see our Introduction to Inline bots for more d
 
-
+
@@ -6403,9 +6377,8 @@ Please see our Introduction to Inline bots for more d
 

 

 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.

 
@@ -6444,7 +6417,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6456,11 +6429,11 @@ No more than 50 results per query are allowed.

-
+

 
 

 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.
 

 

 switch_pm_text
 switch_pm_parameter
 String
 OptionalDeep-linking parameter for the /start message sent to the bot when user presses the switch 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.		Deep-linking parameter for the /start message sent to the bot when user presses the switch 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.

 
@@ -6529,7 +6502,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6553,7 +6526,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -6631,7 +6604,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -6680,7 +6653,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6714,7 +6687,7 @@ No more than 50 results per query are allowed.

 
 

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

 
@@ -6763,7 +6736,7 @@ No more than 50 results per query are allowed.

-
+
@@ -6797,7 +6770,7 @@ No more than 50 results per query are allowed.

 
 

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

@@ -6829,7 +6802,7 @@ No more than 50 results per query are allowed.

 
 mime_type
 String
-Mime type of the content of video url, "text/html" or "video/mp4"
+Mime type of the content of video url, “text/html” or “video/mp4”
 
 
 thumb_url
@@ -6888,7 +6861,7 @@ No more than 50 results per query are allowed.

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

 
@@ -6957,7 +6930,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7021,7 +6994,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7070,7 +7043,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7105,7 +7078,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7189,7 +7162,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7238,7 +7211,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7278,7 +7251,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7302,17 +7275,17 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
@@ -7347,7 +7320,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7381,7 +7354,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7444,7 +7417,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7502,7 +7475,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7560,7 +7533,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7599,7 +7572,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7663,7 +7636,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7726,7 +7699,7 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -7785,7 +7758,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7839,7 +7812,7 @@ No more than 50 results per query are allowed.

 
 
 

 
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.

 
@@ -7881,7 +7854,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
InputLocationMessageContent

+
InputLocationMessageContent

 
Represents the content of a location message to be sent as the result of an inline query.

 
@@ -7924,7 +7897,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
InputVenueMessageContent

+
InputVenueMessageContent

 
Represents the content of a venue message to be sent as the result of an inline query.

 
@@ -7963,7 +7936,7 @@ No more than 50 results per query are allowed.

-
+
@@ -7977,7 +7950,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -7991,17 +7964,17 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
@@ -8010,7 +7983,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -8089,32 +8062,32 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
@@ -8123,7 +8096,7 @@ No more than 50 results per query are allowed.

 
 

 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 user's phone number should be sent to providerOptional. Pass True, if user's phone number should be sent to provider
 

 

 send_email_to_provider
 BooleanOptional. Pass True, if user's email address should be sent to providerOptional. Pass True, if 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.

 
@@ -8162,9 +8135,9 @@ No more than 50 results per query are allowed.

 
 
 

 
Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.

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

 
@@ -8270,37 +8243,37 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
@@ -8336,11 +8309,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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 user's phone number should be sent to providerPass True, if user's phone number should be sent to provider
 

 

 send_email_to_provider
 Boolean
 OptionalPass True, if user's email address should be sent to providerPass True, if user's email address should be sent to provider
 

 

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

 
 

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

 
@@ -8374,11 +8347,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -8406,11 +8379,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -8433,7 +8406,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
Invoice

+
Invoice

 
This object contains basic information about an invoice.

 
@@ -8471,7 +8444,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
ShippingAddress

+
ShippingAddress

 
This object represents a shipping address.

 
@@ -8514,7 +8487,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
OrderInfo

+
OrderInfo

 
This object represents information about an order.

 
@@ -8533,7 +8506,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8547,7 +8520,7 @@ No more than 50 results per query are allowed.

 
 

 phone_number
 StringOptional. User's phone numberOptional. User's phone number
 

 

 email
 

 
 

-
ShippingOption

+
ShippingOption

 
This object represents one shipping option.

 
@@ -8575,7 +8548,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
SuccessfulPayment

+
SuccessfulPayment

 
This object contains basic information about a successful payment.

 
@@ -8623,7 +8596,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
ShippingQuery

+
ShippingQuery

 
This object contains information about an incoming shipping query.

 
@@ -8656,7 +8629,7 @@ No more than 50 results per query are allowed.

 
 
 
 

-
PreCheckoutQuery

+
PreCheckoutQuery

 
This object contains information about an incoming pre-checkout query.

 
@@ -8704,9 +8677,9 @@ No more than 50 results per query are allowed.

 
 
 
 

-
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

 
Contains information about Telegram Passport data shared with the bot by the user.

 
@@ -8729,8 +8702,8 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -8748,7 +8721,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8762,7 +8735,7 @@ No more than 50 results per query are allowed.

 
 

 

 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

 
Contains information about documents or other Telegram Passport elements shared with the bot by the user.

 
@@ -8776,47 +8749,47 @@ No more than 50 results per query are allowed.

-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -8825,7 +8798,7 @@ No more than 50 results per query are allowed.

 
 

 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

 
Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

 
@@ -8839,7 +8812,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8849,13 +8822,13 @@ No more than 50 results per query are allowed.

-
+

 
 

 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.

 
@@ -8880,7 +8853,7 @@ No more than 50 results per query are allowed.

 
 

 

 
 

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

 
@@ -8912,7 +8885,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8931,7 +8904,7 @@ No more than 50 results per query are allowed.

 
 

 

 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.

 
@@ -8950,7 +8923,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8964,7 +8937,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -8983,7 +8956,7 @@ No more than 50 results per query are allowed.

-
+
@@ -8997,7 +8970,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9016,7 +8989,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9030,7 +9003,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9049,7 +9022,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9063,7 +9036,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9082,7 +9055,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9096,7 +9069,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9115,7 +9088,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9129,7 +9102,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9148,7 +9121,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9162,7 +9135,7 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9181,7 +9154,7 @@ No more than 50 results per query are allowed.

-
+
@@ -9195,20 +9168,20 @@ No more than 50 results per query are allowed.

 
 

 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.

 
@@ -9260,11 +9233,11 @@ No more than 50 results per query are allowed.

-
+

 
 
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.

 
@@ -9307,10 +9280,10 @@ No more than 50 results per query are allowed.

 
 
 
 

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

 
@@ -9365,7 +9338,7 @@ No more than 50 results per query are allowed.

 
 

 

 
 

-
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. On success, 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 his neighbors are not among them. Please note that this behavior is subject to change.

@@ -9406,7 +9379,7 @@ No more than 50 results per query are allowed.

 
 
 
-
GameHighScore

+
GameHighScore

 
This object represents one row of the high scores table for a game.

 
@@ -9435,8 +9408,8 @@ No more than 50 results per query are allowed.

 
 
 

 

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

+