Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk
2023
+December 29, 2023
+Bot API 7.0
+Reactions
+-
+
- Added the classes ReactionTypeEmoji and ReactionTypeCustomEmoji representing different types of reaction. +
- Added updates about a reaction change on a message with non-anonymous reactions, represented by the class MessageReactionUpdated and the field message_reaction in the class Update. The bot must explicitly allow the update to receive it. +
- Added updates about reaction changes on a message with anonymous reactions, represented by the class MessageReactionCountUpdated and the field message_reaction_count in the class Update. The bot must explicitly allow the update to receive it. +
- Added the method setMessageReaction that allows bots to react to messages. +
- Added the field available_reactions to the class Chat. +
Replies 2.0
+-
+
- Added the ability to reply to messages in other chats or forum topics. +
- Added the class ExternalReplyInfo and the field external_reply of type ExternalReplyInfo to the class Message, containing information about a message that is replied to by the current message, but can be from another chat or forum topic. +
- Added the ability to quote a part of the replied message. +
- Added the class TextQuote and the field quote of type TextQuote to the class Message, which contains the part of the replied message text or caption that is quoted in the current message. +
- Added the class ReplyParameters and replaced parameters reply_to_message_id and allow_sending_without_reply in the methods copyMessage, sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendInvoice, sendGame, and sendMediaGroup with the field reply_parameters of type ReplyParameters. +
Link Preview Customization
+-
+
- Allowed to explicitly specify the URL that will be used for link preview generation in outgoing text messages. +
- Allowed to position link previews above the message text. +
- Allowed to choose media size in link previews. +
- Added the class LinkPreviewOptions and replaced the parameter disable_web_page_preview with link_preview_options in the methods sendMessage and editMessageText. +
- Replaced the field disable_web_page_preview with link_preview_options in the class InputTextMessageContent. +
- Added the field link_preview_options to the class Message with information about the link preview options used to send the message. +
Block Quotation
+-
+
- Added support for “blockquote” entities in received messages. +
- Added support for “blockquote” entity parsing in “MarkdownV2” and “HTML” parse modes. +
- Allowed to explicitly specify “blockquote” entities in formatted texts. +
Multiple Message Actions
+-
+
- Added the method deleteMessages to allow the deletion of multiple messages in a single request. +
- Added the method forwardMessages for forwarding of multiple messages in a single request. +
- Added the method copyMessages for copying of multiple messages in a single request. +
Request for multiple users
+-
+
- Renamed the class KeyboardButtonRequestUser to KeyboardButtonRequestUsers and added the field max_quantity to it. +
- Renamed the field request_user in the class KeyboardButton to request_users. The old name will still work for backward compatibility. +
- Added the class UsersShared. +
- Replaced the field user_shared in the class Message with the field users_shared. +
Chat Boost
+-
+
- Added updates about chat boost changes, represented by the classes ChatBoostUpdated and ChatBoostRemoved and the fields chat_boost and removed_chat_boost in the class Update. The bot must be an administrator in the chat to receive these updates. +
- Added the classes ChatBoostSourcePremium, ChatBoostSourceGiftCode and ChatBoostSourceGiveaway, representing different sources of a chat boost. +
- Added the method getUserChatBoosts for obtaining the list of all active boosts a user has contributed to a chat. +
Giveaway
+-
+
- Added the class Giveaway and the field giveaway to the class Message for messages about scheduled giveaways. +
- Added the class GiveawayCreated and the field giveaway_created to the class Message for service messages about the creation of a scheduled giveaway. +
- Added the class GiveawayWinners and the field giveaway_winners to the class Message for messages about the completion of a giveaway with public winners. +
- Added the class GiveawayCompleted and the field giveaway_completed to the class Message for service messages about the completion of a giveaway without public winners. +
Web App Changes
+-
+
- Added the field SettingsButton to the class WebApp. +
- Added the fields header_bg_color, accent_text_color, section_bg_color, section_header_text_color, subtitle_text_color, destructive_text_color to the class ThemeParams. +
- Web Apps no longer close when the method WebApp.openTelegramLink is called. +
Other Changes
+-
+
- Added support for the fields emoji_status_custom_emoji_id and emoji_status_expiration_date in the class Chat for non-private chats. +
- Added the fields accent_color_id, background_custom_emoji_id, profile_accent_color_id, and profile_background_custom_emoji_id to the class Chat. +
- Added the field has_visible_history to the class Chat. +
- Added the class MessageOrigin and replaced the fields forward_from, forward_from_chat, forward_from_message_id, forward_signature, forward_sender_name, and forward_date with the field forward_origin of type MessageOrigin in the class Message. +
- Improved documentation for the field message of the class callbackQuery and the field pinned_message of the class Message by adding the classes MaybeInaccessibleMessage and InaccessibleMessage. +
September 22, 2023
Bot API 6.9
-
diff --git a/data/web/core.telegram.org/bots/api.html b/data/web/core.telegram.org/bots/api.html
index dea27ce2f5..c67ee43141 100644
--- a/data/web/core.telegram.org/bots/api.html
+++ b/data/web/core.telegram.org/bots/api.html
@@ -53,6 +53,79 @@ To learn how to create…">
- Added the classes ReactionTypeEmoji and ReactionTypeCustomEmoji representing different types of reaction. +
- Added updates about a reaction change on a message with non-anonymous reactions, represented by the class MessageReactionUpdated and the field message_reaction in the class Update. The bot must explicitly allow the update to receive it. +
- Added updates about reaction changes on a message with anonymous reactions, represented by the class MessageReactionCountUpdated and the field message_reaction_count in the class Update. The bot must explicitly allow the update to receive it. +
- Added the method setMessageReaction that allows bots to react to messages. +
- Added the field available_reactions to the class Chat. +
- Added the ability to reply to messages in other chats or forum topics. +
- Added the class ExternalReplyInfo and the field external_reply of type ExternalReplyInfo to the class Message, containing information about a message that is replied to by the current message, but can be from another chat or forum topic. +
- Added the ability to quote a part of the replied message. +
- Added the class TextQuote and the field quote of type TextQuote to the class Message, which contains the part of the replied message text or caption that is quoted in the current message. +
- Added the class ReplyParameters and replaced parameters reply_to_message_id and allow_sending_without_reply in the methods copyMessage, sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendInvoice, sendGame, and sendMediaGroup with the field reply_parameters of type ReplyParameters. +
- Allowed to explicitly specify the URL that will be used for link preview generation in outgoing text messages. +
- Allowed to position link previews above the message text. +
- Allowed to choose media size in link previews. +
- Added the class LinkPreviewOptions and replaced the parameter disable_web_page_preview with link_preview_options in the methods sendMessage and editMessageText. +
- Replaced the field disable_web_page_preview with link_preview_options in the class InputTextMessageContent. +
- Added the field link_preview_options to the class Message with information about the link preview options used to send the message. +
- Added support for “blockquote” entities in received messages. +
- Added support for “blockquote” entity parsing in “MarkdownV2” and “HTML” parse modes. +
- Allowed to explicitly specify “blockquote” entities in formatted texts. +
- Added the method deleteMessages to allow the deletion of multiple messages in a single request. +
- Added the method forwardMessages for forwarding of multiple messages in a single request. +
- Added the method copyMessages for copying of multiple messages in a single request. +
- Renamed the class KeyboardButtonRequestUser to KeyboardButtonRequestUsers and added the field max_quantity to it. +
- Renamed the field request_user in the class KeyboardButton to request_users. The old name will still work for backward compatibility. +
- Added the class UsersShared. +
- Replaced the field user_shared in the class Message with the field users_shared. +
- Added updates about chat boost changes, represented by the classes ChatBoostUpdated and ChatBoostRemoved and the fields chat_boost and removed_chat_boost in the class Update. The bot must be an administrator in the chat to receive these updates. +
- Added the classes ChatBoostSourcePremium, ChatBoostSourceGiftCode and ChatBoostSourceGiveaway, representing different sources of a chat boost. +
- Added the method getUserChatBoosts for obtaining the list of all active boosts a user has contributed to a chat. +
- Added the class Giveaway and the field giveaway to the class Message for messages about scheduled giveaways. +
- Added the class GiveawayCreated and the field giveaway_created to the class Message for service messages about the creation of a scheduled giveaway. +
- Added the class GiveawayWinners and the field giveaway_winners to the class Message for messages about the completion of a giveaway with public winners. +
- Added the class GiveawayCompleted and the field giveaway_completed to the class Message for service messages about the completion of a giveaway without public winners. +
- Added the field SettingsButton to the class WebApp. +
- Added the fields header_bg_color, accent_text_color, section_bg_color, section_header_text_color, subtitle_text_color, destructive_text_color to the class ThemeParams. +
- Web Apps no longer close when the method WebApp.openTelegramLink is called. +
- Added support for the fields emoji_status_custom_emoji_id and emoji_status_expiration_date in the class Chat for non-private chats. +
- Added the fields accent_color_id, background_custom_emoji_id, profile_accent_color_id, and profile_background_custom_emoji_id to the class Chat. +
- Added the field has_visible_history to the class Chat. +
- Added the class MessageOrigin and replaced the fields forward_from, forward_from_chat, forward_from_message_id, forward_signature, forward_sender_name, and forward_date with the field forward_origin of type MessageOrigin in the class Message. +
- Improved documentation for the field message of the class callbackQuery and the field pinned_message of the class Message by adding the classes MaybeInaccessibleMessage and InaccessibleMessage. +
- Added the method unpinAllGeneralForumTopicMessages.
- Increased to 512 characters the maximum length of the startapp parameter in direct Web App links.
- 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. -
- Added the field web_app_name to the class WriteAccessAllowed. -
- Added the field switch_inline_query_chosen_chat of the type SwitchInlineQueryChosenChat to the class InlineKeyboardButton, which allows bots to switch to inline mode in a chosen chat of the given type. -
- 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 specify custom emoji entities using HTML and MarkdownV2 formatting options for bots that purchased additional usernames on Fragment. -
- 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. +
- 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.
+Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk
December 29, 2023
+Bot API 7.0
+Reactions
+-
+
Replies 2.0
+-
+
Link Preview Customization
+-
+
Block Quotation
+-
+
Multiple Message Actions
+-
+
Request for multiple users
+-
+
Chat Boost
+-
+
Giveaway
+-
+
Web App Changes
+-
+
Other Changes
+-
+
September 22, 2023
Bot API 6.9
-
@@ -74,18 +147,6 @@ To learn how to create…">
April 21, 2023
-Bot API 6.7
--
-
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.
"message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots."message_reaction_count" in the list of allowed_updates to receive these updates.getUpdates
@@ -248,7 +329,7 @@ To learn how to create…">["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.
["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
["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.
["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
InaccessibleMessage
+This object describes a message that was deleted or is otherwise inaccessible to the bot.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +Chat the message belonged to | +
| message_id | +Integer | +Unique message identifier inside the chat | +
| date | +Integer | +Always 0. The field can be used to differentiate regular and inaccessible messages. | +
MaybeInaccessibleMessage
+This object describes a message that can be inaccessible to the bot. It can be one of
+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), “blockquote” (block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers) |
| offset | @@ -1067,6 +1222,350 @@ To learn how to create…">
TextQuote
+This object contains information about the quoted part of a message that is replied to by the given message.
+| Field | +Type | +Description | +
|---|---|---|
| text | +String | +Text of the quoted part of a message that is replied to by the given message | +
| entities | +Array of MessageEntity | +Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. | +
| position | +Integer | +Approximate quote position in the original message in UTF-16 code units as specified by the sender | +
| is_manual | +True | +Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. | +
ExternalReplyInfo
+This object contains information about a message that is being replied to, which may come from another chat or forum topic.
+| Field | +Type | +Description | +
|---|---|---|
| origin | +MessageOrigin | +Origin of the message replied to by the given message | +
| chat | +Chat | +Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. | +
| message_id | +Integer | +Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. | +
| link_preview_options | +LinkPreviewOptions | +Optional. Options used for link preview generation for the original message, if it is a text message | +
| animation | +Animation | +Optional. Message is an animation, information about the animation | +
| audio | +Audio | +Optional. Message is an audio file, information about the file | +
| document | +Document | +Optional. Message is a general file, information about the file | +
| photo | +Array of PhotoSize | +Optional. Message is a photo, available sizes of the photo | +
| sticker | +Sticker | +Optional. Message is a sticker, information about the sticker | +
| story | +Story | +Optional. Message is a forwarded story | +
| video | +Video | +Optional. Message is a video, information about the video | +
| video_note | +VideoNote | +Optional. Message is a video note, information about the video message | +
| voice | +Voice | +Optional. Message is a voice message, information about the file | +
| has_media_spoiler | +True | +Optional. True, if the message media is covered by a spoiler animation | +
| contact | +Contact | +Optional. Message is a shared contact, information about the contact | +
| dice | +Dice | +Optional. Message is a dice with random value | +
| game | +Game | +Optional. Message is a game, information about the game. More about games » | +
| giveaway | +Giveaway | +Optional. Message is a scheduled giveaway, information about the giveaway | +
| giveaway_winners | +GiveawayWinners | +Optional. A giveaway with public winners was completed | +
| invoice | +Invoice | +Optional. Message is an invoice for a payment, information about the invoice. More about payments » | +
| location | +Location | +Optional. Message is a shared location, information about the location | +
| poll | +Poll | +Optional. Message is a native poll, information about the poll | +
| venue | +Venue | +Optional. Message is a venue, information about the venue | +
ReplyParameters
+Describes reply parameters for the message that is being sent.
+| Field | +Type | +Description | +
|---|---|---|
| message_id | +Integer | +Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified | +
| chat_id | +Integer or String | +Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername) |
+
| allow_sending_without_reply | +Boolean | +Optional. Pass True if the message should be sent even if the specified message to be replied to is not found; can be used only for replies in the same chat and forum topic. | +
| quote | +String | +Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. | +
| quote_parse_mode | +String | +Optional. Mode for parsing entities in the quote. See formatting options for more details. | +
| quote_entities | +Array of MessageEntity | +Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. | +
| quote_position | +Integer | +Optional. Position of the quote in the original message in UTF-16 code units | +
MessageOrigin
+This object describes the origin of a message. It can be one of
+ +MessageOriginUser
+The message was originally sent by a known user.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the message origin, always “user” | +
| date | +Integer | +Date the message was sent originally in Unix time | +
| sender_user | +User | +User that sent the message originally | +
MessageOriginHiddenUser
+The message was originally sent by an unknown user.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the message origin, always “hidden_user” | +
| date | +Integer | +Date the message was sent originally in Unix time | +
| sender_user_name | +String | +Name of the user that sent the message originally | +
MessageOriginChat
+The message was originally sent on behalf of a chat to a group chat.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the message origin, always “chat” | +
| date | +Integer | +Date the message was sent originally in Unix time | +
| sender_chat | +Chat | +Chat that sent the message originally | +
| author_signature | +String | +Optional. For messages originally sent by an anonymous chat administrator, original message author signature | +
MessageOriginChannel
+The message was originally sent to a channel chat.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the message origin, always “channel” | +
| date | +Integer | +Date the message was sent originally in Unix time | +
| chat | +Chat | +Channel chat to which the message was originally sent | +
| message_id | +Integer | +Unique message identifier inside the chat | +
| author_signature | +String | +Optional. Signature of the original post author | +
PhotoSize
This object represents one size of a photo or a file / sticker thumbnail.
| Identifier of the request | |||||
| user_id | -Integer | -Identifier of the shared user. 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. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means. | +user_ids | +Array of Integer | +Identifiers of the shared users. These numbers may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting them. But they have at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the users and could be unable to use these identifiers, unless the users are already known to the bot by some other means. |
GiveawayCreated
+This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.
+Giveaway
+This object represents a message about a scheduled giveaway.
+| Field | +Type | +Description | +
|---|---|---|
| chats | +Array of Chat | +The list of chats which the user must join to participate in the giveaway | +
| winners_selection_date | +Integer | +Point in time (Unix timestamp) when winners of the giveaway will be selected | +
| winner_count | +Integer | +The number of users which are supposed to be selected as winners of the giveaway | +
| only_new_members | +True | +Optional. True, if only users who join the chats after the giveaway started should be eligible to win | +
| has_public_winners | +True | +Optional. True, if the list of giveaway winners will be visible to everyone | +
| prize_description | +String | +Optional. Description of additional giveaway prize | +
| country_codes | +Array of String | +Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. | +
| premium_subscription_month_count | +Integer | +Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for | +
GiveawayWinners
+This object represents a message about the completion of a giveaway with public winners.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +The chat that created the giveaway | +
| giveaway_message_id | +Integer | +Identifier of the messsage with the giveaway in the chat | +
| winners_selection_date | +Integer | +Point in time (Unix timestamp) when winners of the giveaway were selected | +
| winner_count | +Integer | +Total number of winners in the giveaway | +
| winners | +Array of User | +List of up to 100 winners of the giveaway | +
| additional_chat_count | +Integer | +Optional. The number of other chats the user had to join in order to be eligible for the giveaway | +
| premium_subscription_month_count | +Integer | +Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for | +
| unclaimed_prize_count | +Integer | +Optional. Number of undistributed prizes | +
| only_new_members | +True | +Optional. True, if only users who had joined the chats after the giveaway started were eligible to win | +
| was_refunded | +True | +Optional. True, if the giveaway was canceled because the payment for it was refunded | +
| prize_description | +String | +Optional. Description of additional giveaway prize | +
GiveawayCompleted
+This object represents a service message about the completion of a giveaway without public winners.
+| Field | +Type | +Description | +
|---|---|---|
| winner_count | +Integer | +Number of winners in the giveaway | +
| unclaimed_prize_count | +Integer | +Optional. Number of undistributed prizes | +
| giveaway_message | +Message | +Optional. Message with the giveaway that was completed, if it wasn't deleted | +
LinkPreviewOptions
+Describes the options used for link preview generation.
+| Field | +Type | +Description | +
|---|---|---|
| is_disabled | +Boolean | +Optional. True, if the link preview is disabled | +
| url | +String | +Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used | +
| prefer_small_media | +Boolean | +Optional. True, if the media in the link preview is suppposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview | +
| prefer_large_media | +Boolean | +Optional. True, if the media in the link preview is suppposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview | +
| show_above_text | +Boolean | +Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text | +
UserProfilePhotos
This object represent a user's profile pictures.
| Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed | |||||
| 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. | +request_users | +KeyboardButtonRequestUsers | +Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only. |
| request_chat | @@ -2118,8 +2806,8 @@ To learn how to create…">
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 »
+KeyboardButtonRequestUsers
+This object defines the criteria used to request suitable users. The identifiers of the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »
| request_id | Integer | -Signed 32-bit identifier of the request, which will be received back in the UserShared object. Must be unique within the message | +Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message |
| user_is_bot | Boolean | -Optional. Pass True to request a bot, pass False to request a regular user. If not specified, no additional restrictions are applied. | +Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied. |
| user_is_premium | Boolean | -Optional. Pass True to request a premium user, pass False to request a non-premium user. If not specified, no additional restrictions are applied. | +Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied. | +
| max_quantity | +Integer | +Optional. The maximum number of users to be selected; 1-10. Defaults to 1. |
ChatMemberUpdated
+This object represents changes in the status of a chat member.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +Chat the user belongs to | +
| from | +User | +Performer of the action, which resulted in the change | +
| date | +Integer | +Date the change was done in Unix time | +
| old_chat_member | +ChatMember | +Previous information about the chat member | +
| new_chat_member | +ChatMember | +New information about the chat member | +
| invite_link | +ChatInviteLink | +Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. | +
| via_chat_folder_invite_link | +Boolean | +Optional. True, if the user joined the chat via a chat folder invite link | +
ChatMember
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
-
@@ -2870,7 +3611,7 @@ To learn how to create…">
ChatMemberUpdated
-This object represents changes in the status of a chat member.
-| Field | -Type | -Description | -
|---|---|---|
| chat | -Chat | -Chat the user belongs to | -
| from | -User | -Performer of the action, which resulted in the change | -
| date | -Integer | -Date the change was done in Unix time | -
| old_chat_member | -ChatMember | -Previous information about the chat member | -
| new_chat_member | -ChatMember | -New information about the chat member | -
| invite_link | -ChatInviteLink | -Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only. | -
| via_chat_folder_invite_link | -Boolean | -Optional. True, if the user joined the chat via a chat folder invite link | -
ChatJoinRequest
Represents a join request sent to a chat.
| can_send_messages | Boolean | -Optional. True, if the user is allowed to send text messages, contacts, invoices, locations and venues | +Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues |
| can_send_audios | @@ -3192,6 +3885,162 @@ To learn how to create…">
ReactionType
+This object describes the type of a reaction. Currently, it can be one of
+ +ReactionTypeEmoji
+The reaction is based on an emoji.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the reaction, always “emoji” | +
| emoji | +String | +Reaction emoji. Currently, it can be one of " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " ", " " |
+
ReactionTypeCustomEmoji
+The reaction is based on a custom emoji.
+| Field | +Type | +Description | +
|---|---|---|
| type | +String | +Type of the reaction, always “custom_emoji” | +
| custom_emoji | +String | +Custom emoji identifier | +
ReactionCount
+Represents a reaction added to a message along with the number of times it was added.
+| Field | +Type | +Description | +
|---|---|---|
| type | +ReactionType | +Type of the reaction | +
| total_count | +Integer | +Number of times the reaction was added | +
MessageReactionUpdated
+This object represents a change of a reaction on a message performed by a user.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +The chat containing the message the user reacted to | +
| message_id | +Integer | +Unique identifier of the message inside the chat | +
| user | +User | +Optional. The user that changed the reaction, if the user isn't anonymous | +
| actor_chat | +Chat | +Optional. The chat on behalf of which the reaction was changed, if the user is anonymous | +
| date | +Integer | +Date of the change in Unix time | +
| old_reaction | +Array of ReactionType | +Previous list of reaction types that were set by the user | +
| new_reaction | +Array of ReactionType | +New list of reaction types that have been set by the user | +
MessageReactionCountUpdated
+This object represents reaction changes on a message with anonymous reactions.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +The chat containing the message | +
| message_id | +Integer | +Unique message identifier inside the chat | +
| date | +Integer | +Date of the change in Unix time | +
| reactions | +Array of ReactionCount | +List of reactions that are present on the message | +
ForumTopic
This object represents a forum topic.
ChatBoostSource
+This object describes the source of a chat boost. It can be one of
+ +ChatBoostSourcePremium
+The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.
+| Field | +Type | +Description | +
|---|---|---|
| source | +String | +Source of the boost, always “premium” | +
| user | +User | +User that boosted the chat | +
ChatBoostSourceGiftCode
+The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
+| Field | +Type | +Description | +
|---|---|---|
| source | +String | +Source of the boost, always “gift_code” | +
| user | +User | +User for which the gift code was created | +
ChatBoostSourceGiveaway
+The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.
+| Field | +Type | +Description | +
|---|---|---|
| source | +String | +Source of the boost, always “giveaway” | +
| giveaway_message_id | +Integer | +Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. | +
| user | +User | +Optional. User that won the prize in the giveaway if any | +
| is_unclaimed | +True | +Optional. True, if the giveaway was completed, but there was no user to win the prize | +
ChatBoost
+This object contains information about a chat boost.
+| Field | +Type | +Description | +
|---|---|---|
| boost_id | +String | +Unique identifier of the boost | +
| add_date | +Integer | +Point in time (Unix timestamp) when the chat was boosted | +
| expiration_date | +Integer | +Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged | +
| source | +ChatBoostSource | +Source of the added boost | +
ChatBoostUpdated
+This object represents a boost added to a chat or changed.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +Chat which was boosted | +
| boost | +ChatBoost | +Infomation about the chat boost | +
ChatBoostRemoved
+This object represents a boost removed from a chat.
+| Field | +Type | +Description | +
|---|---|---|
| chat | +Chat | +Chat which was boosted | +
| boost_id | +String | +Unique identifier of the boost | +
| remove_date | +Integer | +Point in time (Unix timestamp) when the boost was removed | +
| source | +ChatBoostSource | +Source of the removed boost | +
UserChatBoosts
+This object represents a list of boosts added to a chat by a user.
+| Field | +Type | +Description | +
|---|---|---|
| boosts | +Array of ChatBoost | +The list of boosts added to the chat by the user | +
ResponseParameters
Describes why a request was unsuccessful.
| Color identifier | Light colors | Dark colors |
|---|---|---|
| 7 | E15052 F9AE63 | FF9380 992F37 |
| 8 | E0802B FAC534 | ECB04E C35714 |
| 9 | A05FF3 F48FFF | C697FF 5E31C8 |
| 10 | 27A910 A7DC57 | A7EB6E 167E2D |
| 11 | 27ACCE 82E8D6 | 40D8D0 045C7F |
| 12 | 3391D4 7DD3F0 | 52BFFF 0B5494 |
| 13 | DD4371 FFBE9F | FF86A6 8E366E |
| 14 | 247BED F04856 FFFFFF | 3FA2FE E5424F FFFFFF |
| 15 | D67722 1EA011 FFFFFF | FF905E 32A527 FFFFFF |
| 16 | 179E42 E84A3F FFFFFF | 66D364 D5444F FFFFFF |
| 17 | 2894AF 6FC456 FFFFFF | 22BCE2 3DA240 FFFFFF |
| 18 | 0C9AB3 FFAD95 FFE6B5 | 22BCE2 FF9778 FFDA6B |
| 19 | 7757D6 F79610 FFDE8E | 9791FF F2731D FFDB59 |
| 20 | 1585CF F2AB1D FFFFFF | 3DA6EB EEA51D FFFFFF |
Profile accent colors
+Currently, the following colors in RGB format are in use for profile backgrounds.
+| Color identifier | Light colors | Dark colors |
|---|---|---|
| 0 | BA5650 | 9C4540 |
| 1 | C27C3E | 945E2C |
| 2 | 956AC8 | 715099 |
| 3 | 49A355 | 33713B |
| 4 | 3E97AD | 387E87 |
| 5 | 5A8FBB | 477194 |
| 6 | B85378 | 944763 |
| 7 | 7F8B95 | 435261 |
| 8 | C9565D D97C57 | 994343 AC583E |
| 9 | CF7244 CC9433 | 8F552F A17232 |
| 10 | 9662D4 B966B6 | 634691 9250A2 |
| 11 | 3D9755 89A650 | 296A43 5F8F44 |
| 12 | 3D95BA 50AD98 | 306C7C 3E987E |
| 13 | 538BC2 4DA8BD | 38618C 458BA1 |
| 14 | B04F74 D1666D | 884160 A65259 |
| 15 | 637482 7B8A97 | 53606E 384654 |
Inline mode objects
Objects and methods used in the inline mode are described in the Inline mode section.
Available methods
@@ -3948,10 +5038,10 @@ 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.
+The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use markdown-style or HTML-style formatting.
Note that Telegram clients will display an alert to the user before opening an inline link ('Open this link?' together with the full URL).
-Message entities can be nested, providing following restrictions are met:
- If two entities have common characters, then one of them is fully contained inside another.
- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
- All other entities can't contain each other.
Message entities can be nested, providing following restrictions are met:
- If two entities have common characters, then one of them is fully contained inside another.
- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
- blockquote entities can't be nested.
- All other entities can't contain each other.
Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username. Please note:
You can find the list of programming and markup languages for which syntax highlighting is supported at libprisma#supported-languages.
MarkdownV2 style
To use this mode, pass MarkdownV2 in the parse_mode field. Use the following syntax in your message: