diff --git a/schemas/botapi.json b/schemas/botapi.json index 730f168..cdc6868 100644 --- a/schemas/botapi.json +++ b/schemas/botapi.json @@ -1,5 +1,5 @@ { - "version": "6.6.0", + "version": "6.7.0", "types": [ { "name": "Update", @@ -1711,7 +1711,7 @@ "int" ], "optional": false, - "description": "____simple_html_dom__voku__html_wrapper____>Value of the dice, 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€ base emoji, 1-5 for β€œπŸ€β€ and β€œβš½β€ base emoji, 1-64 for β€œπŸŽ°β€ base emoji" + "description": "Value of the dice, 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€ base emoji, 1-5 for β€œπŸ€β€ and β€œβš½β€ base emoji, 1-64 for β€œπŸŽ°β€ base emoji" } ], "extended_by": [] @@ -2194,8 +2194,17 @@ }, { "name": "WriteAccessAllowed", - "description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.", - "fields": [], + "description": "This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.", + "fields": [ + { + "name": "web_app_name", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Name of the Web App which was launched from a link" + } + ], "extended_by": [] }, { @@ -2449,7 +2458,7 @@ }, { "name": "KeyboardButtonRequestUser", - "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.", + "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More about requesting users Β»", "fields": [ { "name": "request_id", @@ -2480,7 +2489,7 @@ }, { "name": "KeyboardButtonRequestChat", - "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.", + "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats Β»", "fields": [ { "name": "request_id", @@ -2663,6 +2672,14 @@ "optional": true, "description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options." }, + { + "name": "switch_inline_query_chosen_chat", + "types": [ + "SwitchInlineQueryChosenChat" + ], + "optional": true, + "description": "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field" + }, { "name": "callback_game", "types": [ @@ -2721,6 +2738,53 @@ ], "extended_by": [] }, + { + "name": "SwitchInlineQueryChosenChat", + "description": "This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.", + "fields": [ + { + "name": "query", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted" + }, + { + "name": "allow_user_chats", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if private chats with users can be chosen" + }, + { + "name": "allow_bot_chats", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if private chats with bots can be chosen" + }, + { + "name": "allow_group_chats", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if group and supergroup chats can be chosen" + }, + { + "name": "allow_channel_chats", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if channel chats can be chosen" + } + ], + "extended_by": [] + }, { "name": "CallbackQuery", "description": "This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.", @@ -3503,6 +3567,14 @@ ], "optional": true, "description": "Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only." + }, + { + "name": "via_chat_folder_invite_link", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the user joined the chat via a chat folder invite link" } ], "extended_by": [] @@ -3927,6 +3999,21 @@ ], "extended_by": [] }, + { + "name": "BotName", + "description": "This object represents the bot's name.", + "fields": [ + { + "name": "name", + "types": [ + "string" + ], + "optional": false, + "description": "The bot's name" + } + ], + "extended_by": [] + }, { "name": "BotDescription", "description": "This object represents the bot's description.", @@ -4701,7 +4788,7 @@ "string" ], "optional": false, - "description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files Β»" + "description": "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass β€œattach://” to upload a new one using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files Β»" }, { "name": "emoji_list", @@ -4785,6 +4872,37 @@ ], "extended_by": [] }, + { + "name": "InlineQueryResultsButton", + "description": "This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.", + "fields": [ + { + "name": "text", + "types": [ + "string" + ], + "optional": false, + "description": "Label text on the button" + }, + { + "name": "web_app", + "types": [ + "WebAppInfo" + ], + "optional": true, + "description": "Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App." + }, + { + "name": "start_parameter", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities." + } + ], + "extended_by": [] + }, { "name": "InlineQueryResult", "description": "This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:", @@ -8176,7 +8294,7 @@ "int" ], "optional": true, - "description": "Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten." + "description": "Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten." }, { "name": "limit", @@ -10077,7 +10195,7 @@ "string" ], "optional": true, - "description": "____simple_html_dom__voku__html_wrapper____>Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€", + "description": "Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€", "default": "🎲" }, { @@ -11532,6 +11650,48 @@ "Array" ] }, + { + "name": "setMyName", + "description": "Use this method to change the bot's name. Returns True on success.", + "fields": [ + { + "name": "name", + "types": [ + "string" + ], + "optional": true, + "description": "New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language." + }, + { + "name": "language_code", + "types": [ + "string" + ], + "optional": true, + "description": "A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name." + } + ], + "return_types": [ + "bool" + ] + }, + { + "name": "getMyName", + "description": "Use this method to get the current bot name for the given user language. Returns BotName on success.", + "fields": [ + { + "name": "language_code", + "types": [ + "string" + ], + "optional": true, + "description": "A two-letter ISO 639-1 language code or an empty string" + } + ], + "return_types": [ + "BotName" + ] + }, { "name": "setMyDescription", "description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.", @@ -12627,7 +12787,7 @@ "bool" ], "optional": true, - "description": "Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query" + "description": "Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query." }, { "name": "next_offset", @@ -12638,20 +12798,12 @@ "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." }, { - "name": "switch_pm_text", + "name": "button", "types": [ - "string" + "InlineQueryResultsButton" ], "optional": true, - "description": "If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter" - }, - { - "name": "switch_pm_parameter", - "types": [ - "string" - ], - "optional": true, - "description": "Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities." + "description": "A JSON-serialized object describing a button to be shown above inline query results" } ], "return_types": [ diff --git a/schemas/botapi.yaml b/schemas/botapi.yaml index df19c03..41cc1b4 100644 --- a/schemas/botapi.yaml +++ b/schemas/botapi.yaml @@ -1,4 +1,4 @@ -version: 6.6.0 +version: 6.7.0 types: - name: Update @@ -1285,7 +1285,7 @@ types: types: - int optional: false - description: '____simple_html_dom__voku__html_wrapper____>Value of the dice, 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€ base emoji, 1-5 for β€œπŸ€β€ and β€œβš½β€ base emoji, 1-64 for β€œπŸŽ°β€ base emoji' + description: 'Value of the dice, 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€ base emoji, 1-5 for β€œπŸ€β€ and β€œβš½β€ base emoji, 1-64 for β€œπŸŽ°β€ base emoji' extended_by: { } - name: PollOption @@ -1645,8 +1645,14 @@ types: extended_by: { } - name: WriteAccessAllowed - description: 'This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.' - fields: { } + description: 'This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.' + fields: + - + name: web_app_name + types: + - string + optional: true + description: 'Optional. Name of the Web App which was launched from a link' extended_by: { } - name: VideoChatScheduled @@ -1836,7 +1842,7 @@ types: extended_by: { } - name: KeyboardButtonRequestUser - description: 'This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.' + description: 'This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More about requesting users Β»' fields: - name: request_id @@ -1859,7 +1865,7 @@ types: extended_by: { } - name: KeyboardButtonRequestChat - description: 'This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.' + description: 'This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats Β»' fields: - name: request_id @@ -1996,6 +2002,12 @@ types: - string optional: true description: "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options." + - + name: switch_inline_query_chosen_chat + types: + - SwitchInlineQueryChosenChat + optional: true + description: "Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field" - name: callback_game types: @@ -2038,6 +2050,41 @@ types: optional: true description: 'Optional. Pass True to request the permission for your bot to send messages to the user.' extended_by: { } + - + name: SwitchInlineQueryChosenChat + description: 'This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.' + fields: + - + name: query + types: + - string + optional: true + description: "Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted" + - + name: allow_user_chats + types: + - bool + optional: true + description: 'Optional. True, if private chats with users can be chosen' + - + name: allow_bot_chats + types: + - bool + optional: true + description: 'Optional. True, if private chats with bots can be chosen' + - + name: allow_group_chats + types: + - bool + optional: true + description: 'Optional. True, if group and supergroup chats can be chosen' + - + name: allow_channel_chats + types: + - bool + optional: true + description: 'Optional. True, if channel chats can be chosen' + extended_by: { } - name: CallbackQuery description: 'This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.' @@ -2625,6 +2672,12 @@ types: - ChatInviteLink optional: true description: 'Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.' + - + name: via_chat_folder_invite_link + types: + - bool + optional: true + description: 'Optional. True, if the user joined the chat via a chat folder invite link' extended_by: { } - name: ChatJoinRequest @@ -2942,6 +2995,17 @@ types: optional: false description: 'Unique identifier of the target user' extended_by: { } + - + name: BotName + description: "This object represents the bot's name." + fields: + - + name: name + types: + - string + optional: false + description: "The bot's name" + extended_by: { } - name: BotDescription description: "This object represents the bot's description." @@ -3526,7 +3590,7 @@ types: - InputFile - string optional: false - description: "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files Β»" + description: "The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass β€œattach://” to upload a new one using multipart/form-data under name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files Β»" - name: emoji_list types: @@ -3587,6 +3651,29 @@ types: optional: true description: 'Optional. Sender location, only for bots that request user location' extended_by: { } + - + name: InlineQueryResultsButton + description: 'This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.' + fields: + - + name: text + types: + - string + optional: false + description: 'Label text on the button' + - + name: web_app + types: + - WebAppInfo + optional: true + description: 'Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.' + - + name: start_parameter + types: + - string + optional: true + description: "Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities." + extended_by: { } - name: InlineQueryResult description: 'This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:' @@ -6135,7 +6222,7 @@ methods: types: - int optional: true - description: 'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.' + description: 'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.' - name: limit types: @@ -7566,7 +7653,7 @@ methods: types: - string optional: true - description: '____simple_html_dom__voku__html_wrapper____>Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€' + description: 'Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€' default: 🎲 - name: disable_notification @@ -8633,6 +8720,36 @@ methods: description: 'A two-letter ISO 639-1 language code or an empty string' return_types: - Array + - + name: setMyName + description: "Use this method to change the bot's name. Returns True on success." + fields: + - + name: name + types: + - string + optional: true + description: 'New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.' + - + name: language_code + types: + - string + optional: true + description: 'A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.' + return_types: + - bool + - + name: getMyName + description: 'Use this method to get the current bot name for the given user language. Returns BotName on success.' + fields: + - + name: language_code + types: + - string + optional: true + description: 'A two-letter ISO 639-1 language code or an empty string' + return_types: + - BotName - name: setMyDescription description: "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success." @@ -9438,7 +9555,7 @@ methods: types: - bool optional: true - description: 'Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query' + description: 'Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.' - name: next_offset types: @@ -9446,17 +9563,11 @@ methods: optional: true 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." - - name: switch_pm_text + name: button types: - - string + - InlineQueryResultsButton optional: true - description: 'If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter' - - - name: switch_pm_parameter - types: - - string - optional: true - description: "Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities." + description: 'A JSON-serialized object describing a button to be shown above inline query results' return_types: - bool - diff --git a/schemas/botapi_openapi.json b/schemas/botapi_openapi.json index 0b0ef55..0530b01 100644 --- a/schemas/botapi_openapi.json +++ b/schemas/botapi_openapi.json @@ -3,7 +3,7 @@ "info": { "title": "Telegram Bot API", "description": "Auto-generated OpenAPI schema by TGScraper.", - "version": "6.6.0" + "version": "6.7.0" }, "servers": [ { @@ -1257,7 +1257,12 @@ "type": "object" }, "WriteAccessAllowed": { - "description": "This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.", + "description": "This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.", + "properties": { + "web_app_name": { + "type": "string" + } + }, "type": "object" }, "VideoChatScheduled": { @@ -1423,7 +1428,7 @@ "type": "object" }, "KeyboardButtonRequestUser": { - "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.", + "description": "This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More about requesting users Β»", "required": [ "request_id" ], @@ -1441,7 +1446,7 @@ "type": "object" }, "KeyboardButtonRequestChat": { - "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.", + "description": "This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats Β»", "required": [ "request_id", "chat_is_channel" @@ -1544,6 +1549,9 @@ "switch_inline_query_current_chat": { "type": "string" }, + "switch_inline_query_chosen_chat": { + "$ref": "#/components/schemas/SwitchInlineQueryChosenChat" + }, "callback_game": { "$ref": "#/components/schemas/CallbackGame" }, @@ -1574,6 +1582,27 @@ }, "type": "object" }, + "SwitchInlineQueryChosenChat": { + "description": "This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.", + "properties": { + "query": { + "type": "string" + }, + "allow_user_chats": { + "type": "boolean" + }, + "allow_bot_chats": { + "type": "boolean" + }, + "allow_group_chats": { + "type": "boolean" + }, + "allow_channel_chats": { + "type": "boolean" + } + }, + "type": "object" + }, "CallbackQuery": { "description": "This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.", "required": [ @@ -2013,6 +2042,9 @@ }, "invite_link": { "$ref": "#/components/schemas/ChatInviteLink" + }, + "via_chat_folder_invite_link": { + "type": "boolean" } }, "type": "object" @@ -2304,6 +2336,18 @@ }, "type": "object" }, + "BotName": { + "description": "This object represents the bot's name.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string" + } + }, + "type": "object" + }, "BotDescription": { "description": "This object represents the bot's description.", "required": [ @@ -2840,6 +2884,24 @@ }, "type": "object" }, + "InlineQueryResultsButton": { + "description": "This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.", + "required": [ + "text" + ], + "properties": { + "text": { + "type": "string" + }, + "web_app": { + "$ref": "#/components/schemas/WebAppInfo" + }, + "start_parameter": { + "type": "string" + } + }, + "type": "object" + }, "InlineQueryResult": { "description": "This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:", "anyOf": [ @@ -16105,6 +16167,189 @@ } } }, + "/setMyName": { + "description": "Use this method to change the bot's name. Returns True on success.", + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "language_code": { + "type": "string" + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "language_code": { + "type": "string" + } + } + } + }, + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "language_code": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Request was successful, the result is returned.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Success" + }, + { + "type": "object", + "properties": { + "result": { + "type": "boolean" + } + } + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + }, + "5XX": { + "$ref": "#/components/responses/ServerError" + }, + "default": { + "$ref": "#/components/responses/UnknownError" + } + } + } + }, + "/getMyName": { + "description": "Use this method to get the current bot name for the given user language. Returns BotName on success.", + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "language_code": { + "type": "string" + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "properties": { + "language_code": { + "type": "string" + } + } + } + }, + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "language_code": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Request was successful, the result is returned.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Success" + }, + { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/BotName" + } + } + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFound" + }, + "409": { + "$ref": "#/components/responses/Conflict" + }, + "429": { + "$ref": "#/components/responses/TooManyRequests" + }, + "5XX": { + "$ref": "#/components/responses/ServerError" + }, + "default": { + "$ref": "#/components/responses/UnknownError" + } + } + } + }, "/setMyDescription": { "description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.", "post": { @@ -20031,11 +20276,8 @@ "next_offset": { "type": "string" }, - "switch_pm_text": { - "type": "string" - }, - "switch_pm_parameter": { - "type": "string" + "button": { + "$ref": "#/components/schemas/InlineQueryResultsButton" } } } @@ -20067,11 +20309,8 @@ "next_offset": { "type": "string" }, - "switch_pm_text": { - "type": "string" - }, - "switch_pm_parameter": { - "type": "string" + "button": { + "$ref": "#/components/schemas/InlineQueryResultsButton" } } } @@ -20103,11 +20342,8 @@ "next_offset": { "type": "string" }, - "switch_pm_text": { - "type": "string" - }, - "switch_pm_parameter": { - "type": "string" + "button": { + "$ref": "#/components/schemas/InlineQueryResultsButton" } } } diff --git a/schemas/botapi_openapi.yaml b/schemas/botapi_openapi.yaml index 993f4b4..142a117 100644 --- a/schemas/botapi_openapi.yaml +++ b/schemas/botapi_openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.0.0 info: title: 'Telegram Bot API' description: 'Auto-generated OpenAPI schema by TGScraper.' - version: 6.6.0 + version: 6.7.0 servers: - url: 'https://api.telegram.org/bot{token}' @@ -856,7 +856,10 @@ components: type: integer type: object WriteAccessAllowed: - description: 'This object represents a service message about a user allowing a bot added to the attachment menu to write messages. Currently holds no information.' + description: 'This object represents a service message about a user allowing a bot to write messages after adding the bot to the attachment menu or launching a Web App from a link.' + properties: + web_app_name: + type: string type: object VideoChatScheduled: description: 'This object represents a service message about a video chat scheduled in the chat.' @@ -968,7 +971,7 @@ components: $ref: '#/components/schemas/WebAppInfo' type: object KeyboardButtonRequestUser: - description: 'This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed.' + description: 'This object defines the criteria used to request a suitable user. The identifier of the selected user will be shared with the bot when the corresponding button is pressed. More about requesting users Β»' required: - request_id properties: @@ -980,7 +983,7 @@ components: type: boolean type: object KeyboardButtonRequestChat: - description: 'This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.' + description: 'This object defines the criteria used to request a suitable chat. The identifier of the selected chat will be shared with the bot when the corresponding button is pressed. More about requesting chats Β»' required: - request_id - chat_is_channel @@ -1050,6 +1053,8 @@ components: type: string switch_inline_query_current_chat: type: string + switch_inline_query_chosen_chat: + $ref: '#/components/schemas/SwitchInlineQueryChosenChat' callback_game: $ref: '#/components/schemas/CallbackGame' pay: @@ -1069,6 +1074,20 @@ components: request_write_access: type: boolean type: object + SwitchInlineQueryChosenChat: + description: 'This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.' + properties: + query: + type: string + allow_user_chats: + type: boolean + allow_bot_chats: + type: boolean + allow_group_chats: + type: boolean + allow_channel_chats: + type: boolean + type: object CallbackQuery: description: 'This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.' required: @@ -1381,6 +1400,8 @@ components: $ref: '#/components/schemas/ChatMember' invite_link: $ref: '#/components/schemas/ChatInviteLink' + via_chat_folder_invite_link: + type: boolean type: object ChatJoinRequest: description: 'Represents a join request sent to a chat.' @@ -1577,6 +1598,14 @@ components: user_id: type: integer type: object + BotName: + description: "This object represents the bot's name." + required: + - name + properties: + name: + type: string + type: object BotDescription: description: "This object represents the bot's description." required: @@ -1942,6 +1971,18 @@ components: location: $ref: '#/components/schemas/Location' type: object + InlineQueryResultsButton: + description: 'This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.' + required: + - text + properties: + text: + type: string + web_app: + $ref: '#/components/schemas/WebAppInfo' + start_parameter: + type: string + type: object InlineQueryResult: description: 'This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:' anyOf: @@ -10403,6 +10444,118 @@ paths: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' + /setMyName: + description: "Use this method to change the bot's name. Returns True on success." + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + name: + type: string + language_code: + type: string + application/x-www-form-urlencoded: + schema: + type: object + properties: + name: + type: string + language_code: + type: string + multipart/form-data: + schema: + type: object + properties: + name: + type: string + language_code: + type: string + responses: + 200: + description: 'Request was successful, the result is returned.' + content: + application/json: + schema: + allOf: + - + $ref: '#/components/schemas/Success' + - + type: object + properties: + result: + type: boolean + 400: + $ref: '#/components/responses/BadRequest' + 401: + $ref: '#/components/responses/Unauthorized' + 403: + $ref: '#/components/responses/Forbidden' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + 429: + $ref: '#/components/responses/TooManyRequests' + 5XX: + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/UnknownError' + /getMyName: + description: 'Use this method to get the current bot name for the given user language. Returns BotName on success.' + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + language_code: + type: string + application/x-www-form-urlencoded: + schema: + type: object + properties: + language_code: + type: string + multipart/form-data: + schema: + type: object + properties: + language_code: + type: string + responses: + 200: + description: 'Request was successful, the result is returned.' + content: + application/json: + schema: + allOf: + - + $ref: '#/components/schemas/Success' + - + type: object + properties: + result: + $ref: '#/components/schemas/BotName' + 400: + $ref: '#/components/responses/BadRequest' + 401: + $ref: '#/components/responses/Unauthorized' + 403: + $ref: '#/components/responses/Forbidden' + 404: + $ref: '#/components/responses/NotFound' + 409: + $ref: '#/components/responses/Conflict' + 429: + $ref: '#/components/responses/TooManyRequests' + 5XX: + $ref: '#/components/responses/ServerError' + default: + $ref: '#/components/responses/UnknownError' /setMyDescription: description: "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success." post: @@ -12865,10 +13018,8 @@ paths: type: boolean next_offset: type: string - switch_pm_text: - type: string - switch_pm_parameter: - type: string + button: + $ref: '#/components/schemas/InlineQueryResultsButton' application/x-www-form-urlencoded: schema: type: object @@ -12889,10 +13040,8 @@ paths: type: boolean next_offset: type: string - switch_pm_text: - type: string - switch_pm_parameter: - type: string + button: + $ref: '#/components/schemas/InlineQueryResultsButton' multipart/form-data: schema: type: object @@ -12913,10 +13062,8 @@ paths: type: boolean next_offset: type: string - switch_pm_text: - type: string - switch_pm_parameter: - type: string + button: + $ref: '#/components/schemas/InlineQueryResultsButton' responses: 200: description: 'Request was successful, the result is returned.' diff --git a/schemas/botapi_postman.json b/schemas/botapi_postman.json index b3d1ecb..56ce25c 100644 --- a/schemas/botapi_postman.json +++ b/schemas/botapi_postman.json @@ -3,7 +3,7 @@ "name": "Telegram Bot API", "description": "Auto-generated Postman collection by TGScraper.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "version": "6.6.0" + "version": "6.7.0" }, "variable": { "key": "token", @@ -22,7 +22,7 @@ { "key": "offset", "disabled": true, - "description": "Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.", + "description": "Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.", "type": "text" }, { @@ -1796,7 +1796,7 @@ { "key": "emoji", "disabled": true, - "description": "Optional. ____simple_html_dom__voku__html_wrapper____>Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€", + "description": "Optional. Emoji on which the dice throw animation is based. Currently, must be one of β€œπŸŽ²β€, β€œπŸŽ―β€, β€œπŸ€β€, β€œβš½β€, β€œπŸŽ³β€, or β€œπŸŽ°β€. Dice can have values 1-6 for β€œπŸŽ²β€, β€œπŸŽ―β€ and β€œπŸŽ³β€, values 1-5 for β€œπŸ€β€ and β€œβš½β€, and values 1-64 for β€œπŸŽ°β€. Defaults to β€œπŸŽ²β€", "type": "text", "value": "🎲" }, @@ -3728,6 +3728,74 @@ "description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned." } }, + { + "name": "setMyName", + "request": { + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "name", + "disabled": true, + "description": "Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.", + "type": "text" + }, + { + "key": "language_code", + "disabled": true, + "description": "Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.", + "type": "text" + } + ] + }, + "url": { + "raw": "https://api.telegram.org/bot{{token}}/setMyName", + "protocol": "https", + "host": [ + "api", + "telegram", + "org" + ], + "path": [ + "bot{{token}}", + "setMyName" + ] + }, + "description": "Use this method to change the bot's name. Returns True on success." + } + }, + { + "name": "getMyName", + "request": { + "method": "POST", + "body": { + "mode": "formdata", + "formdata": [ + { + "key": "language_code", + "disabled": true, + "description": "Optional. A two-letter ISO 639-1 language code or an empty string", + "type": "text" + } + ] + }, + "url": { + "raw": "https://api.telegram.org/bot{{token}}/getMyName", + "protocol": "https", + "host": [ + "api", + "telegram", + "org" + ], + "path": [ + "bot{{token}}", + "getMyName" + ] + }, + "description": "Use this method to get the current bot name for the given user language. Returns BotName on success." + } + }, { "name": "setMyDescription", "request": { @@ -5103,7 +5171,7 @@ { "key": "is_personal", "disabled": true, - "description": "Optional. Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query", + "description": "Optional. Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.", "type": "text" }, { @@ -5113,15 +5181,9 @@ "type": "text" }, { - "key": "switch_pm_text", + "key": "button", "disabled": true, - "description": "Optional. If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter", - "type": "text" - }, - { - "key": "switch_pm_parameter", - "disabled": true, - "description": "Optional. Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.", + "description": "Optional. A JSON-serialized object describing a button to be shown above inline query results", "type": "text" } ]