diff --git a/data/web/core.telegram.org/bots/api.html b/data/web/core.telegram.org/bots/api.html index 80913a9dbd..d4721a5200 100644 --- a/data/web/core.telegram.org/bots/api.html +++ b/data/web/core.telegram.org/bots/api.html @@ -53,6 +53,29 @@ To learn how to create…">
+Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk
Bot API 6.2
+Custom Emoji Support
+Web App Improvements
+Other Changes
+Bot API 6.1
Media in Descriptions
@@ -117,15 +140,6 @@ To learn how to create…">Bot API 5.6
-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.
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
+Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat. |
|||
has_restricted_voice_and_video_messages | +True | +Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat. | +|
join_to_send_messages | True | Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat. | @@ -973,7 +992,7 @@ To learn how to create…">|
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) |
+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 | @@ -1000,6 +1019,11 @@ To learn how to create…">String | 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 | +
Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+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.
allow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found | |
reply_markup | @@ -3687,7 +3711,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -3786,7 +3810,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -3872,7 +3896,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -3952,7 +3976,7 @@ pre-formatted fixed-width code block written in the Python programming languagesupports_streaming | Boolean | Optional | -Pass True, if the uploaded video is suitable for streaming | +Pass True if the uploaded video is suitable for streaming |
disable_notification | @@ -3976,7 +4000,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -4074,7 +4098,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -4154,7 +4178,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -4228,7 +4252,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -4284,7 +4308,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
+Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.
+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.
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. | +|||||
width | Integer | Sticker width | @@ -6293,7 +6322,7 @@ pre-formatted fixed-width code block written in the Python programming language|||||
premium_animation | File | -Optional. Premium animation for the sticker, if the sticker is premium | +Optional. For premium regular stickers, premium animation for the sticker | ||||
mask_position | @@ -6301,6 +6330,11 @@ pre-formatted fixed-width code block written in the Python programming languageOptional. For mask stickers, the position where the mask should be placed | ||||||
custom_emoji_id | +String | +Optional. For custom emoji stickers, unique identifier of the custom emoji | +|||||
file_size | Integer | Optional. File size in bytes | @@ -6329,6 +6363,11 @@ pre-formatted fixed-width code block written in the Python programming languageSticker set title | ||||
sticker_type | +String | +Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” | +|||||
is_animated | Boolean | True, if the sticker set contains animated stickers | @@ -6339,11 +6378,6 @@ pre-formatted fixed-width code block written in the Python programming languageTrue, if the sticker set contains video stickers | ||||
contains_masks | -Boolean | -True, if the sticker set contains masks | -|||||
stickers | Array of Sticker | List of all set stickers | @@ -6434,7 +6468,7 @@ pre-formatted fixed-width code block written in the Python programming languageallow_sending_without_reply | Boolean | Optional | -Pass True, if the message should be sent even if the specified replied-to message is not found | +Pass True if the message should be sent even if the specified replied-to message is not found |
reply_markup | @@ -6464,6 +6498,26 @@ pre-formatted fixed-width code block written in the Python programming language
Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
+Parameter | +Type | +Required | +Description | +
---|---|---|---|
custom_emoji_ids | +Array of String | +Yes | +List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. | +
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements | |||||||
sticker_type | +String | +Optional | +Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created. | +||||
emojis | String | Yes | One or more emoji corresponding to the sticker | ||||
contains_masks | -Boolean | -Optional | -Pass True, if a set of mask stickers should be created | -||||
mask_position | MaskPosition | Optional | @@ -6772,7 +6826,7 @@ pre-formatted fixed-width code block written in the Python programming languageis_personal | Boolean | Optional | -Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query | +Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query |
next_offset | @@ -6863,7 +6917,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 | @@ -8423,37 +8477,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 | +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 | Boolean | -Optional. Pass True, if the final price depends on the shipping method | +Optional. Pass True if the final price depends on the shipping method |
Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.
+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.