--The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.
+
To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram. +To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.
Recent changes
+Recent changes
-Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk
April 21, 2023
+April 21, 2023
Bot API 6.7
- Added support for launching Web Apps from inline query results by replacing the parameters switch_pm_text and switch_pm_parameter of the method answerInlineQuery with the parameter button of type InlineQueryResultsButton. @@ -62,10 +63,10 @@ To learn how to create…">
- Added the field via_chat_folder_invite_link to the class ChatMemberUpdated.
- Added the ability to set different bot names for different user languages using the method setMyName.
- Added the ability to get the current bot name in the given language as the class BotName using the method getMyName. -
- Added the ability to change bot settings from the bot's profile in official Telegram apps, including the ability to set animated profile photos. +
- Added the ability to change bot settings from the bot's profile in official Telegram apps, including the ability to set animated profile photos.
- Added the ability to specify custom emoji entities using HTML and MarkdownV2 formatting options for bots that purchased additional usernames on Fragment.
March 9, 2023
+March 9, 2023
Bot API 6.6
- Added the ability to set different bot descriptions for different user languages using the method setMyDescription. @@ -94,7 +95,7 @@ To learn how to create…">
- Renamed the field thumb_url in the classes InlineQueryResultPhoto and InlineQueryResultVideo to thumbnail_url.
- Renamed the fields thumb_url and thumb_mime_type in the classes InlineQueryResultGif, and InlineQueryResultMpeg4Gif to thumbnail_url and thumbnail_mime_type respectively.
February 3, 2023
+February 3, 2023
Bot API 6.5
- Added requests for users and chats and support for granular media permissions. @@ -106,9 +107,9 @@ To learn how to create…">
- Added the field user_chat_id to the class ChatJoinRequest.
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/getMeWe support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:
@@ -118,17 +119,17 @@ To learn how to create…">The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
+The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.
- 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. @@ -140,13 +141,14 @@ To learn how to create…">
- Set max_webhook_connections up to 100000.
- Receive the absolute local path as a value of the file_path field without the need to download the file after a 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.
| update_id | Integer | -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. | +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 | @@ -219,12 +221,12 @@ To learn how to create…">|||
| my_chat_member | ChatMemberUpdated | -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. | +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 | ChatMemberUpdated | -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. | +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 | @@ -233,7 +235,7 @@ To learn how to create…">
getUpdates
+getUpdates
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
| allowed_updates | Array of String | Optional | -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. |
+A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used. Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. |
--Notes
+
1. This method will not work if an outgoing webhook is set up.
2. In order to avoid getting duplicate updates, recalculate offset after each server response.Notes +1. This method will not work if an outgoing webhook is set up. +2. In order to avoid getting duplicate updates, recalculate offset after each server response.
setWebhook
+setWebhook
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
-If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
+If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.
| max_connections | Integer | Optional | -The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | +The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | |
| allowed_updates | Array of String | Optional | -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. |
+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 | @@ -327,15 +331,20 @@ To learn how to create…">secret_token | String | Optional | -A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. |
+A secret token to be sent in a header "X-Telegram-Bot-Api-Secret-Token" in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. |
--Notes
-
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for webhooks: 443, 80, 88, 8443.If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.
+Notes +1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. +2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work. +3. Ports currently supported for webhooks: 443, 80, 88, 8443.
deleteWebhook
+++If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.
+
deleteWebhook
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
getWebhookInfo
+getWebhookInfo
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
-WebhookInfo
+WebhookInfo
Describes the current status of a webhook.
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.
| first_name | String | -User's or bot's first name | +User's or bot's first name |
| last_name | String | -Optional. User's or bot's last name | +Optional. User's or bot's last name |
| username | String | -Optional. User's or bot's username | +Optional. User's or bot's username |
| language_code | String | -Optional. IETF language tag of the user's language | +Optional. IETF language tag of the user's language |
| is_premium | @@ -489,7 +498,7 @@ To learn how to create…">
Chat
+Chat
This object represents a chat.
| type | String | -Type of chat, can be either “private”, “group”, “supergroup” or “channel” | +Type of chat, can be either "private", "group", "supergroup" or "channel" |
| title | @@ -618,7 +627,7 @@ To learn how to create…">|||
| has_protected_content | True | -Optional. 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 | @@ -642,7 +651,7 @@ To learn how to create…">
Message
+Message
This object represents a message.
| forward_sender_name | String | -Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages | +Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages |
| forward_date | @@ -741,7 +750,7 @@ To learn how to create…">|||
| has_protected_content | True | -Optional. True, if the message can't be forwarded | +Optional. True, if the message can't be forwarded |
| media_group_id | @@ -881,12 +890,12 @@ To learn how to create…">|||
| supergroup_chat_created | True | -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. | +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 | True | -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. | +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 | @@ -946,7 +955,7 @@ To learn how to create…">|||
| proximity_alert_triggered | ProximityAlertTriggered | -Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. | +Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. |
| forum_topic_created | @@ -971,12 +980,12 @@ To learn how to create…">|||
| general_forum_topic_hidden | GeneralForumTopicHidden | -Optional. Service message: the 'General' forum topic hidden | +Optional. Service message: the 'General' forum topic hidden |
| general_forum_topic_unhidden | GeneralForumTopicUnhidden | -Optional. Service message: the 'General' forum topic unhidden | +Optional. Service message: the 'General' forum topic unhidden |
| video_chat_scheduled | @@ -1010,7 +1019,7 @@ To learn how to create…">
MessageId
+MessageId
This object represents a unique message identifier.
MessageEntity
+MessageEntity
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
| type | String | -Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) |
+Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag), "cashtag" ($USD), "bot_command" (/start@jobs_bot), "url" (https://telegram.org), "email" (do-not-reply@telegram.org), "phone_number" (+1-212-555-0123), "bold" (bold text), "italic" (italic text), "underline" (underlined text), "strikethrough" (strikethrough text), "spoiler" (spoiler message), "code" (monowidth string), "pre" (monowidth block), "text_link" (for clickable text URLs), "text_mention" (for users without usernames), "custom_emoji" (for inline custom emoji stickers) |
| offset | @@ -1057,26 +1066,26 @@ To learn how to create…">|||
| url | String | -Optional. For “text_link” only, URL that will be opened after user taps on the text | +Optional. For "text_link" only, URL that will be opened after user taps on the text |
| user | User | -Optional. For “text_mention” only, the mentioned user | +Optional. For "text_mention" only, the mentioned user |
| language | String | -Optional. For “pre” only, the programming language of the entity text | +Optional. For "pre" only, the programming language of the entity text |
| custom_emoji_id | String | -Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker | +Optional. For "custom_emoji" only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker |
PhotoSize
+PhotoSize
This object represents one size of a photo or a file / sticker thumbnail.
| 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. |
| width | @@ -1114,7 +1123,7 @@ To learn how to create…">
Animation
+Animation
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
| 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. |
| width | @@ -1172,7 +1181,7 @@ To learn how to create…">
Audio
+Audio
This object represents an audio file to be treated as music by the Telegram clients.
| 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. |
| duration | @@ -1230,7 +1239,7 @@ To learn how to create…">
Document
+Document
This object represents a general file (as opposed to photos, voice messages and audio files).
| 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. |
| thumbnail | @@ -1273,7 +1282,7 @@ To learn how to create…">
Video
+Video
This object represents a video file.
| 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. |
| width | @@ -1331,7 +1340,7 @@ To learn how to create…">
VideoNote
+VideoNote
This object represents a video message (available in Telegram apps as of v.4.0).
| 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. |
| length | @@ -1374,7 +1383,7 @@ To learn how to create…">
Voice
+Voice
This object represents a voice note.
| 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. |
| duration | @@ -1412,7 +1421,7 @@ To learn how to create…">
Contact
+Contact
This object represents a phone contact.
| phone_number | String | -Contact's phone number | +Contact's phone number |
| first_name | String | -Contact's first name | +Contact's first name |
| last_name | String | -Optional. Contact's last name | +Optional. Contact's last name |
| user_id | Integer | -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. | +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 | @@ -1450,7 +1459,7 @@ To learn how to create…">
Dice
+Dice
This object represents an animated emoji that displays a random value.
| value | Integer | -Value of the dice, 1-6 for “ ”, “ ” and “ ” base emoji, 1-5 for “ ” and “ ” base emoji, 1-64 for “ ” base emoji |
+Value 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.
PollAnswer
+PollAnswer
This object represents an answer of a user in a non-anonymous poll.
Poll
+Poll
This object contains information about a poll.
| type | String | -Poll type, currently can be “regular” or “quiz” | +Poll type, currently can be "regular" or "quiz" |
| allows_multiple_answers | @@ -1602,7 +1611,7 @@ To learn how to create…">
Location
+Location
This object represents a point on the map.
Venue
+Venue
This object represents a venue.
| location | Location | -Venue location. Can't be a live location | +Venue location. Can't be a live location |
| title | @@ -1679,7 +1688,7 @@ To learn how to create…">|||
| foursquare_type | String | -Optional. 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 | @@ -1693,7 +1702,7 @@ To learn how to create…">
WebAppData
+WebAppData
Describes data sent from a Web App to the bot.
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.
MessageAutoDeleteTimerChanged
+MessageAutoDeleteTimerChanged
This object represents a service message about a change in auto-delete timer settings.
ForumTopicCreated
+ForumTopicCreated
This object represents a service message about a new forum topic created in the chat.
ForumTopicClosed
+ForumTopicClosed
This object represents a service message about a forum topic closed in the chat. Currently holds no information.
-ForumTopicEdited
+ForumTopicEdited
This object represents a service message about an edited forum topic.
ForumTopicReopened
+ForumTopicReopened
This object represents a service message about a forum topic reopened in the chat. Currently holds no information.
-GeneralForumTopicHidden
+GeneralForumTopicHidden
This object represents a service message about General forum topic hidden in the chat. Currently holds no information.
-GeneralForumTopicUnhidden
+GeneralForumTopicUnhidden
This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.
-UserShared
+UserShared
This object contains information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button.
ChatShared
+ChatShared
This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
WriteAccessAllowed
+WriteAccessAllowed
This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.
VideoChatScheduled
+VideoChatScheduled
This object represents a service message about a video chat scheduled in the chat.
VideoChatStarted
+VideoChatStarted
This object represents a service message about a video chat started in the chat. Currently holds no information.
-VideoChatEnded
+VideoChatEnded
This object represents a service message about a video chat ended in the chat.
VideoChatParticipantsInvited
+VideoChatParticipantsInvited
This object represents a service message about new members invited to a video chat.
UserProfilePhotos
-This object represent a user's profile pictures.
+UserProfilePhotos
+This object represent a user's profile pictures.
File
+File
This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.
The maximum file size to download is 20 MB
@@ -1986,7 +1995,7 @@ To learn how to create…">file_unique_id String -Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. +Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. - file_size @@ -2000,7 +2009,7 @@ To learn how to create…">WebAppInfo
+WebAppInfo
Describes a Web App.
@@ -2018,7 +2027,7 @@ To learn how to create…">
-ReplyKeyboardMarkup
+ReplyKeyboardMarkup
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
@@ -2042,12 +2051,12 @@ To learn how to create…">
-resize_keyboard Boolean -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. +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 Boolean -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. +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 @@ -2057,11 +2066,11 @@ To learn how to create…">selective Boolean -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.Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.KeyboardButton
+KeyboardButton
This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_user, request_chat, request_contact, request_location, and request_poll are mutually exclusive.
@@ -2080,22 +2089,22 @@ To learn how to create…">
-request_user KeyboardButtonRequestUser -Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a “user_shared” service message. Available in private chats only. +Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send their identifier to the bot in a "user_shared" service message. Available in private chats only. request_chat KeyboardButtonRequestChat -Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only. +Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a "chat_shared" service message. Available in private chats only. request_contact Boolean -Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. +Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. request_location Boolean -Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only. +Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only. request_poll @@ -2105,12 +2114,15 @@ To learn how to create…">web_app WebAppInfo -Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only. +Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a "web_app_data" service message. Available in private chats only. Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
-
Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.
Note: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message.
Note: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.KeyboardButtonRequestUser
+Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. +Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message. +Note: web_app option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message. +Note: request_user and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.
+KeyboardButtonRequestUser
This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More about requesting users »
@@ -2138,7 +2150,7 @@ To learn how to create…">
-KeyboardButtonRequestChat
+KeyboardButtonRequestChat
This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats »
@@ -2191,7 +2203,7 @@ To learn how to create…">
-KeyboardButtonPollType
+KeyboardButtonPollType
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
@@ -2209,7 +2221,7 @@ To learn how to create…">
-ReplyKeyboardRemove
+ReplyKeyboardRemove
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).
@@ -2228,11 +2240,11 @@ To learn how to create…">
-selective Boolean -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.Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.InlineKeyboardMarkup
+InlineKeyboardMarkup
This object represents an inline keyboard that appears right next to the message it belongs to.
@@ -2251,7 +2263,7 @@ To learn how to create…">
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.
-InlineKeyboardButton
+InlineKeyboardButton
This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
@@ -2290,17 +2302,17 @@ To learn how to create…">
-switch_inline_query String -Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. +Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. switch_inline_query_current_chat String -Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. +
This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.
This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.switch_inline_query_chosen_chat SwitchInlineQueryChosenChat -Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field +Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field callback_game @@ -2314,12 +2326,11 @@ To learn how to create…">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:
--+
Telegram apps support these buttons as of version 5.7.
Sample bot: @discussbot
@@ -2346,7 +2357,7 @@ To learn how to create…">bot_username String -Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details. +Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details. - request_write_access @@ -2355,7 +2366,7 @@ To learn how to create…">SwitchInlineQueryChosenChat
+SwitchInlineQueryChosenChat
This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
@@ -2369,7 +2380,7 @@ To learn how to create…">
-query String -Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted +Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted allow_user_chats @@ -2393,7 +2404,7 @@ To learn how to create…">CallbackQuery
+CallbackQuery
This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.
@@ -2444,8 +2455,8 @@ To learn how to create…">
--NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).
ForceReply
-Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
+ForceReply
+Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
@@ -2476,11 +2487,11 @@ To learn how to create…">
@@ -2458,7 +2469,7 @@ To learn how to create…"> force_reply True -Shows 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 @@ -2468,7 +2479,7 @@ To learn how to create…">selective Boolean -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. +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. Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
-
- Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
-- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
+- Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
+The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user.
-ChatPhoto
+ChatPhoto
This object represents a chat photo.
@@ -2499,7 +2510,7 @@ To learn how to create…">
-small_file_unique_id String -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. +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 @@ -2509,11 +2520,11 @@ To learn how to create…">big_file_unique_id String -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. +Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. ChatInviteLink
+ChatInviteLink
Represents an invite link for a chat.
@@ -2527,7 +2538,7 @@ To learn how to create…">
-invite_link String -The 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 @@ -2571,7 +2582,7 @@ To learn how to create…">ChatAdministratorRights
+ChatAdministratorRights
Represents the rights of an administrator in a chat.
@@ -2585,7 +2596,7 @@ To learn how to create…">
-is_anonymous Boolean -True, if the user's presence in the chat is hidden +True, if the user's presence in the chat is hidden can_manage_chat @@ -2644,7 +2655,7 @@ To learn how to create…">ChatMember
+ChatMember
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
-
- ChatMemberOwner
@@ -2654,7 +2665,7 @@ To learn how to create…">- ChatMemberLeft
- ChatMemberBanned
ChatMemberOwner
+ChatMemberOwner
Represents a chat member that owns the chat and has all administrator privileges.
@@ -2668,7 +2679,7 @@ To learn how to create…">
-status String -The member's status in the chat, always “creator” +The member's status in the chat, always "creator" user @@ -2678,7 +2689,7 @@ To learn how to create…">is_anonymous Boolean -True, if the user's presence in the chat is hidden +True, if the user's presence in the chat is hidden custom_title @@ -2687,7 +2698,7 @@ To learn how to create…">ChatMemberAdministrator
+ChatMemberAdministrator
Represents a chat member that has some additional privileges.
@@ -2701,7 +2712,7 @@ To learn how to create…">
-status String -The member's status in the chat, always “administrator” +The member's status in the chat, always "administrator" user @@ -2716,7 +2727,7 @@ To learn how to create…">is_anonymous Boolean -True, if the user's presence in the chat is hidden +True, if the user's presence in the chat is hidden can_manage_chat @@ -2780,7 +2791,7 @@ To learn how to create…">ChatMemberMember
+ChatMemberMember
Represents a chat member that has no additional privileges or restrictions.
@@ -2794,7 +2805,7 @@ To learn how to create…">
-status String -The member's status in the chat, always “member” +The member's status in the chat, always "member" user @@ -2803,7 +2814,7 @@ To learn how to create…">ChatMemberRestricted
+ChatMemberRestricted
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
@@ -2817,7 +2828,7 @@ To learn how to create…">
-status String -The member's status in the chat, always “restricted” +The member's status in the chat, always "restricted" user @@ -2906,8 +2917,8 @@ To learn how to create…">ChatMemberLeft
-Represents a chat member that isn't currently a member of the chat, but may join it themselves.
+ChatMemberLeft
+Represents a chat member that isn't currently a member of the chat, but may join it themselves.
-
@@ -2920,7 +2931,7 @@ To learn how to create…"> status String -The member's status in the chat, always “left” +The member's status in the chat, always "left" user @@ -2929,8 +2940,8 @@ To learn how to create…">ChatMemberBanned
-Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
+ChatMemberBanned
+Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
-
@@ -2943,7 +2954,7 @@ To learn how to create…"> status String -The member's status in the chat, always “kicked” +The member's status in the chat, always "kicked" user @@ -2957,7 +2968,7 @@ To learn how to create…">ChatMemberUpdated
+ChatMemberUpdated
This object represents changes in the status of a chat member.
@@ -3005,7 +3016,7 @@ To learn how to create…">
-ChatJoinRequest
+ChatJoinRequest
Represents a join request sent to a chat.
@@ -3048,7 +3059,7 @@ To learn how to create…">
-ChatPermissions
+ChatPermissions
Describes actions that a non-administrator user is allowed to take in a chat.
@@ -3131,7 +3142,7 @@ To learn how to create…">
-ChatLocation
+ChatLocation
Represents a location to which a chat is connected.
@@ -3145,7 +3156,7 @@ To learn how to create…">
-location Location -The 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 @@ -3154,7 +3165,7 @@ To learn how to create…">ForumTopic
+ForumTopic
This object represents a forum topic.
@@ -3187,7 +3198,7 @@ To learn how to create…">
-BotCommand
+BotCommand
This object represents a bot command.
@@ -3210,7 +3221,7 @@ To learn how to create…">
-BotCommandScope
+BotCommandScope
This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:
-
- BotCommandScopeDefault
@@ -3221,7 +3232,7 @@ To learn how to create…">- BotCommandScopeChatAdministrators
- BotCommandScopeChatMember
Determining list of commands
+Determining list of commands
The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:
Commands in the chat with the bot
@@ -3247,7 +3258,7 @@ To learn how to create…">
-- botCommandScopeDefault + language_code
- botCommandScopeDefault
BotCommandScopeDefault
+BotCommandScopeDefault
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
@@ -3265,7 +3276,7 @@ To learn how to create…">
-BotCommandScopeAllPrivateChats
+BotCommandScopeAllPrivateChats
Represents the scope of bot commands, covering all private chats.
@@ -3283,7 +3294,7 @@ To learn how to create…">
-BotCommandScopeAllGroupChats
+BotCommandScopeAllGroupChats
Represents the scope of bot commands, covering all group and supergroup chats.
@@ -3301,7 +3312,7 @@ To learn how to create…">
-BotCommandScopeAllChatAdministrators
+BotCommandScopeAllChatAdministrators
Represents the scope of bot commands, covering all group and supergroup chat administrators.
@@ -3319,7 +3330,7 @@ To learn how to create…">
-BotCommandScopeChat
+BotCommandScopeChat
Represents the scope of bot commands, covering a specific chat.
@@ -3342,7 +3353,7 @@ To learn how to create…">
-BotCommandScopeChatAdministrators
+BotCommandScopeChatAdministrators
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
@@ -3365,7 +3376,7 @@ To learn how to create…">
-BotCommandScopeChatMember
+BotCommandScopeChatMember
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
@@ -3393,8 +3404,8 @@ To learn how to create…">
-BotName
-This object represents the bot's name.
+BotName
+This object represents the bot's name.
-
@@ -3407,12 +3418,12 @@ To learn how to create…"> name String -The bot's name +The bot's name BotDescription
-This object represents the bot's description.
+BotDescription
+This object represents the bot's description.
-
@@ -3425,12 +3436,12 @@ To learn how to create…"> description String -The bot's description +The bot's description BotShortDescription
-This object represents the bot's short description.
+BotShortDescription
+This object represents the bot's short description.
-
@@ -3443,20 +3454,20 @@ To learn how to create…"> short_description String -The bot's short description +The bot's short description MenuButton
-This object describes the bot's menu button in a private chat. It should be one of
+MenuButton
+This object describes the bot's menu button in a private chat. It should be one of
If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.
-MenuButtonCommands
-Represents a menu button, which opens the bot's list of commands.
+MenuButtonCommands
+Represents a menu button, which opens the bot's list of commands.
-
@@ -3473,7 +3484,7 @@ To learn how to create…"> MenuButtonWebApp
+MenuButtonWebApp
Represents a menu button, which launches a Web App.
@@ -3501,7 +3512,7 @@ To learn how to create…">
-MenuButtonDefault
+MenuButtonDefault
Describes that no specific value for the menu button was set.
@@ -3519,7 +3530,7 @@ To learn how to create…">
-ResponseParameters
+ResponseParameters
Describes why a request was unsuccessful.
@@ -3542,7 +3553,7 @@ To learn how to create…">
-InputMedia
+InputMedia
This object represents the content of a media message to be sent. It should be one of
-
- InputMediaAnimation
@@ -3551,7 +3562,7 @@ To learn how to create…">- InputMediaPhoto
- InputMediaVideo
InputMediaPhoto
+InputMediaPhoto
Represents a photo to be sent.
@@ -3570,7 +3581,7 @@ To learn how to create…">
-media String -File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » +File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » caption @@ -3594,7 +3605,7 @@ To learn how to create…">InputMediaVideo
+InputMediaVideo
Represents a video to be sent.
@@ -3613,12 +3624,12 @@ To learn how to create…">
-media String -File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » +File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » thumbnail InputFile or String -Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -3662,7 +3673,7 @@ To learn how to create…">InputMediaAnimation
+InputMediaAnimation
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
@@ -3681,12 +3692,12 @@ To learn how to create…">
-media String -File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » +File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » thumbnail InputFile or String -Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -3725,7 +3736,7 @@ To learn how to create…">InputMediaAudio
+InputMediaAudio
Represents an audio file to be treated as music to be sent.
@@ -3744,12 +3755,12 @@ To learn how to create…">
-media String -File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » +File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » thumbnail InputFile or String -Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -3783,7 +3794,7 @@ To learn how to create…">InputMediaDocument
+InputMediaDocument
Represents a general file to be sent.
@@ -3802,12 +3813,12 @@ To learn how to create…">
-media String -File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » +File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files » thumbnail InputFile or String -Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -3831,21 +3842,21 @@ To learn how to create…">InputFile
+InputFile
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
-Sending files
+Sending files
There are three ways to send files (photos, stickers, audio, media, etc.):
-
- 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.
+- 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.
- 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.
- Post the file using multipart/form-data in the usual way that files are uploaded via the browser. 10 MB max size for photos, 50 MB for other files.
Sending by file_id
-
- It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
+- It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
- It is not possible to resend thumbnails.
- Resending a photo by file_id will send all of its sizes.
-- file_id is unique for each individual bot and can't be transferred from one bot to another.
+- file_id is unique for each individual bot and can't be transferred from one bot to another.
- file_id uniquely identifies a file, but a file can have different valid file_ids even for the same bot.
Sending by URL
@@ -3853,21 +3864,22 @@ To learn how to create…">When sending by URL the target file must have the correct MIME type (e.g., audio/mpeg for sendAudio, etc.). In sendDocument, sending by URL will currently only work for GIF, PDF and ZIP files. To use sendVoice, the file must have the type audio/ogg and be no more than 1MB in size. 1-20MB voice notes will be sent as files. -Other configurations may work but we can't guarantee that they will. +Other configurations may work but we can't guarantee that they will. -Inline mode objects
+Inline mode objects
Objects and methods used in the inline mode are described in the Inline mode section.
-Available methods
+Available methods
--All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.
+
On successful call, a JSON-object containing the result will be returned.All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests. +On successful call, a JSON-object containing the result will be returned.
getMe
-A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
-logOut
+getMe
+A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
+logOut
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
-close
-Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
-sendMessage
+close
+Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
+sendMessage
Use this method to send text messages. On success, the sent Message is returned.
@@ -3947,16 +3959,21 @@ To learn how to create…">
-Formatting options
-The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, and spoiler text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting.
-Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).
-Message entities can be nested, providing following restrictions are met:
+
- If two entities have common characters, then one of them is fully contained inside another.
- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
- All other entities can't contain each other.Formatting options
+The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, and spoiler text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting.
+Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).
+Message entities can be nested, providing following restrictions are met:
++
- If two entities have common characters, then one of them is fully contained inside another.
+- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
+- All other entities can't contain each other.
+Links
tg://user?id=<user_id>can be used to mention a user by their ID without using a username. Please note:-
- These links will work only if they are used inside an inline link or in an inline keyboard button. For example, they will not work, when used in a message text.
-- Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
+- Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
MarkdownV2 style
+MarkdownV2 style
To use this mode, pass MarkdownV2 in the parse_mode field. Use the following syntax in your message:
*bold \*text* _italic \*text_ @@ -3976,28 +3993,28 @@ pre-formatted fixed-width code block written in the Python programming language ```Please note:
-
-- Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
-- Inside
-preandcodeentities, all '`' and '\' characters must be escaped with a preceding '\' character.- Inside the
-(...)part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.- In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
+- Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
+- Inside
+preandcodeentities, all '`' and '\' characters must be escaped with a preceding '\' character.- Inside the
+(...)part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.- In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
- In case of ambiguity between
italicandunderlineentities__is always greadily treated from left to right as beginning or end ofunderlineentity, so instead of___italic underline___use___italic underline_\r__, where\ris a character with code 13, which will be ignored.- A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
- Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
HTML style
+HTML style
To use this mode, pass HTML in the parse_mode field. The following tags are currently supported:
+<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre><b>bold</b>, <strong>bold</strong> <i>italic</i>, <em>italic</em> <u>underline</u>, <ins>underline</ins> <s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del> -<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler> -<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b> -<a href="http://www.example.com/">inline URL</a> -<a href="tg://user?id=123456789">inline mention of a user</a> -<tg-emoji emoji-id="5368324170671202286"></tg-emoji> +<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler> +<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b> +<a href="http://www.example.com/">inline URL</a> +<a href="tg://user?id=123456789">inline mention of a user</a> +<tg-emoji emoji-id="5368324170671202286">
Please note:
-
- Only the tags mentioned above are currently supported.
@@ -4005,11 +4022,11 @@ pre-formatted fixed-width code block written in the Python programming language- All numerical HTML entities are supported.
- The API currently supports only the following named HTML entities:
<,>,&and".- Use nested
-preandcodetags, to define programming language forpreentity.- Programming language can't be specified for standalone
+codetags.- Programming language can't be specified for standalone
codetags.- A valid emoji must be used as the content of the
tg-emojitag. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.- Custom emoji entities can only be used by bots that purchased additional usernames on Fragment.
Markdown style
+Markdown style
This is a legacy mode, retained for backward compatibility. To use this mode, pass Markdown in the parse_mode field. Use the following syntax in your message:
*bold text* _italic text_ @@ -4026,11 +4043,11 @@ pre-formatted fixed-width code block written in the Python programming language-
- Entities must not be nested, use parse mode MarkdownV2 instead.
- There is no way to specify underline and strikethrough entities, use parse mode MarkdownV2 instead.
-- To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
+- To escape characters '_', '*', '`', '[' outside of an entity, prepend the characters '\' before them.
- Escaping inside entities is not allowed, so entity must be closed first and reopened again: use
_snake_\__case_for italicsnake_caseand*2*\**2=4*for bold2*2=4.forwardMessage
-Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
+forwardMessage
+Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
-
@@ -4079,8 +4096,8 @@ pre-formatted fixed-width code block written in the Python programming language copyMessage
-Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+copyMessage
+Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
-
@@ -4165,7 +4182,7 @@ pre-formatted fixed-width code block written in the Python programming language sendPhoto
+sendPhoto
Use this method to send photos. On success, the sent Message is returned.
@@ -4193,7 +4210,7 @@ pre-formatted fixed-width code block written in the Python programming language
-photo InputFile or String Yes -Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » +Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » caption @@ -4251,7 +4268,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendAudio
+sendAudio
Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead.
@@ -4322,7 +4339,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » disable_notification @@ -4356,7 +4373,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendDocument
+sendDocument
Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
@@ -4390,7 +4407,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -4448,7 +4465,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendVideo
+sendVideo
Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
@@ -4500,7 +4517,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -4564,7 +4581,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendAnimation
+sendAnimation
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
@@ -4616,7 +4633,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » caption @@ -4674,7 +4691,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendVoice
+sendVoice
Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
@@ -4760,7 +4777,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sendVideoNote
+sendVideoNote
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
@@ -4806,7 +4823,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » +Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files » disable_notification @@ -4840,7 +4857,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendMediaGroup
+sendMediaGroup
Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
@@ -4896,7 +4913,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sendLocation
+sendLocation
Use this method to send point on the map. On success, the sent Message is returned.
@@ -4988,7 +5005,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sendVenue
+sendVenue
Use this method to send information about a venue. On success, the sent Message is returned.
@@ -5046,7 +5063,7 @@ pre-formatted fixed-width code block written in the Python programming language
-foursquare_type String Optional -Foursquare 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 @@ -5092,7 +5109,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendContact
+sendContact
Use this method to send phone contacts. On success, the sent Message is returned.
@@ -5120,19 +5137,19 @@ pre-formatted fixed-width code block written in the Python programming language
-phone_number String Yes -Contact's phone number +Contact's phone number first_name String Yes -Contact's first name +Contact's first name last_name String Optional -Contact's last name +Contact's last name vcard @@ -5172,7 +5189,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendPoll
+sendPoll
Use this method to send a native poll. On success, the sent Message is returned.
@@ -5218,7 +5235,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String Optional -Poll type, “quiz” or “regular”, defaults to “regular” +Poll type, "quiz" or "regular", defaults to "regular" allows_multiple_answers @@ -5254,13 +5271,13 @@ pre-formatted fixed-width code block written in the Python programming languageopen_period Integer Optional -Amount 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 Optional -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. +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 @@ -5300,7 +5317,7 @@ pre-formatted fixed-width code block written in the Python programming languagesendDice
+sendDice
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
@@ -5328,7 +5345,7 @@ pre-formatted fixed-width code block written in the Python programming language
-emoji String Optional -Emoji on which the dice throw animation is based. Currently, must be one of “ +”, “
”, “
”, “
”, “
”, or “
”. Dice can have values 1-6 for “
Emoji on which the dice throw animation is based. Currently, must be one of " disable_notification @@ -5362,10 +5379,10 @@ pre-formatted fixed-width code block written in the Python programming languagesendChatAction
-Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
+sendChatAction
+Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
-Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
+Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
@@ -5398,7 +5415,7 @@ pre-formatted fixed-width code block written in the Python programming language
-getUserProfilePhotos
+getUserProfilePhotos
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
@@ -5430,7 +5447,7 @@ pre-formatted fixed-width code block written in the Python programming language
-getFile
+getFile
Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link
https://api.telegram.org/file/bot<token>/<file_path>, where<file_path>is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.@@ -5450,8 +5467,8 @@ pre-formatted fixed-width code block written in the Python programming language
-Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
-banChatMember
+Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
+banChatMember
Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
@@ -5489,8 +5506,8 @@ pre-formatted fixed-width code block written in the Python programming language
-unbanChatMember
-Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
+unbanChatMember
+Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
-
@@ -5521,7 +5538,7 @@ pre-formatted fixed-width code block written in the Python programming language restrictChatMember
+restrictChatMember
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
@@ -5565,7 +5582,7 @@ pre-formatted fixed-width code block written in the Python programming language
-promoteChatMember
+promoteChatMember
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
@@ -5593,7 +5610,7 @@ pre-formatted fixed-width code block written in the Python programming language
-is_anonymous Boolean Optional -Pass True if the administrator's presence in the chat is hidden +Pass True if the administrator's presence in the chat is hidden can_manage_chat @@ -5663,7 +5680,7 @@ pre-formatted fixed-width code block written in the Python programming languagesetChatAdministratorCustomTitle
+setChatAdministratorCustomTitle
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
@@ -5695,8 +5712,8 @@ pre-formatted fixed-width code block written in the Python programming language
-banChatSenderChat
-Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
+banChatSenderChat
+Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
-
@@ -5721,7 +5738,7 @@ pre-formatted fixed-width code block written in the Python programming language unbanChatSenderChat
+unbanChatSenderChat
Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
@@ -5747,7 +5764,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setChatPermissions
+setChatPermissions
Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
@@ -5779,7 +5796,7 @@ pre-formatted fixed-width code block written in the Python programming language
-exportChatInviteLink
+exportChatInviteLink
Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
@@ -5800,9 +5817,9 @@ pre-formatted fixed-width code block written in the Python programming language
--Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.
+Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.
createChatInviteLink
+createChatInviteLink
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
@@ -5842,11 +5859,11 @@ pre-formatted fixed-width code block written in the Python programming language
-creates_join_request Boolean Optional -True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified +True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified editChatInviteLink
+editChatInviteLink
Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
@@ -5892,11 +5909,11 @@ pre-formatted fixed-width code block written in the Python programming language
-creates_join_request Boolean Optional -True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified +True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified revokeChatInviteLink
+revokeChatInviteLink
Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
@@ -5922,7 +5939,7 @@ pre-formatted fixed-width code block written in the Python programming language
-approveChatJoinRequest
+approveChatJoinRequest
Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
@@ -5948,7 +5965,7 @@ pre-formatted fixed-width code block written in the Python programming language
-declineChatJoinRequest
+declineChatJoinRequest
Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
@@ -5974,8 +5991,8 @@ pre-formatted fixed-width code block written in the Python programming language
-setChatPhoto
-Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
+setChatPhoto
+Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
-
@@ -6000,8 +6017,8 @@ pre-formatted fixed-width code block written in the Python programming language deleteChatPhoto
-Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
+deleteChatPhoto
+Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
-
@@ -6020,8 +6037,8 @@ pre-formatted fixed-width code block written in the Python programming language setChatTitle
-Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
+setChatTitle
+Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
-
@@ -6046,7 +6063,7 @@ pre-formatted fixed-width code block written in the Python programming language setChatDescription
+setChatDescription
Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
@@ -6072,8 +6089,8 @@ pre-formatted fixed-width code block written in the Python programming language
-pinChatMessage
-Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
+pinChatMessage
+Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
-
@@ -6104,8 +6121,8 @@ pre-formatted fixed-width code block written in the Python programming language unpinChatMessage
-Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
+unpinChatMessage
+Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
-
@@ -6130,8 +6147,8 @@ pre-formatted fixed-width code block written in the Python programming language unpinAllChatMessages
-Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
+unpinAllChatMessages
+Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
-
@@ -6150,7 +6167,7 @@ pre-formatted fixed-width code block written in the Python programming language leaveChat
+leaveChat
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
@@ -6170,7 +6187,7 @@ pre-formatted fixed-width code block written in the Python programming language
-getChat
+getChat
Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
@@ -6190,8 +6207,8 @@ pre-formatted fixed-width code block written in the Python programming language
-getChatAdministrators
-Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
+getChatAdministrators
+Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
-
@@ -6210,7 +6227,7 @@ pre-formatted fixed-width code block written in the Python programming language getChatMemberCount
+getChatMemberCount
Use this method to get the number of members in a chat. Returns Int on success.
@@ -6230,7 +6247,7 @@ pre-formatted fixed-width code block written in the Python programming language
-getChatMember
+getChatMember
Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.
@@ -6256,7 +6273,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setChatStickerSet
+setChatStickerSet
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
@@ -6282,7 +6299,7 @@ pre-formatted fixed-width code block written in the Python programming language
-deleteChatStickerSet
+deleteChatStickerSet
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
@@ -6302,9 +6319,9 @@ pre-formatted fixed-width code block written in the Python programming language
-getForumTopicIconStickers
+getForumTopicIconStickers
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
-createForumTopic
+createForumTopic
Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
@@ -6342,7 +6359,7 @@ pre-formatted fixed-width code block written in the Python programming language
-editForumTopic
+editForumTopic
Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
@@ -6380,7 +6397,7 @@ pre-formatted fixed-width code block written in the Python programming language
-closeForumTopic
+closeForumTopic
Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
@@ -6406,7 +6423,7 @@ pre-formatted fixed-width code block written in the Python programming language
-reopenForumTopic
+reopenForumTopic
Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
@@ -6432,7 +6449,7 @@ pre-formatted fixed-width code block written in the Python programming language
-deleteForumTopic
+deleteForumTopic
Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.
@@ -6458,7 +6475,7 @@ pre-formatted fixed-width code block written in the Python programming language
-unpinAllForumTopicMessages
+unpinAllForumTopicMessages
Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
@@ -6484,8 +6501,8 @@ pre-formatted fixed-width code block written in the Python programming language
-editGeneralForumTopic
-Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
+editGeneralForumTopic
+Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
-
@@ -6510,8 +6527,8 @@ pre-formatted fixed-width code block written in the Python programming language closeGeneralForumTopic
-Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+closeGeneralForumTopic
+Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
-
@@ -6530,8 +6547,8 @@ pre-formatted fixed-width code block written in the Python programming language reopenGeneralForumTopic
-Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
+reopenGeneralForumTopic
+Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
-
@@ -6550,8 +6567,8 @@ pre-formatted fixed-width code block written in the Python programming language hideGeneralForumTopic
-Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
+hideGeneralForumTopic
+Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.
-
@@ -6570,8 +6587,8 @@ pre-formatted fixed-width code block written in the Python programming language unhideGeneralForumTopic
-Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
+unhideGeneralForumTopic
+Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
-
@@ -6590,7 +6607,7 @@ pre-formatted fixed-width code block written in the Python programming language answerCallbackQuery
+answerCallbackQuery
Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like
@@ -6627,7 +6644,7 @@ pre-formatted fixed-width code block written in the Python programming languaget.me/your_bot?start=XXXXthat open your bot with a parameter.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 liket.me/your_bot?start=XXXXthat 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 liket.me/your_bot?start=XXXXthat open your bot with a parameter.cache_time @@ -6637,8 +6654,8 @@ pre-formatted fixed-width code block written in the Python programming languagesetMyCommands
-Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
+setMyCommands
+Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
-
@@ -6653,7 +6670,7 @@ pre-formatted fixed-width code block written in the Python programming language commands Array of BotCommand Yes -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. +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 @@ -6669,8 +6686,8 @@ pre-formatted fixed-width code block written in the Python programming languagedeleteMyCommands
-Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
+deleteMyCommands
+Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
-
@@ -6695,8 +6712,8 @@ pre-formatted fixed-width code block written in the Python programming language getMyCommands
-Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
+getMyCommands
+Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
-
@@ -6721,8 +6738,8 @@ pre-formatted fixed-width code block written in the Python programming language setMyName
-Use this method to change the bot's name. Returns True on success.
+setMyName
+Use this method to change the bot's name. Returns True on success.
-
@@ -6747,7 +6764,7 @@ pre-formatted fixed-width code block written in the Python programming language getMyName
+getMyName
Use this method to get the current bot name for the given user language. Returns BotName on success.
@@ -6767,8 +6784,8 @@ pre-formatted fixed-width code block written in the Python programming language
-setMyDescription
-Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
+setMyDescription
+Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
-
@@ -6793,7 +6810,7 @@ pre-formatted fixed-width code block written in the Python programming language getMyDescription
+getMyDescription
Use this method to get the current bot description for the given user language. Returns BotDescription on success.
@@ -6813,8 +6830,8 @@ pre-formatted fixed-width code block written in the Python programming language
-setMyShortDescription
-Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
+setMyShortDescription
+Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
-
@@ -6839,7 +6856,7 @@ pre-formatted fixed-width code block written in the Python programming language getMyShortDescription
+getMyShortDescription
Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
@@ -6859,8 +6876,8 @@ pre-formatted fixed-width code block written in the Python programming language
-setChatMenuButton
-Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
+setChatMenuButton
+Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
-
@@ -6875,18 +6892,18 @@ pre-formatted fixed-width code block written in the Python programming language chat_id Integer Optional -Unique identifier for the target private chat. If not specified, default bot's menu button will be changed +Unique identifier for the target private chat. If not specified, default bot's menu button will be changed menu_button MenuButton Optional -A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault +A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault getChatMenuButton
-Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
+getChatMenuButton
+Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
-
@@ -6901,12 +6918,12 @@ pre-formatted fixed-width code block written in the Python programming language chat_id Integer Optional -Unique identifier for the target private chat. If not specified, default bot's menu button will be returned +Unique identifier for the target private chat. If not specified, default bot's menu button will be returned setMyDefaultAdministratorRights
-Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
+setMyDefaultAdministratorRights
+Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
-
@@ -6931,7 +6948,7 @@ pre-formatted fixed-width code block written in the Python programming language getMyDefaultAdministratorRights
+getMyDefaultAdministratorRights
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
@@ -6951,12 +6968,12 @@ pre-formatted fixed-width code block written in the Python programming language
-Inline mode methods
+Inline mode methods
Methods and objects used in the inline mode are described in the Inline mode section.
-Updating messages
+Updating messages
The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots.
Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards.
-editMessageText
+editMessageText
Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
@@ -7018,7 +7035,7 @@ pre-formatted fixed-width code block written in the Python programming language
-editMessageCaption
+editMessageCaption
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
@@ -7074,8 +7091,8 @@ pre-formatted fixed-width code block written in the Python programming language
-editMessageMedia
-Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
+editMessageMedia
+Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
-
@@ -7118,7 +7135,7 @@ pre-formatted fixed-width code block written in the Python programming language editMessageLiveLocation
+editMessageLiveLocation
Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
@@ -7186,7 +7203,7 @@ pre-formatted fixed-width code block written in the Python programming language
-stopMessageLiveLocation
+stopMessageLiveLocation
Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
@@ -7224,7 +7241,7 @@ pre-formatted fixed-width code block written in the Python programming language
-editMessageReplyMarkup
+editMessageReplyMarkup
Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
@@ -7262,7 +7279,7 @@ pre-formatted fixed-width code block written in the Python programming language
-stopPoll
+stopPoll
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
@@ -7294,8 +7311,19 @@ pre-formatted fixed-width code block written in the Python programming language
-deleteMessage
-Use this method to delete a message, including service messages, with the following limitations:
+
- A message can only be deleted if it was sent less than 48 hours ago.
- Service messages about a supergroup, channel, or forum topic creation can't be deleted.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
Returns True on success.deleteMessage
+Use this method to delete a message, including service messages, with the following limitations:
++
- A message can only be deleted if it was sent less than 48 hours ago.
+- Service messages about a supergroup, channel, or forum topic creation can't be deleted.
+- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
+- Bots can delete outgoing messages in private chats, groups, and supergroups.
+- Bots can delete incoming messages in private chats.
+- Bots granted can_post_messages permissions can delete outgoing messages in channels.
+- If the bot is an administrator of a group, it can delete any message there.
+- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. +Returns True on success.
+-
@@ -7320,9 +7348,9 @@ pre-formatted fixed-width code block written in the Python programming language Stickers
+Stickers
The following methods and objects allow your bot to handle stickers and sticker sets.
-Sticker
+Sticker
This object represents a sticker.
@@ -7341,12 +7369,12 @@ pre-formatted fixed-width code block written in the Python programming language
-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. type String -Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video. +Type of the sticker, currently one of "regular", "mask", "custom_emoji". The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video. width @@ -7410,7 +7438,7 @@ pre-formatted fixed-width code block written in the Python programming languageStickerSet
+StickerSet
This object represents a sticker set.
@@ -7434,7 +7462,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sticker_type String -Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” +Type of stickers in the set, currently one of "regular", "mask", "custom_emoji" is_animated @@ -7458,7 +7486,7 @@ pre-formatted fixed-width code block written in the Python programming languageMaskPosition
+MaskPosition
This object describes the position on faces where a mask should be placed by default.
@@ -7472,7 +7500,7 @@ pre-formatted fixed-width code block written in the Python programming language
-point String -The 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 @@ -7491,7 +7519,7 @@ pre-formatted fixed-width code block written in the Python programming languageInputSticker
+InputSticker
This object describes a sticker to be added to a sticker set.
@@ -7505,7 +7533,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sticker InputFile or String -The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files » +The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files » emoji_list @@ -7515,16 +7543,16 @@ pre-formatted fixed-width code block written in the Python programming languagemask_position MaskPosition -Optional. Position where the mask should be placed on faces. For “mask” stickers only. +Optional. Position where the mask should be placed on faces. For "mask" stickers only. keywords Array of String -Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. +Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For "regular" and "custom_emoji" stickers only. sendSticker
+sendSticker
Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
@@ -7552,7 +7580,7 @@ pre-formatted fixed-width code block written in the Python programming language
-sticker InputFile or String Yes -Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL. +Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL. emoji @@ -7592,7 +7620,7 @@ pre-formatted fixed-width code block written in the Python programming languagegetStickerSet
+getStickerSet
Use this method to get a sticker set. On success, a StickerSet object is returned.
@@ -7612,7 +7640,7 @@ pre-formatted fixed-width code block written in the Python programming language
-getCustomEmojiStickers
+getCustomEmojiStickers
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
@@ -7632,7 +7660,7 @@ pre-formatted fixed-width code block written in the Python programming language
-uploadStickerFile
+uploadStickerFile
Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success.
@@ -7654,17 +7682,17 @@ pre-formatted fixed-width code block written in the Python programming language
-sticker InputFile Yes -A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files » +A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files » sticker_format String Yes -Format of the sticker, must be one of “static”, “animated”, “video” +Format of the sticker, must be one of "static", "animated", "video" createNewStickerSet
+createNewStickerSet
Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.
@@ -7686,7 +7714,7 @@ pre-formatted fixed-width code block written in the Python programming language
-name String Yes -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.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 @@ -7704,13 +7732,13 @@ pre-formatted fixed-width code block written in the Python programming languagesticker_format String Yes -Format of stickers in the set, must be one of “static”, “animated”, “video” +Format of stickers in the set, must be one of "static", "animated", "video" sticker_type String Optional -Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created. +Type of stickers in the set, pass "regular", "mask", or "custom_emoji". By default, a regular sticker set is created. needs_repainting @@ -7720,7 +7748,7 @@ pre-formatted fixed-width code block written in the Python programming languageaddStickerToSet
+addStickerToSet
Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
@@ -7748,11 +7776,11 @@ pre-formatted fixed-width code block written in the Python programming language
-sticker InputSticker Yes -A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. +A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. setStickerPositionInSet
+setStickerPositionInSet
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
@@ -7778,7 +7806,7 @@ pre-formatted fixed-width code block written in the Python programming language
-deleteStickerFromSet
+deleteStickerFromSet
Use this method to delete a sticker from a set created by the bot. Returns True on success.
@@ -7798,7 +7826,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setStickerEmojiList
+setStickerEmojiList
Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
@@ -7824,7 +7852,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setStickerKeywords
+setStickerKeywords
Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.
@@ -7850,7 +7878,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setStickerMaskPosition
+setStickerMaskPosition
Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.
@@ -7876,7 +7904,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setStickerSetTitle
+setStickerSetTitle
Use this method to set the title of a created sticker set. Returns True on success.
@@ -7902,7 +7930,7 @@ pre-formatted fixed-width code block written in the Python programming language
-setStickerSetThumbnail
+setStickerSetThumbnail
Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.
@@ -7930,11 +7958,11 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail InputFile or String Optional -A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. +A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. setCustomEmojiStickerSetThumbnail
+setCustomEmojiStickerSetThumbnail
Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.
@@ -7960,7 +7988,7 @@ pre-formatted fixed-width code block written in the Python programming language
-deleteStickerSet
+deleteStickerSet
Use this method to delete a sticker set that was created by the bot. Returns True on success.
@@ -7980,10 +8008,11 @@ pre-formatted fixed-width code block written in the Python programming language
-Inline mode
-The following methods and objects allow your bot to work in inline mode.
-
Please see our Introduction to Inline bots for more details.To enable this option, send the
-/setinlinecommand 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
+/setinlinecommand to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot's name.InlineQuery
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
@@ -8017,7 +8046,7 @@ pre-formatted fixed-width code block written in the Python programming language
-chat_type String -Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat +Optional. Type of the chat from which the inline query was sent. Can be either "sender" for a private chat with the inline query sender, "private", "group", "supergroup", or "channel". The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat location @@ -8026,8 +8055,9 @@ pre-formatted fixed-width code block written in the Python programming languageanswerInlineQuery
-Use this method to send answers to an inline query. On success, True is returned.
+
No more than 50 results per query are allowed.answerInlineQuery
+Use this method to send answers to an inline query. On success, True is returned. +No more than 50 results per query are allowed.
-
@@ -8066,7 +8096,7 @@ pre-formatted fixed-width code block written in the Python programming language next_offset String Optional -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. +Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. button @@ -8076,7 +8106,7 @@ pre-formatted fixed-width code block written in the Python programming languageInlineQueryResultsButton
+InlineQueryResultsButton
This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
@@ -8100,11 +8130,11 @@ pre-formatted fixed-width code block written in the Python programming language
-start_parameter String -Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only +A-Z,a-z,0-9,_and-are allowed.
Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z,a-z,0-9,_and-are allowed.
Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.InlineQueryResult
+InlineQueryResult
This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
- InlineQueryResultCachedAudio
@@ -8129,7 +8159,7 @@ pre-formatted fixed-width code block written in the Python programming language- InlineQueryResultVoice
Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.
-InlineQueryResultArticle
+InlineQueryResultArticle
Represents a link to an article or web page.
@@ -8173,7 +8203,7 @@ pre-formatted fixed-width code block written in the Python programming language
-hide_url Boolean -Optional. Pass True if you don't want the URL to be shown in the message +Optional. Pass True if you don't want the URL to be shown in the message description @@ -8197,7 +8227,7 @@ pre-formatted fixed-width code block written in the Python programming languageInlineQueryResultPhoto
+InlineQueryResultPhoto
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
@@ -8275,7 +8305,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InlineQueryResultGif
+InlineQueryResultGif
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
@@ -8324,7 +8354,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail_mime_type String -Optional. 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 @@ -8358,7 +8388,7 @@ pre-formatted fixed-width code block written in the Python programming languageInlineQueryResultMpeg4Gif
+InlineQueryResultMpeg4Gif
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
@@ -8407,7 +8437,7 @@ pre-formatted fixed-width code block written in the Python programming language
-thumbnail_mime_type String -Optional. 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 @@ -8441,7 +8471,7 @@ pre-formatted fixed-width code block written in the Python programming languageInlineQueryResultVideo
+InlineQueryResultVideo
Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.
@@ -8473,7 +8503,7 @@ pre-formatted fixed-width code block written in the Python programming languagemime_type String -MIME type of the content of the video URL, “text/html” or “video/mp4” +MIME type of the content of the video URL, "text/html" or "video/mp4" - thumbnail_url @@ -8532,7 +8562,7 @@ pre-formatted fixed-width code block written in the Python programming languageInlineQueryResultAudio
+InlineQueryResultAudio
Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
@@ -8601,7 +8631,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultVoice
+InlineQueryResultVoice
Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
@@ -8665,7 +8695,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultDocument
+InlineQueryResultDocument
Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
@@ -8714,7 +8744,7 @@ pre-formatted fixed-width code block written in the Python programming language
mime_type String -MIME 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 @@ -8749,7 +8779,7 @@ pre-formatted fixed-width code block written in the Python programming languageNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultLocation
+InlineQueryResultLocation
Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
@@ -8833,7 +8863,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultVenue
+InlineQueryResultVenue
Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
@@ -8882,7 +8912,7 @@ pre-formatted fixed-width code block written in the Python programming language
foursquare_type String -Optional. 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 @@ -8922,7 +8952,7 @@ pre-formatted fixed-width code block written in the Python programming languageNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultContact
+InlineQueryResultContact
Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
@@ -8946,17 +8976,17 @@ pre-formatted fixed-width code block written in the Python programming language
phone_number String -Contact's phone number +Contact's phone number first_name String -Contact's first name +Contact's first name last_name String -Optional. Contact's last name +Optional. Contact's last name vcard @@ -8991,7 +9021,7 @@ pre-formatted fixed-width code block written in the Python programming languageNote: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultGame
+InlineQueryResultGame
Represents a Game.
@@ -9025,7 +9055,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.
-InlineQueryResultCachedPhoto
+InlineQueryResultCachedPhoto
Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
@@ -9088,7 +9118,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InlineQueryResultCachedGif
+InlineQueryResultCachedGif
Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
@@ -9146,7 +9176,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InlineQueryResultCachedMpeg4Gif
+InlineQueryResultCachedMpeg4Gif
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
@@ -9204,7 +9234,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InlineQueryResultCachedSticker
+InlineQueryResultCachedSticker
Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
@@ -9243,7 +9273,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.
-InlineQueryResultCachedDocument
+InlineQueryResultCachedDocument
Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
@@ -9307,7 +9337,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultCachedVideo
+InlineQueryResultCachedVideo
Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
@@ -9370,7 +9400,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InlineQueryResultCachedVoice
+InlineQueryResultCachedVoice
Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
@@ -9429,7 +9459,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InlineQueryResultCachedAudio
+InlineQueryResultCachedAudio
Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
@@ -9483,7 +9513,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.
-InputMessageContent
+InputMessageContent
This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:
-
- InputTextMessageContent
@@ -9492,7 +9522,7 @@ pre-formatted fixed-width code block written in the Python programming language- InputContactMessageContent
- InputInvoiceMessageContent
InputTextMessageContent
+InputTextMessageContent
Represents the content of a text message to be sent as the result of an inline query.
@@ -9525,7 +9555,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InputLocationMessageContent
+InputLocationMessageContent
Represents the content of a location message to be sent as the result of an inline query.
@@ -9568,7 +9598,7 @@ pre-formatted fixed-width code block written in the Python programming language
-InputVenueMessageContent
+InputVenueMessageContent
Represents the content of a venue message to be sent as the result of an inline query.
@@ -9607,7 +9637,7 @@ pre-formatted fixed-width code block written in the Python programming language
-foursquare_type String -Optional. 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 @@ -9621,7 +9651,7 @@ pre-formatted fixed-width code block written in the Python programming languageInputContactMessageContent
+InputContactMessageContent
Represents the content of a contact message to be sent as the result of an inline query.
@@ -9635,17 +9665,17 @@ pre-formatted fixed-width code block written in the Python programming language
-phone_number String -Contact's phone number +Contact's phone number first_name String -Contact's first name +Contact's first name last_name String -Optional. Contact's last name +Optional. Contact's last name vcard @@ -9654,7 +9684,7 @@ pre-formatted fixed-width code block written in the Python programming languageInputInvoiceMessageContent
+InputInvoiceMessageContent
Represents the content of an invoice message to be sent as the result of an inline query.
@@ -9733,32 +9763,32 @@ pre-formatted fixed-width code block written in the Python programming language
-need_name Boolean -Optional. Pass True if you require the user's full name to complete the order +Optional. Pass True if you require the user's full name to complete the order need_phone_number Boolean -Optional. Pass True if you require the user's phone number to complete the order +Optional. Pass True if you require the user's phone number to complete the order need_email Boolean -Optional. Pass True if you require the user's email address to complete the order +Optional. Pass True if you require the user's email address to complete the order need_shipping_address Boolean -Optional. Pass True if you require the user's shipping address to complete the order +Optional. Pass True if you require the user's shipping address to complete the order send_phone_number_to_provider Boolean -Optional. Pass True if the user's phone number should be sent to provider +Optional. Pass True if the user's phone number should be sent to provider send_email_to_provider Boolean -Optional. Pass True if the user's email address should be sent to provider +Optional. Pass True if the user's email address should be sent to provider is_flexible @@ -9767,7 +9797,7 @@ pre-formatted fixed-width code block written in the Python programming languageChosenInlineResult
+ChosenInlineResult
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
@@ -9806,7 +9836,7 @@ pre-formatted fixed-width code block written in the Python programming language
Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.
-answerWebAppQuery
+answerWebAppQuery
Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
@@ -9832,7 +9862,7 @@ pre-formatted fixed-width code block written in the Python programming language
-SentWebAppMessage
+SentWebAppMessage
Describes an inline message sent by a Web App on behalf of a user.
@@ -9850,9 +9880,9 @@ pre-formatted fixed-width code block written in the Python programming language
-Payments
+Payments
Your bot can accept payments from Telegram users. Please see the introduction to payments for more details on the process and how to set up payments for your bot. Please note that users will need Telegram v.4.0 or higher to use payments (released on May 18, 2017).
-sendInvoice
+sendInvoice
Use this method to send invoices. On success, the sent Message is returned.
@@ -9964,37 +9994,37 @@ pre-formatted fixed-width code block written in the Python programming language
-need_name Boolean Optional -Pass True if you require the user's full name to complete the order +Pass True if you require the user's full name to complete the order need_phone_number Boolean Optional -Pass True if you require the user's phone number to complete the order +Pass True if you require the user's phone number to complete the order need_email Boolean Optional -Pass True if you require the user's email address to complete the order +Pass True if you require the user's email address to complete the order need_shipping_address Boolean Optional -Pass True if you require the user's shipping address to complete the order +Pass True if you require the user's shipping address to complete the order send_phone_number_to_provider Boolean Optional -Pass True if the user's phone number should be sent to provider +Pass True if the user's phone number should be sent to provider send_email_to_provider Boolean Optional -Pass True if the user's email address should be sent to provider +Pass True if the user's email address should be sent to provider is_flexible @@ -10030,11 +10060,11 @@ pre-formatted fixed-width code block written in the Python programming languagereply_markup InlineKeyboardMarkup Optional -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.A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.createInvoiceLink
+createInvoiceLink
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
@@ -10128,37 +10158,37 @@ pre-formatted fixed-width code block written in the Python programming language
-need_name Boolean Optional -Pass True if you require the user's full name to complete the order +Pass True if you require the user's full name to complete the order need_phone_number Boolean Optional -Pass True if you require the user's phone number to complete the order +Pass True if you require the user's phone number to complete the order need_email Boolean Optional -Pass True if you require the user's email address to complete the order +Pass True if you require the user's email address to complete the order need_shipping_address Boolean Optional -Pass True if you require the user's shipping address to complete the order +Pass True if you require the user's shipping address to complete the order send_phone_number_to_provider Boolean Optional -Pass True if the user's phone number should be sent to the provider +Pass True if the user's phone number should be sent to the provider send_email_to_provider Boolean Optional -Pass True if the user's email address should be sent to the provider +Pass True if the user's email address should be sent to the provider is_flexible @@ -10168,7 +10198,7 @@ pre-formatted fixed-width code block written in the Python programming languageanswerShippingQuery
+answerShippingQuery
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
@@ -10202,11 +10232,11 @@ pre-formatted fixed-width code block written in the Python programming language
-error_message String Optional -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. +Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. answerPreCheckoutQuery
+answerPreCheckoutQuery
Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
@@ -10234,11 +10264,11 @@ pre-formatted fixed-width code block written in the Python programming language
-error_message String Optional -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. +Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. LabeledPrice
+LabeledPrice
This object represents a portion of the price for goods or services.
@@ -10261,7 +10291,7 @@ pre-formatted fixed-width code block written in the Python programming language
-Invoice
+Invoice
This object contains basic information about an invoice.
@@ -10299,7 +10329,7 @@ pre-formatted fixed-width code block written in the Python programming language
-ShippingAddress
+ShippingAddress
This object represents a shipping address.
@@ -10342,7 +10372,7 @@ pre-formatted fixed-width code block written in the Python programming language
-OrderInfo
+OrderInfo
This object represents information about an order.
@@ -10361,7 +10391,7 @@ pre-formatted fixed-width code block written in the Python programming language
-phone_number String -Optional. User's phone number +Optional. User's phone number ShippingOption
+ShippingOption
This object represents one shipping option.
@@ -10403,7 +10433,7 @@ pre-formatted fixed-width code block written in the Python programming language
-SuccessfulPayment
+SuccessfulPayment
This object contains basic information about a successful payment.
@@ -10451,7 +10481,7 @@ pre-formatted fixed-width code block written in the Python programming language
-ShippingQuery
+ShippingQuery
This object contains information about an incoming shipping query.
@@ -10484,7 +10514,7 @@ pre-formatted fixed-width code block written in the Python programming language
-PreCheckoutQuery
+PreCheckoutQuery
This object contains information about an incoming pre-checkout query.
@@ -10532,9 +10562,9 @@ pre-formatted fixed-width code block written in the Python programming language
-Telegram Passport
+Telegram Passport
Telegram Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the manual for details.
-PassportData
+PassportData
Describes Telegram Passport data shared with the bot by the user.
@@ -10557,8 +10587,8 @@ pre-formatted fixed-width code block written in the Python programming language
-PassportFile
-This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
+PassportFile
+This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.
-
@@ -10576,7 +10606,7 @@ pre-formatted fixed-width code block written in the Python programming language 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 @@ -10590,7 +10620,7 @@ pre-formatted fixed-width code block written in the Python programming languageEncryptedPassportElement
+EncryptedPassportElement
Describes documents or other Telegram Passport elements shared with the bot by the user.
@@ -10604,47 +10634,47 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -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”. +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 String -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. +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 String -Optional. User's verified phone number, available only for “phone_number” type +Optional. User's verified phone number, available only for "phone_number" type String -Optional. User's verified email address, available only for “email” type +Optional. User's verified email address, available only for "email" type files Array of PassportFile -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. +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 PassportFile -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. +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 PassportFile -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. +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 PassportFile -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. +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 PassportFile -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. +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 @@ -10653,7 +10683,7 @@ pre-formatted fixed-width code block written in the Python programming languageEncryptedCredentials
+EncryptedCredentials
Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
@@ -10667,7 +10697,7 @@ pre-formatted fixed-width code block written in the Python programming language
-data String -Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication +Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication hash @@ -10677,13 +10707,13 @@ pre-formatted fixed-width code block written in the Python programming languagesecret String -Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption +Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption setPassportDataErrors
+setPassportDataErrors
Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
-Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
+Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
-
@@ -10708,7 +10738,7 @@ pre-formatted fixed-width code block written in the Python programming language PassportElementError
+PassportElementError
This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
-
- PassportElementErrorDataField
@@ -10721,8 +10751,8 @@ pre-formatted fixed-width code block written in the Python programming language- PassportElementErrorTranslationFiles
- PassportElementErrorUnspecified
PassportElementErrorDataField
-Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
+PassportElementErrorDataField
+Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
-
@@ -10740,7 +10770,7 @@ pre-formatted fixed-width code block written in the Python programming language type String -The 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 @@ -10759,7 +10789,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorFrontSide
+PassportElementErrorFrontSide
Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
@@ -10778,7 +10808,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -The 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 @@ -10792,7 +10822,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorReverseSide
+PassportElementErrorReverseSide
Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
@@ -10811,7 +10841,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -The 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 @@ -10825,7 +10855,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorSelfie
+PassportElementErrorSelfie
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
@@ -10844,7 +10874,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -The 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 @@ -10858,7 +10888,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorFile
+PassportElementErrorFile
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
@@ -10877,7 +10907,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -The 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 @@ -10891,7 +10921,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorFiles
+PassportElementErrorFiles
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
@@ -10910,7 +10940,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -The 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 @@ -10924,7 +10954,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorTranslationFile
+PassportElementErrorTranslationFile
Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
@@ -10943,7 +10973,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -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” +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 @@ -10957,7 +10987,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorTranslationFiles
+PassportElementErrorTranslationFiles
Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
@@ -10976,7 +11006,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -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” +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 @@ -10990,7 +11020,7 @@ pre-formatted fixed-width code block written in the Python programming languagePassportElementErrorUnspecified
+PassportElementErrorUnspecified
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
@@ -11009,7 +11039,7 @@ pre-formatted fixed-width code block written in the Python programming language
-type String -Type of element of the user's Telegram Passport which has the issue +Type of element of the user's Telegram Passport which has the issue element_hash @@ -11023,20 +11053,20 @@ pre-formatted fixed-width code block written in the Python programming languageGames
+Games
Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.
-
- Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.
-- Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.
-- If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.
-- You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.
+- Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.
+- If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.
+- You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.
- To make your game more attractive, you can upload a GIF animation that demostrates the game to the users via BotFather (see Lumberjack for example).
- A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the edit_message parameter to automatically update the message with the current scoreboard.
- Use getGameHighScores to get data for in-game high score tables.
- You can also add an extra sharing button for users to share their best score to different chats.
- For examples of what can be done using this new stuff, check the @gamebot and @gamee bots.
sendGame
+sendGame
Use this method to send a game. On success, the sent Message is returned.
@@ -11094,11 +11124,11 @@ pre-formatted fixed-width code block written in the Python programming language
-reply_markup InlineKeyboardMarkup Optional -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. +A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Game
+Game
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
@@ -11141,10 +11171,10 @@ pre-formatted fixed-width code block written in the Python programming language
-CallbackGame
+CallbackGame
A placeholder, currently holds no information. Use BotFather to set up your game.
-setGameScore
-Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
+setGameScore
+Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
-
@@ -11199,7 +11229,7 @@ pre-formatted fixed-width code block written in the Python programming language getGameHighScores
+getGameHighScores
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.
@@ -11240,7 +11270,7 @@ pre-formatted fixed-width code block written in the Python programming language -GameHighScore
+GameHighScore
This object represents one row of the high scores table for a game.
@@ -11269,8 +11299,8 @@ pre-formatted fixed-width code block written in the Python programming language
-And that's about all we've got for now.
-
If you've got any questions, please check out our Bot FAQ »
</tg-emoji>
+<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
+<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
+<a href="http://www.example.com/">inline URL</a>
+<a href="tg://user?id=123456789">inline mention of a user</a>
+<tg-emoji emoji-id="5368324170671202286">