diff --git a/README.md b/README.md index 0afcd35..70f7764 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,8 @@ Package docs: https://pkg.go.dev/github.com/tgbotkit/client | Package Version | API Version | API Release Date | |-----------------| --- | --- | -| latest, 0.8.0 | [10.1](https://core.telegram.org/bots/api#june-11-2026) | June 11, 2026 | +| latest, 0.9.0 | [10.2](https://core.telegram.org/bots/api#july-14-2026) | July 14, 2026 | +| 0.8.0 | [10.1](https://core.telegram.org/bots/api#june-11-2026) | June 11, 2026 | | 0.7.0 | [10.0](https://core.telegram.org/bots/api#may-8-2026) | May 8, 2026 | | 0.6.0 | [9.6](https://core.telegram.org/bots/api#april-3-2026) | April 3, 2026 | | 0.5.0, 0.5.1 | [9.5](https://core.telegram.org/bots/api#march-1-2026) | March 1, 2026 | diff --git a/api/openapi.yaml b/api/openapi.yaml index c8b7966..f8f9f9f 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: "Telegram Bot API" - version: "10.1" + version: "10.2" description: |- This OpenAPI specification was generated using the [tgbotspec](https://github.com/metalagman/tgbotspec) tool. servers: @@ -50,9 +50,8 @@ paths: type: string description: Sticker set name sticker: + type: string description: 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. - allOf: - - $ref: '#/components/schemas/InputSticker' user_id: type: integer description: User identifier of sticker set owner @@ -109,7 +108,7 @@ paths: description: Unique identifier for the query to be answered show_alert: type: boolean - description: If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. + description: If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to False. text: type: string description: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters. @@ -277,7 +276,7 @@ paths: description: 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. results: type: array - description: A JSON-serialized array of results for the inline query + description: A JSON-serialized Array of results for the inline query items: $ref: '#/components/schemas/InlineQueryResult' required: @@ -385,7 +384,7 @@ paths: description: Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) shipping_options: type: array - description: Required if ok is True. A JSON-serialized array of available shipping options. + description: Required if ok is True. A JSON-serialized Array of available shipping options. items: $ref: '#/components/schemas/ShippingOption' shipping_query_id: @@ -941,7 +940,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -951,14 +950,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -968,7 +967,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. + description: Pass True if the caption must be shown above the message media. Ignored if a new caption isn't specified. suggested_post_parameters: description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. allOf: @@ -1012,7 +1011,7 @@ paths: tags: - Available methods description: |- - Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners 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 forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. + Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners 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 forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an Array of MessageId of the sent messages is returned. requestBody: required: true content: @@ -1329,7 +1328,7 @@ paths: description: The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars. suggested_tip_amounts: type: array - description: A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. + description: A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. items: type: integer title: @@ -1420,10 +1419,8 @@ paths: type: string description: Type of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created. stickers: - type: array + type: string description: A JSON-serialized list of 1-50 initial stickers to be added to the sticker set - items: - $ref: '#/components/schemas/InputSticker' title: type: string description: Sticker set title, 1-64 characters @@ -1768,6 +1765,61 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' + /deleteEphemeralMessage: + post: + operationId: deleteEphemeralMessage + tags: + - Updating messages + description: |- + Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns True on success. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + chat_id: + type: integer + format: int64 + description: Unique identifier for the target chat or username of the target supergroup in the format @username + ephemeral_message_id: + type: integer + description: Identifier of the ephemeral message to delete + receiver_user_id: + type: integer + description: Identifier of the user who received the message + required: + - chat_id + - ephemeral_message_id + - receiver_user_id + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OkResponse' + - type: object + properties: + result: + type: boolean + default: true + required: + - result + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' /deleteForumTopic: post: operationId: deleteForumTopic @@ -2331,13 +2383,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editForumTopic: + /editEphemeralMessageCaption: post: - operationId: editForumTopic + operationId: editEphemeralMessageCaption tags: - - Available methods + - Updating messages description: |- - Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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. + Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned. requestBody: required: true content: @@ -2345,22 +2397,35 @@ paths: schema: type: object properties: + caption: + type: string + description: New caption of the message, 0-1024 characters after entities parsing + caption_entities: + type: array + description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 description: Unique identifier for the target chat or username of the target supergroup in the format @username - icon_custom_emoji_id: - type: string - description: New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept. - message_thread_id: + ephemeral_message_id: type: integer - description: Unique identifier for the target message thread of the forum topic - name: + description: Identifier of the ephemeral message to edit + parse_mode: type: string - description: New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept. + description: Mode for parsing entities in the message caption. See formatting options for more details. + receiver_user_id: + type: integer + description: Identifier of the user who received the message + reply_markup: + description: A JSON-serialized object for an inline keyboard + allOf: + - $ref: '#/components/schemas/InlineKeyboardMarkup' required: - chat_id - - message_thread_id + - ephemeral_message_id + - receiver_user_id responses: '200': description: OK @@ -2388,13 +2453,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editGeneralForumTopic: + /editEphemeralMessageMedia: post: - operationId: editGeneralForumTopic + operationId: editEphemeralMessageMedia tags: - - Available methods + - Updating messages description: |- - 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 the can_manage_topics administrator rights. Returns True on success. + Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned. requestBody: required: true content: @@ -2406,12 +2471,50 @@ paths: type: integer format: int64 description: Unique identifier for the target chat or username of the target supergroup in the format @username - name: + ephemeral_message_id: + type: integer + description: Identifier of the ephemeral message to edit + media: + description: A JSON-serialized object for the new media content of the message. A new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. + allOf: + - $ref: '#/components/schemas/InputMedia' + receiver_user_id: + type: integer + description: Identifier of the user who received the message + reply_markup: + description: A JSON-serialized object for an inline keyboard + allOf: + - $ref: '#/components/schemas/InlineKeyboardMarkup' + required: + - chat_id + - ephemeral_message_id + - media + - receiver_user_id + multipart/form-data: + schema: + type: object + properties: + chat_id: + type: integer + format: int64 + description: Unique identifier for the target chat or username of the target supergroup in the format @username + ephemeral_message_id: + type: integer + description: Identifier of the ephemeral message to edit + media: type: string - description: New topic name, 1-128 characters + description: A JSON-serialized object for the new media content of the message. A new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. + receiver_user_id: + type: integer + description: Identifier of the user who received the message + reply_markup: + type: string + description: A JSON-serialized object for an inline keyboard required: - chat_id - - name + - ephemeral_message_id + - media + - receiver_user_id responses: '200': description: OK @@ -2439,13 +2542,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageCaption: + /editEphemeralMessageReplyMarkup: post: - operationId: editMessageCaption + operationId: editEphemeralMessageReplyMarkup tags: - Updating messages description: |- - 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. + Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned. requestBody: required: true content: @@ -2453,37 +2556,24 @@ paths: schema: type: object properties: - business_connection_id: - type: string - description: Unique identifier of the business connection on behalf of which the message to be edited was sent - caption: - type: string - description: New caption of the message, 0-1024 characters after entities parsing - caption_entities: - type: array - description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 - description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. - inline_message_id: - type: string - description: Required if chat_id and message_id are not specified. Identifier of the inline message. - message_id: + description: Unique identifier for the target chat or username of the target supergroup in the format @username + ephemeral_message_id: type: integer - description: Required if inline_message_id is not specified. Identifier of the message to edit. - parse_mode: - type: string - description: Mode for parsing entities in the message caption. See formatting options for more details. + description: Identifier of the ephemeral message to edit + receiver_user_id: + type: integer + description: Identifier of the user who received the message reply_markup: description: A JSON-serialized object for an inline keyboard allOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - show_caption_above_media: - type: boolean - description: Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. + required: + - chat_id + - ephemeral_message_id + - receiver_user_id responses: '200': description: OK @@ -2495,10 +2585,8 @@ paths: - type: object properties: result: - oneOf: - - $ref: '#/components/schemas/Message' - - type: boolean - default: true + type: boolean + default: true required: - result '400': @@ -2513,13 +2601,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageChecklist: + /editEphemeralMessageText: post: - operationId: editMessageChecklist + operationId: editEphemeralMessageText tags: - Updating messages description: |- - Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. + Use this method to edit an ephemeral text message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned. requestBody: required: true content: @@ -2527,29 +2615,40 @@ paths: schema: type: object properties: - business_connection_id: - type: string - description: Unique identifier of the business connection on behalf of which the message will be sent chat_id: type: integer format: int64 - description: Unique identifier for the target chat or username of the target bot in the format @username - checklist: - description: A JSON-serialized object for the new checklist + description: Unique identifier for the target chat or username of the target supergroup in the format @username + entities: + type: array + description: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' + ephemeral_message_id: + type: integer + description: Identifier of the ephemeral message to edit + link_preview_options: + description: Link preview generation options for the message allOf: - - $ref: '#/components/schemas/InputChecklist' - message_id: + - $ref: '#/components/schemas/LinkPreviewOptions' + parse_mode: + type: string + description: Mode for parsing entities in the message text. See formatting options for more details. + receiver_user_id: type: integer - description: Unique identifier for the target message + description: Identifier of the user who received the message reply_markup: - description: A JSON-serialized object for the new inline keyboard for the message + description: A JSON-serialized object for an inline keyboard allOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' + text: + type: string + description: New text of the message, 1-4096 characters after entity parsing required: - - business_connection_id - chat_id - - checklist - - message_id + - ephemeral_message_id + - receiver_user_id + - text responses: '200': description: OK @@ -2561,7 +2660,8 @@ paths: - type: object properties: result: - $ref: '#/components/schemas/Message' + type: boolean + default: true required: - result '400': @@ -2576,13 +2676,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageLiveLocation: + /editForumTopic: post: - operationId: editMessageLiveLocation + operationId: editForumTopic tags: - - Updating messages + - Available methods description: |- - 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. + Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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. requestBody: required: true content: @@ -2590,44 +2690,22 @@ paths: schema: type: object properties: - business_connection_id: - type: string - description: Unique identifier of the business connection on behalf of which the message to be edited was sent chat_id: type: integer format: int64 - description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. - heading: - type: integer - description: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. - horizontal_accuracy: - type: number - description: The radius of uncertainty for the location, measured in meters; 0-1500 - inline_message_id: + description: Unique identifier for the target chat or username of the target supergroup in the format @username + icon_custom_emoji_id: type: string - description: Required if chat_id and message_id are not specified. Identifier of the inline message. - latitude: - type: number - description: Latitude of new location - live_period: - type: integer - description: New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged. - longitude: - type: number - description: Longitude of new location - message_id: - type: integer - description: Required if inline_message_id is not specified. Identifier of the message to edit. - proximity_alert_radius: + description: New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept. + message_thread_id: type: integer - description: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. - reply_markup: - description: A JSON-serialized object for a new inline keyboard - allOf: - - $ref: '#/components/schemas/InlineKeyboardMarkup' + description: Unique identifier for the target message thread of the forum topic + name: + type: string + description: New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept. required: - - latitude - - longitude + - chat_id + - message_thread_id responses: '200': description: OK @@ -2639,10 +2717,8 @@ paths: - type: object properties: result: - oneOf: - - $ref: '#/components/schemas/Message' - - type: boolean - default: true + type: boolean + default: true required: - result '400': @@ -2657,13 +2733,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageMedia: + /editGeneralForumTopic: post: - operationId: editMessageMedia + operationId: editGeneralForumTopic tags: - - Updating messages + - Available methods description: |- - Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. 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, a live 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. + 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 the can_manage_topics administrator rights. Returns True on success. requestBody: required: true content: @@ -2671,56 +2747,16 @@ paths: schema: type: object properties: - business_connection_id: - type: string - description: Unique identifier of the business connection on behalf of which the message to be edited was sent chat_id: type: integer format: int64 - description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. - inline_message_id: - type: string - description: Required if chat_id and message_id are not specified. Identifier of the inline message. - media: - description: A JSON-serialized object for a new media content of the message - allOf: - - $ref: '#/components/schemas/InputMedia' - message_id: - type: integer - description: Required if inline_message_id is not specified. Identifier of the message to edit. - reply_markup: - description: A JSON-serialized object for a new inline keyboard - allOf: - - $ref: '#/components/schemas/InlineKeyboardMarkup' - required: - - media - multipart/form-data: - schema: - type: object - properties: - business_connection_id: - type: string - description: Unique identifier of the business connection on behalf of which the message to be edited was sent - chat_id: - type: integer - format: int64 - description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. - inline_message_id: + description: Unique identifier for the target chat or username of the target supergroup in the format @username + name: type: string - description: Required if chat_id and message_id are not specified. Identifier of the inline message. - media: - description: A JSON-serialized object for a new media content of the message - allOf: - - $ref: '#/components/schemas/InputMedia' - message_id: - type: integer - description: Required if inline_message_id is not specified. Identifier of the message to edit. - reply_markup: - description: A JSON-serialized object for a new inline keyboard - allOf: - - $ref: '#/components/schemas/InlineKeyboardMarkup' + description: New topic name, 1-128 characters required: - - media + - chat_id + - name responses: '200': description: OK @@ -2732,10 +2768,8 @@ paths: - type: object properties: result: - oneOf: - - $ref: '#/components/schemas/Message' - - type: boolean - default: true + type: boolean + default: true required: - result '400': @@ -2750,13 +2784,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageReplyMarkup: + /editMessageCaption: post: - operationId: editMessageReplyMarkup + operationId: editMessageCaption tags: - Updating messages description: |- - 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. + 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. requestBody: required: true content: @@ -2767,6 +2801,14 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message to be edited was sent + caption: + type: string + description: New caption of the message, 0-1024 characters after entities parsing + caption_entities: + type: array + description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -2777,10 +2819,16 @@ paths: message_id: type: integer description: Required if inline_message_id is not specified. Identifier of the message to edit. + parse_mode: + type: string + description: Mode for parsing entities in the message caption. See formatting options for more details. reply_markup: description: A JSON-serialized object for an inline keyboard allOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' + show_caption_above_media: + type: boolean + description: Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages. responses: '200': description: OK @@ -2810,13 +2858,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editMessageText: + /editMessageChecklist: post: - operationId: editMessageText + operationId: editMessageChecklist tags: - Updating messages description: |- - Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. + Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. requestBody: required: true content: @@ -2826,40 +2874,27 @@ paths: properties: business_connection_id: type: string - description: Unique identifier of the business connection on behalf of which the message to be edited was sent + description: Unique identifier of the business connection on behalf of which the message will be sent chat_id: type: integer format: int64 - description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. - entities: - type: array - description: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' - inline_message_id: - type: string - description: Required if chat_id and message_id are not specified. Identifier of the inline message. - link_preview_options: - description: Link preview generation options for the message + description: Unique identifier for the target chat or username of the target bot in the format @username + checklist: + description: A JSON-serialized object for the new checklist allOf: - - $ref: '#/components/schemas/LinkPreviewOptions' + - $ref: '#/components/schemas/InputChecklist' message_id: type: integer - description: Required if inline_message_id is not specified. Identifier of the message to edit. - parse_mode: - type: string - description: Mode for parsing entities in the message text. See formatting options for more details. + description: Unique identifier for the target message reply_markup: - description: A JSON-serialized object for an inline keyboard + description: A JSON-serialized object for the new inline keyboard for the message allOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - rich_message: - description: New rich content of the message; required if text isn't specified - allOf: - - $ref: '#/components/schemas/InputRichMessage' - text: - type: string - description: New text of the message, 1-4096 characters after entity parsing; required if rich_message isn't specified + required: + - business_connection_id + - chat_id + - checklist + - message_id responses: '200': description: OK @@ -2871,10 +2906,7 @@ paths: - type: object properties: result: - oneOf: - - $ref: '#/components/schemas/Message' - - type: boolean - default: true + $ref: '#/components/schemas/Message' required: - result '400': @@ -2889,13 +2921,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editStory: + /editMessageLiveLocation: post: - operationId: editStory + operationId: editMessageLiveLocation tags: - - Available methods + - Updating messages description: |- - Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success. + 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. requestBody: required: true content: @@ -2903,36 +2935,44 @@ paths: schema: type: object properties: - areas: - type: array - description: A JSON-serialized list of clickable areas to be shown on the story - items: - $ref: '#/components/schemas/StoryArea' business_connection_id: type: string - description: Unique identifier of the business connection - caption: - type: string - description: Caption of the story, 0-2048 characters after entities parsing - caption_entities: - type: array - description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' - content: - description: Content of the story - allOf: - - $ref: '#/components/schemas/InputStoryContent' - parse_mode: + description: Unique identifier of the business connection on behalf of which the message to be edited was sent + chat_id: + type: integer + format: int64 + description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. + heading: + type: integer + description: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. + horizontal_accuracy: + type: number + description: The radius of uncertainty for the location, measured in meters; 0-1500 + inline_message_id: type: string - description: Mode for parsing entities in the story caption. See formatting options for more details. - story_id: + description: Required if chat_id and message_id are not specified. Identifier of the inline message. + latitude: + type: number + description: Latitude of new location + live_period: type: integer - description: Unique identifier of the story to edit + description: New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged. + longitude: + type: number + description: Longitude of new location + message_id: + type: integer + description: Required if inline_message_id is not specified. Identifier of the message to edit. + proximity_alert_radius: + type: integer + description: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + reply_markup: + description: A JSON-serialized object for a new inline keyboard + allOf: + - $ref: '#/components/schemas/InlineKeyboardMarkup' required: - - business_connection_id - - content - - story_id + - latitude + - longitude responses: '200': description: OK @@ -2944,7 +2984,10 @@ paths: - type: object properties: result: - $ref: '#/components/schemas/Story' + oneOf: + - $ref: '#/components/schemas/Message' + - type: boolean + default: true required: - result '400': @@ -2959,13 +3002,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /editUserStarSubscription: + /editMessageMedia: post: - operationId: editUserStarSubscription + operationId: editMessageMedia tags: - - Payments + - Updating messages description: |- - Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success. + Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. 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, a live 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. requestBody: required: true content: @@ -2973,19 +3016,54 @@ paths: schema: type: object properties: - is_canceled: - type: boolean - description: Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. - telegram_payment_charge_id: + business_connection_id: type: string - description: Telegram payment identifier for the subscription - user_id: + description: Unique identifier of the business connection on behalf of which the message to be edited was sent + chat_id: type: integer - description: Identifier of the user whose subscription will be edited + format: int64 + description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. + inline_message_id: + type: string + description: Required if chat_id and message_id are not specified. Identifier of the inline message. + media: + description: A JSON-serialized object for the new media content of the message + allOf: + - $ref: '#/components/schemas/InputMedia' + message_id: + type: integer + description: Required if inline_message_id is not specified. Identifier of the message to edit. + reply_markup: + description: A JSON-serialized object for a new inline keyboard + allOf: + - $ref: '#/components/schemas/InlineKeyboardMarkup' required: - - is_canceled - - telegram_payment_charge_id - - user_id + - media + multipart/form-data: + schema: + type: object + properties: + business_connection_id: + type: string + description: Unique identifier of the business connection on behalf of which the message to be edited was sent + chat_id: + type: integer + format: int64 + description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. + inline_message_id: + type: string + description: Required if chat_id and message_id are not specified. Identifier of the inline message. + media: + type: string + description: A JSON-serialized object for the new media content of the message + message_id: + type: integer + description: Required if inline_message_id is not specified. Identifier of the message to edit. + reply_markup: + type: string + description: A JSON-serialized object for a new inline keyboard + required: + - media responses: '200': description: OK @@ -2997,8 +3075,10 @@ paths: - type: object properties: result: - type: boolean - default: true + oneOf: + - $ref: '#/components/schemas/Message' + - type: boolean + default: true required: - result '400': @@ -3013,13 +3093,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /exportChatInviteLink: + /editMessageReplyMarkup: post: - operationId: exportChatInviteLink + operationId: editMessageReplyMarkup tags: - - Available methods + - Updating messages description: |- - 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. + 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. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. requestBody: required: true content: @@ -3027,12 +3107,23 @@ paths: schema: type: object properties: + business_connection_id: + type: string + description: Unique identifier of the business connection on behalf of which the message to be edited was sent chat_id: type: integer format: int64 - description: Unique identifier for the target chat or username of the target channel in the format @username - required: - - chat_id + description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. + inline_message_id: + type: string + description: Required if chat_id and message_id are not specified. Identifier of the inline message. + message_id: + type: integer + description: Required if inline_message_id is not specified. Identifier of the message to edit. + reply_markup: + description: A JSON-serialized object for an inline keyboard + allOf: + - $ref: '#/components/schemas/InlineKeyboardMarkup' responses: '200': description: OK @@ -3044,7 +3135,10 @@ paths: - type: object properties: result: - type: string + oneOf: + - $ref: '#/components/schemas/Message' + - type: boolean + default: true required: - result '400': @@ -3059,13 +3153,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /forwardMessage: + /editMessageText: post: - operationId: forwardMessage + operationId: editMessageText tags: - - Available methods + - Updating messages description: |- - Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned. + Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent. requestBody: required: true content: @@ -3073,43 +3167,42 @@ paths: schema: type: object properties: + business_connection_id: + type: string + description: Unique identifier of the business connection on behalf of which the message to be edited was sent chat_id: type: integer format: int64 - description: Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username - direct_messages_topic_id: - type: integer - description: Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat - disable_notification: - type: boolean - description: Sends the message silently. Users will receive a notification with no sound. - from_chat_id: - type: integer - format: int64 - description: Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) - message_effect_id: + description: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. + entities: + type: array + description: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' + inline_message_id: type: string - description: Unique identifier of the message effect to be added to the message; only available when forwarding to private chats + description: Required if chat_id and message_id are not specified. Identifier of the inline message. + link_preview_options: + description: Link preview generation options for the message + allOf: + - $ref: '#/components/schemas/LinkPreviewOptions' message_id: type: integer - description: Message identifier in the chat specified in from_chat_id - message_thread_id: - type: integer - description: Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only - protect_content: - type: boolean - description: Protects the contents of the forwarded message from forwarding and saving - suggested_post_parameters: - description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only + description: Required if inline_message_id is not specified. Identifier of the message to edit. + parse_mode: + type: string + description: Mode for parsing entities in the message text. See formatting options for more details. + reply_markup: + description: A JSON-serialized object for an inline keyboard allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' - video_start_timestamp: - type: integer - description: New start timestamp for the forwarded video in the message - required: - - chat_id - - from_chat_id - - message_id + - $ref: '#/components/schemas/InlineKeyboardMarkup' + rich_message: + description: New rich content of the message; required if text isn't specified. Direct upload of new files isn't supported when an inline message is edited. + allOf: + - $ref: '#/components/schemas/InputRichMessage' + text: + type: string + description: New text of the message, 1-4096 characters after entity parsing; required if rich_message isn't specified responses: '200': description: OK @@ -3121,7 +3214,10 @@ paths: - type: object properties: result: - $ref: '#/components/schemas/Message' + oneOf: + - $ref: '#/components/schemas/Message' + - type: boolean + default: true required: - result '400': @@ -3136,13 +3232,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /forwardMessages: + /editStory: post: - operationId: forwardMessages + operationId: editStory tags: - Available methods description: |- - Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned. + Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success. requestBody: required: true content: @@ -3150,35 +3246,36 @@ paths: schema: type: object properties: - chat_id: - type: integer - format: int64 - description: Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username - direct_messages_topic_id: - type: integer - description: Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat - disable_notification: - type: boolean - description: Sends the messages silently. Users will receive a notification with no sound. - from_chat_id: - type: integer - format: int64 - description: Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) - message_ids: + areas: type: array - description: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. + description: A JSON-serialized list of clickable areas to be shown on the story items: - type: integer - message_thread_id: + $ref: '#/components/schemas/StoryArea' + business_connection_id: + type: string + description: Unique identifier of the business connection + caption: + type: string + description: Caption of the story, 0-2048 characters after entities parsing + caption_entities: + type: array + description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' + content: + description: Content of the story + allOf: + - $ref: '#/components/schemas/InputStoryContent' + parse_mode: + type: string + description: Mode for parsing entities in the story caption. See formatting options for more details. + story_id: type: integer - description: Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only - protect_content: - type: boolean - description: Protects the contents of the forwarded messages from forwarding and saving + description: Unique identifier of the story to edit required: - - chat_id - - from_chat_id - - message_ids + - business_connection_id + - content + - story_id responses: '200': description: OK @@ -3190,9 +3287,7 @@ paths: - type: object properties: result: - type: array - items: - $ref: '#/components/schemas/MessageId' + $ref: '#/components/schemas/Story' required: - result '400': @@ -3207,13 +3302,33 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /getAvailableGifts: + /editUserStarSubscription: post: - operationId: getAvailableGifts + operationId: editUserStarSubscription tags: - - Available methods + - Payments description: |- - Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object. + Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + is_canceled: + type: boolean + description: Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. + telegram_payment_charge_id: + type: string + description: Telegram payment identifier for the subscription + user_id: + type: integer + description: Identifier of the user whose subscription will be edited + required: + - is_canceled + - telegram_payment_charge_id + - user_id responses: '200': description: OK @@ -3225,7 +3340,8 @@ paths: - type: object properties: result: - $ref: '#/components/schemas/Gifts' + type: boolean + default: true required: - result '400': @@ -3240,13 +3356,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /getBusinessAccountGifts: + /exportChatInviteLink: post: - operationId: getBusinessAccountGifts + operationId: exportChatInviteLink tags: - Available methods description: |- - Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success. + 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. requestBody: required: true content: @@ -3254,41 +3370,12 @@ paths: schema: type: object properties: - business_connection_id: - type: string - description: Unique identifier of the business connection - exclude_from_blockchain: - type: boolean - description: Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram - exclude_limited_non_upgradable: - type: boolean - description: Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique - exclude_limited_upgradable: - type: boolean - description: Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique - exclude_saved: - type: boolean - description: Pass True to exclude gifts that are saved to the account's profile page - exclude_unique: - type: boolean - description: Pass True to exclude unique gifts - exclude_unlimited: - type: boolean - description: Pass True to exclude gifts that can be purchased an unlimited number of times - exclude_unsaved: - type: boolean - description: Pass True to exclude gifts that aren't saved to the account's profile page - limit: + chat_id: type: integer - description: The maximum number of gifts to be returned; 1-100. Defaults to 100. - offset: - type: string - description: Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results - sort_by_price: - type: boolean - description: Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. + format: int64 + description: Unique identifier for the target chat or username of the target channel in the format @username required: - - business_connection_id + - chat_id responses: '200': description: OK @@ -3300,7 +3387,7 @@ paths: - type: object properties: result: - $ref: '#/components/schemas/OwnedGifts' + type: string required: - result '400': @@ -3315,13 +3402,13 @@ paths: application/json: schema: $ref: '#/components/schemas/ErrorResponse' - /getBusinessAccountStarBalance: + /forwardMessage: post: - operationId: getBusinessAccountStarBalance + operationId: forwardMessage tags: - Available methods description: |- - Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success. + Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned. requestBody: required: true content: @@ -3329,7 +3416,263 @@ paths: schema: type: object properties: - business_connection_id: + chat_id: + type: integer + format: int64 + description: Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username + direct_messages_topic_id: + type: integer + description: Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat + disable_notification: + type: boolean + description: Sends the message silently. Users will receive a notification with no sound. + from_chat_id: + type: integer + format: int64 + description: Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) + message_effect_id: + type: string + description: Unique identifier of the message effect to be added to the message; only available when forwarding to private chats + message_id: + type: integer + description: Message identifier in the chat specified in from_chat_id + message_thread_id: + type: integer + description: Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only + protect_content: + type: boolean + description: Protects the contents of the forwarded message from forwarding and saving + suggested_post_parameters: + description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only + allOf: + - $ref: '#/components/schemas/SuggestedPostParameters' + video_start_timestamp: + type: integer + description: New start timestamp for the forwarded video in the message + required: + - chat_id + - from_chat_id + - message_id + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OkResponse' + - type: object + properties: + result: + $ref: '#/components/schemas/Message' + required: + - result + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /forwardMessages: + post: + operationId: forwardMessages + tags: + - Available methods + description: |- + Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an Array of MessageId of the sent messages is returned. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + chat_id: + type: integer + format: int64 + description: Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username + direct_messages_topic_id: + type: integer + description: Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat + disable_notification: + type: boolean + description: Sends the messages silently. Users will receive a notification with no sound. + from_chat_id: + type: integer + format: int64 + description: Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) + message_ids: + type: array + description: A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. + items: + type: integer + message_thread_id: + type: integer + description: Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only + protect_content: + type: boolean + description: Protects the contents of the forwarded messages from forwarding and saving + required: + - chat_id + - from_chat_id + - message_ids + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OkResponse' + - type: object + properties: + result: + type: array + items: + $ref: '#/components/schemas/MessageId' + required: + - result + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /getAvailableGifts: + post: + operationId: getAvailableGifts + tags: + - Available methods + description: |- + Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object. + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OkResponse' + - type: object + properties: + result: + $ref: '#/components/schemas/Gifts' + required: + - result + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /getBusinessAccountGifts: + post: + operationId: getBusinessAccountGifts + tags: + - Available methods + description: |- + Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + business_connection_id: + type: string + description: Unique identifier of the business connection + exclude_from_blockchain: + type: boolean + description: Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram + exclude_limited_non_upgradable: + type: boolean + description: Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique + exclude_limited_upgradable: + type: boolean + description: Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique + exclude_saved: + type: boolean + description: Pass True to exclude gifts that are saved to the account's profile page + exclude_unique: + type: boolean + description: Pass True to exclude unique gifts + exclude_unlimited: + type: boolean + description: Pass True to exclude gifts that can be purchased an unlimited number of times + exclude_unsaved: + type: boolean + description: Pass True to exclude gifts that aren't saved to the account's profile page + limit: + type: integer + description: The maximum number of gifts to be returned; 1-100. Defaults to 100. + offset: + type: string + description: Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results + sort_by_price: + type: boolean + description: Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. + required: + - business_connection_id + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/OkResponse' + - type: object + properties: + result: + $ref: '#/components/schemas/OwnedGifts' + required: + - result + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /getBusinessAccountStarBalance: + post: + operationId: getBusinessAccountStarBalance + tags: + - Available methods + description: |- + Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + business_connection_id: type: string description: Unique identifier of the business connection required: @@ -3634,7 +3977,7 @@ paths: tags: - Available methods description: |- - Use this method to get the number of members in a chat. Returns Int on success. + Use this method to get the number of members in a chat. Returns Integer on success. requestBody: required: true content: @@ -4554,7 +4897,7 @@ paths: tags: - Available methods description: |- - Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an array of Message objects is returned. + Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an Array of Message objects is returned. requestBody: required: true content: @@ -5629,9 +5972,8 @@ paths: type: string description: File identifier of the replaced sticker sticker: + type: string description: 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 remains unchanged. - allOf: - - $ref: '#/components/schemas/InputSticker' user_id: type: integer description: User identifier of the sticker set owner @@ -5978,6 +6320,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing @@ -6017,6 +6362,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6037,7 +6385,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6047,14 +6395,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6064,7 +6412,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. allOf: @@ -6092,14 +6440,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -6131,6 +6480,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6151,7 +6503,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6161,14 +6513,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6178,11 +6530,10 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' thumbnail: type: string format: binary @@ -6243,6 +6594,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Audio caption, 0-1024 characters after entities parsing @@ -6279,6 +6633,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6299,7 +6656,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6309,14 +6666,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6351,14 +6708,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Audio caption, 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -6387,6 +6745,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6407,7 +6768,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6417,14 +6778,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6433,9 +6794,8 @@ paths: allOf: - $ref: '#/components/schemas/ReplyParameters' suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' thumbnail: type: string format: binary @@ -6536,7 +6896,7 @@ paths: tags: - Available methods description: |- - Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Returns True on success. + Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join request query based on the user interaction with the Mini App. Returns True on success. requestBody: required: true content: @@ -6549,7 +6909,7 @@ paths: description: Unique identifier of the join request query web_app_url: type: string - description: The URL of the Mini App to be opened + description: An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps required: - chat_join_request_query_id - web_app_url @@ -6672,6 +7032,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -6700,6 +7063,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6720,7 +7086,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6730,14 +7096,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6844,7 +7210,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6854,14 +7220,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -6921,6 +7287,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing @@ -6957,6 +7326,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -6977,7 +7349,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -6987,14 +7359,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -7022,14 +7394,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -7059,6 +7432,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -7079,7 +7455,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -7089,14 +7465,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -7105,9 +7481,8 @@ paths: allOf: - $ref: '#/components/schemas/ReplyParameters' suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' thumbnail: type: string format: binary @@ -7393,7 +7768,7 @@ paths: - $ref: '#/components/schemas/SuggestedPostParameters' suggested_tip_amounts: type: array - description: A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. + description: A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. items: type: integer title: @@ -7452,6 +7827,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing @@ -7491,6 +7869,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -7511,7 +7892,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -7521,14 +7902,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -7538,7 +7919,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. allOf: @@ -7557,14 +7938,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -7598,6 +7980,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -7618,7 +8003,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -7628,14 +8013,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -7645,11 +8030,10 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' required: - chat_id - live_photo @@ -7700,6 +8084,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -7721,7 +8108,7 @@ paths: description: Latitude of the location live_period: type: integer - description: Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely + description: Period in seconds during which the location will be updated (see Live Locations), must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0 for ephemeral messages. longitude: type: number description: Longitude of the location @@ -7737,6 +8124,9 @@ paths: proximity_alert_radius: type: integer description: For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -7757,7 +8147,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -7767,14 +8157,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -7822,7 +8212,7 @@ paths: tags: - Available methods description: |- - Use this method to send a group of photos, live 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 Message objects that were sent is returned. + Use this method to send a group of photos, live 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 Message objects that were sent is returned. requestBody: required: true content: @@ -7848,7 +8238,7 @@ paths: description: Sends messages silently. Users will receive a notification with no sound. media: type: array - description: A JSON-serialized array describing messages to be sent, must include 2-10 items + description: A JSON-serialized Array describing messages to be sent, must include 2-10 items items: $ref: '#/components/schemas/InputMedia' message_effect_id: @@ -7888,10 +8278,8 @@ paths: type: boolean description: Sends messages silently. Users will receive a notification with no sound. media: - type: array - description: A JSON-serialized array describing messages to be sent, must include 2-10 items - items: - $ref: '#/components/schemas/InputMedia' + type: string + description: A JSON-serialized Array describing messages to be sent, must include 2-10 items message_effect_id: type: string description: Unique identifier of the message effect to be added to the message; for private chats only @@ -7956,6 +8344,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -7987,6 +8378,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -8007,7 +8401,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8017,14 +8411,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8088,7 +8482,7 @@ paths: description: Unique identifier for the target private chat draft_id: type: integer - description: Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated. + description: Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. entities: type: array description: A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode @@ -8173,7 +8567,7 @@ paths: description: Sends the message silently. Users will receive a notification with no sound. media: type: array - description: A JSON-serialized array describing the media to be sent; up to 10 items + description: A JSON-serialized Array describing the media to be sent; up to 10 items items: $ref: '#/components/schemas/InputPaidMedia' message_thread_id: @@ -8208,7 +8602,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8218,14 +8612,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8235,7 +8629,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media star_count: type: integer description: The number of Telegram Stars that must be paid to buy access to the media; 1-25000 @@ -8293,6 +8687,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing @@ -8329,6 +8726,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -8349,7 +8749,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8359,14 +8759,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8376,7 +8776,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. allOf: @@ -8394,14 +8794,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -8431,6 +8832,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -8451,7 +8855,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8461,14 +8865,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8478,11 +8882,10 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' required: - chat_id - photo @@ -8528,16 +8931,16 @@ paths: properties: allow_adding_options: type: boolean - description: Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes + description: Pass True if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes allow_paid_broadcast: type: boolean description: Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. allows_multiple_answers: type: boolean - description: Pass True, if the poll allows multiple answers, defaults to False + description: Pass True if the poll allows multiple answers, defaults to False allows_revoting: type: boolean - description: Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls + description: Pass True if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent @@ -8589,7 +8992,7 @@ paths: description: Mode for parsing entities in the explanation. See formatting options for more details. hide_results_until_closes: type: boolean - description: Pass True, if poll results must be shown only after the poll closes + description: Pass True if poll results must be shown only after the poll closes is_anonymous: type: boolean description: True, if the poll needs to be anonymous, defaults to True @@ -8602,7 +9005,7 @@ paths: - $ref: '#/components/schemas/InputPollMedia' members_only: type: boolean - description: Pass True, if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only + description: Pass True if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only message_effect_id: type: string description: Unique identifier of the message effect to be added to the message; for private chats only @@ -8651,7 +9054,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8661,14 +9064,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8678,7 +9081,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' shuffle_options: type: boolean - description: Pass True, if the poll options must be shown in random order + description: Pass True if the poll options must be shown in random order type: type: string description: Poll type, “quiz” or “regular”, defaults to “regular” @@ -8731,7 +9134,7 @@ paths: description: Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. business_connection_id: type: string - description: Unique identifier of the business connection on behalf of which the message will be sent + description: Unique identifier of the business connection on behalf of which the message will be sent. Bot can send rich messages on behalf of a business account only if the corresponding user can send rich messages. chat_id: type: integer format: int64 @@ -8771,7 +9174,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8781,14 +9184,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8858,7 +9261,7 @@ paths: type: integer description: Unique identifier for the target message thread rich_message: - description: The partial message to be streamed + description: The partial message to be streamed. Direct upload of new files isn't supported. allOf: - $ref: '#/components/schemas/InputRichMessage' required: @@ -8912,6 +9315,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -8934,6 +9340,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -8954,7 +9363,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -8964,14 +9373,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -8999,6 +9408,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -9021,6 +9433,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9041,7 +9456,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9051,14 +9466,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9071,9 +9486,8 @@ paths: format: binary description: 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, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL. suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' required: - chat_id - sticker @@ -9126,6 +9540,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -9163,6 +9580,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9183,7 +9603,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9193,14 +9613,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9267,6 +9687,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing @@ -9309,6 +9732,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9329,7 +9755,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9339,14 +9765,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9356,7 +9782,7 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media start_timestamp: type: integer description: Start timestamp for the video in the message @@ -9389,14 +9815,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -9432,6 +9859,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9452,7 +9882,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9462,14 +9892,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9479,14 +9909,13 @@ paths: - $ref: '#/components/schemas/ReplyParameters' show_caption_above_media: type: boolean - description: Pass True, if the caption must be shown above the message media + description: Pass True if the caption must be shown above the message media start_timestamp: type: integer description: Start timestamp for the video in the message suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' supports_streaming: type: boolean description: Pass True if the uploaded video is suitable for streaming @@ -9550,6 +9979,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -9575,6 +10007,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9595,7 +10030,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9605,14 +10040,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9643,6 +10078,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any chat_id: type: integer format: int64 @@ -9668,6 +10106,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9688,7 +10129,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9698,14 +10139,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9714,9 +10155,8 @@ paths: allOf: - $ref: '#/components/schemas/ReplyParameters' suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' thumbnail: type: string format: binary @@ -9774,6 +10214,9 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Voice message caption, 0-1024 characters after entities parsing @@ -9807,6 +10250,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9827,7 +10273,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9837,14 +10283,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9872,14 +10318,15 @@ paths: business_connection_id: type: string description: Unique identifier of the business connection on behalf of which the message will be sent + callback_query_id: + type: string + description: For outgoing ephemeral messages, identifier of the callback query which triggerred the message if any caption: type: string description: Voice message caption, 0-1024 characters after entities parsing caption_entities: - type: array + type: string description: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode - items: - $ref: '#/components/schemas/MessageEntity' chat_id: type: integer format: int64 @@ -9905,6 +10352,9 @@ paths: protect_content: type: boolean description: Protects the contents of the sent message from forwarding and saving + receiver_user_id: + type: integer + description: For outgoing ephemeral messages, unique identifier of the user who will receive the message; for group and supergroup chats only. It is not guaranteed that the user will receive the message, especially if they are offline. See ephemeral message sending for more details. reply_markup: type: object description: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. @@ -9925,7 +10375,7 @@ paths: description: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters is_persistent: type: boolean - description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon. + description: Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to False, in which case the custom keyboard can be hidden and opened with a keyboard icon. keyboard: type: array description: Array of button rows, each represented by an Array of KeyboardButton objects @@ -9935,14 +10385,14 @@ paths: $ref: '#/components/schemas/KeyboardButton' one_time_keyboard: type: boolean - description: 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. + description: 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. remove_keyboard: type: boolean description: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup) default: true resize_keyboard: type: boolean - description: 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. + description: 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. selective: type: boolean description: '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 to a message in the same chat and forum topic, sender of the original message.' @@ -9951,9 +10401,8 @@ paths: allOf: - $ref: '#/components/schemas/ReplyParameters' suggested_post_parameters: + type: string description: A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. - allOf: - - $ref: '#/components/schemas/SuggestedPostParameters' voice: type: string format: binary @@ -10059,7 +10508,7 @@ paths: description: Unique identifier of the business connection show_gift_button: type: boolean - description: Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field + description: Pass True if a button for sending a gift to the user or by the business account must always be shown in the input field required: - accepted_gift_types - business_connection_id @@ -10807,12 +11256,12 @@ paths: properties: added_user_ids: type: array - description: A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is false. + description: A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is False. items: type: integer is_access_restricted: type: boolean - description: Pass True, if only selected users can access the bot. The bot's owner can always access it. + description: Pass True if only selected users can access the bot. The bot's owner can always access it. user_id: type: integer description: User identifier of the managed bot whose access settings will be changed @@ -11213,7 +11662,7 @@ paths: properties: errors: type: array - description: A JSON-serialized array describing the errors + description: A JSON-serialized Array describing the errors items: $ref: '#/components/schemas/PassportElementError' user_id: @@ -11674,10 +12123,8 @@ paths: type: object properties: allowed_updates: - type: array + type: string description: 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, 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. - items: - type: string certificate: type: string format: binary @@ -12895,6 +13342,9 @@ components: description: type: string description: Description of the command; 1-256 characters + is_ephemeral: + type: boolean + description: Optional. True, if the command sends an ephemeral message, which can be seen only by the sender of the message and the bot required: - command - description @@ -13050,6 +13500,27 @@ components: description: The bot's short description required: - short_description + BotSubscriptionUpdated: + type: object + description: |- + This object contains information about changes to a user payment subscription toward the current bot. + x-tags: + - Available types + properties: + user: + description: User who subscribed for payments toward the bot + allOf: + - $ref: '#/components/schemas/User' + invoice_payload: + type: string + description: Bot-specified invoice payload + state: + type: string + description: The new state of the subscription. Currently, it can be one of “canceled” if the user canceled the subscription, “active” if the user re-enabled a previously canceled subscription, or “failed” if payment for the subscription failed. + required: + - user + - invoice_payload + - state BusinessBotRights: type: object description: |- @@ -13371,7 +13842,7 @@ components: description: Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only can_manage_tags: type: boolean - description: Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. + description: Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages. required: - is_anonymous - can_manage_chat @@ -13744,6 +14215,10 @@ components: description: Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators. allOf: - $ref: '#/components/schemas/User' + community: + description: Optional. The Community to which the chat belongs + allOf: + - $ref: '#/components/schemas/Community' required: - id - type @@ -13828,7 +14303,7 @@ components: - $ref: '#/components/schemas/ChatInviteLink' query_id: type: string - description: Optional. Identifier of the join request query. If present, then the bot must call sendChatJoinRequestWebApp or directly call answerChatJoinRequestQuery within 10 seconds. + description: Optional. Identifier of the join request query; for bots assigned to process join requests only. If present, then the bot must call sendChatJoinRequestWebApp or directly call answerChatJoinRequestQuery within 10 seconds. required: - chat - from @@ -13930,7 +14405,7 @@ components: description: Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only can_manage_tags: type: boolean - description: Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages. + description: Optional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted, defaults to the value of can_pin_messages. custom_title: type: string description: Optional. Custom title for this user @@ -14246,7 +14721,7 @@ components: description: Optional. True, if the user is allowed to pin messages. Ignored in public supergroups. can_manage_topics: type: boolean - description: Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages. + description: Optional. True, if the user is allowed to create forum topics. If omitted, defaults to the value of can_pin_messages. ChatPhoto: type: object description: |- @@ -14429,6 +14904,42 @@ components: - result_id - from - query + Community: + type: object + description: |- + Represents a community (a group of chats). + x-tags: + - Available types + properties: + id: + type: integer + format: int64 + description: Unique identifier for this community. 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 signed 64-bit integer or double-precision float type are safe for storing this identifier. + name: + type: string + description: Name of the community + required: + - id + - name + CommunityChatAdded: + type: object + description: |- + Describes a service message about a chat being added to a community. + x-tags: + - Available types + properties: + community: + description: The new community to which the chat belongs + allOf: + - $ref: '#/components/schemas/Community' + required: + - community + CommunityChatRemoved: + type: object + description: |- + Describes a service message about a chat being removed from a community. Currently holds no information. + x-tags: + - Available types Contact: type: object description: |- @@ -14492,7 +15003,7 @@ components: properties: are_direct_messages_enabled: type: boolean - description: True, if direct messages are enabled for the channel chat; false otherwise + description: True, if direct messages are enabled for the channel chat; False otherwise direct_message_star_count: type: integer description: Optional. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0. @@ -15533,7 +16044,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -15578,7 +16089,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -15626,7 +16137,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -15702,7 +16213,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -15936,7 +16447,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -16054,7 +16565,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -16112,7 +16623,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media reply_markup: description: Optional. Inline keyboard attached to the message allOf: @@ -16225,7 +16736,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media video_width: type: integer description: Optional. Video width @@ -16428,7 +16939,7 @@ components: description: Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. suggested_tip_amounts: type: array - description: Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. + description: Optional. A JSON-serialized Array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. items: type: integer provider_data: @@ -16522,7 +17033,7 @@ components: properties: type: type: string - description: Type of the result, must be animation + description: Type of the media, must be animation media: type: string description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » @@ -16542,7 +17053,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media width: type: integer description: Optional. Animation width @@ -16567,7 +17078,7 @@ components: properties: type: type: string - description: Type of the result, must be audio + description: Type of the media, must be audio media: type: string description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » @@ -16606,7 +17117,7 @@ components: properties: type: type: string - description: Type of the result, must be document + description: Type of the media, must be document media: type: string description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » @@ -16639,7 +17150,7 @@ components: properties: type: type: string - description: Type of the result, must be link + description: Type of the media, must be link url: type: string description: HTTP URL of the link @@ -16655,7 +17166,7 @@ components: properties: type: type: string - description: Type of the result, must be live_photo + description: Type of the media, must be live_photo media: type: string description: Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. @@ -16675,7 +17186,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media has_spoiler: type: boolean description: Optional. Pass True if the live photo needs to be covered with a spoiler animation @@ -16692,7 +17203,7 @@ components: properties: type: type: string - description: Type of the result, must be location + description: Type of the media, must be location latitude: type: number description: Latitude of the location @@ -16715,7 +17226,7 @@ components: properties: type: type: string - description: Type of the result, must be photo + description: Type of the media, must be photo media: type: string description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » @@ -16732,7 +17243,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media has_spoiler: type: boolean description: Optional. Pass True if the photo needs to be covered with a spoiler animation @@ -16748,7 +17259,7 @@ components: properties: type: type: string - description: Type of the result, must be sticker + description: Type of the media, must be sticker media: type: string description: 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 .WEBP sticker from the Internet, or pass “attach://” to upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data under name. More information on Sending Files » @@ -16767,7 +17278,7 @@ components: properties: type: type: string - description: Type of the result, must be venue + description: Type of the media, must be venue latitude: type: number description: Latitude of the location @@ -16807,7 +17318,7 @@ components: properties: type: type: string - description: Type of the result, must be video + description: Type of the media, must be video media: type: string description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » @@ -16833,7 +17344,7 @@ components: $ref: '#/components/schemas/MessageEntity' show_caption_above_media: type: boolean - description: Optional. Pass True, if the caption must be shown above the message media + description: Optional. Pass True if the caption must be shown above the message media width: type: integer description: Optional. Video width @@ -16852,6 +17363,36 @@ components: required: - type - media + InputMediaVoiceNote: + type: object + description: |- + Represents a voice message file to be sent. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the media, must be voice_note + media: + type: string + description: 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://" to upload a new one using multipart/form-data under name. More information on Sending Files » + caption: + type: string + description: Optional. Caption of the voice message to be sent, 0-1024 characters after entities parsing + parse_mode: + type: string + description: Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. + caption_entities: + type: array + description: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode + items: + $ref: '#/components/schemas/MessageEntity' + duration: + type: integer + description: Optional. Duration of the voice message in seconds + required: + - type + - media InputMessageContent: type: object description: |- @@ -16876,184 +17417,687 @@ components: InputPaidMediaLivePhoto: type: object description: |- - The paid media to send is a live photo. + The paid media to send is a live photo. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the media, must be live_photo + media: + type: string + description: Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. + photo: + type: string + description: The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. + required: + - type + - media + - photo + InputPaidMediaPhoto: + type: object + description: |- + The paid media to send is a photo. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the media, must be photo + media: + type: string + description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » + required: + - type + - media + InputPaidMediaVideo: + type: object + description: |- + The paid media to send is a video. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the media, must be video + media: + type: string + description: 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » + thumbnail: + type: string + description: 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://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » + cover: + type: string + description: Optional. Cover for the video in the message. 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://” to upload a new one using multipart/form-data under name. More information on Sending Files » + start_timestamp: + type: integer + description: Optional. Start timestamp for the video in the message + width: + type: integer + description: Optional. Video width + height: + type: integer + description: Optional. Video height + duration: + type: integer + description: Optional. Video duration in seconds + supports_streaming: + type: boolean + description: Optional. Pass True if the uploaded video is suitable for streaming + required: + - type + - media + InputPollMedia: + type: object + description: |- + This object represents the content of a poll description or a quiz explanation to be sent. It should be one of + InputMediaAnimation + InputMediaAudio + InputMediaDocument + InputMediaLivePhoto + InputMediaLocation + InputMediaPhoto + InputMediaVenue + InputMediaVideo + x-tags: + - Available types + InputPollOption: + type: object + description: |- + This object contains information about one answer option in a poll to be sent. + x-tags: + - Available types + properties: + text: + type: string + description: Option text, 1-100 characters + text_parse_mode: + type: string + description: Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed. + text_entities: + type: array + description: Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode. + items: + $ref: '#/components/schemas/MessageEntity' + media: + description: Optional. Media added to the poll option + allOf: + - $ref: '#/components/schemas/InputPollOptionMedia' + required: + - text + InputPollOptionMedia: + type: object + description: |- + This object represents the content of a poll option to be sent. It should be one of + InputMediaAnimation + InputMediaLink + InputMediaLivePhoto + InputMediaLocation + InputMediaPhoto + InputMediaSticker + InputMediaVenue + InputMediaVideo + x-tags: + - Available types + InputProfilePhoto: + type: object + description: |- + This object describes a profile photo to set. Currently, it can be one of + InputProfilePhotoStatic + InputProfilePhotoAnimated + x-tags: + - Available types + InputProfilePhotoAnimated: + type: object + description: |- + An animated profile photo in the MPEG4 format. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the profile photo, must be animated + animation: + type: string + description: The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://” if the photo was uploaded using multipart/form-data under . More information on Sending Files » + main_frame_timestamp: + type: number + description: Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. + required: + - type + - animation + InputProfilePhotoStatic: + type: object + description: |- + A static profile photo in the .JPG format. + x-tags: + - Available types + properties: + type: + type: string + description: Type of the profile photo, must be static + photo: + type: string + description: The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://” if the photo was uploaded using multipart/form-data under . More information on Sending Files » + required: + - type + - photo + InputRichBlock: + type: object + description: |- + This object represents a block in a rich formatted message to be sent. Currently, it can be any of the following types: + InputRichBlockParagraph + InputRichBlockSectionHeading + InputRichBlockPreformatted + InputRichBlockFooter + InputRichBlockDivider + InputRichBlockMathematicalExpression + InputRichBlockAnchor + InputRichBlockList + InputRichBlockBlockQuotation + InputRichBlockPullQuotation + InputRichBlockCollage + InputRichBlockSlideshow + InputRichBlockTable + InputRichBlockDetails + InputRichBlockMap + InputRichBlockAnimation + InputRichBlockAudio + InputRichBlockPhoto + InputRichBlockVideo + InputRichBlockVoiceNote + InputRichBlockThinking + x-tags: + - Rich messages + InputRichBlockAnchor: + type: object + description: |- + A block with an anchor, corresponding to the HTML tag with the attribute name. + x-tags: + - Rich messages + properties: + type: + type: string + description: Type of the block, always “anchor” + name: + type: string + description: The name of the anchor + required: + - type + - name + InputRichBlockAnimation: + type: object + description: |- + A block with an animation, corresponding to the HTML tag