diff --git a/schemas/botapi.json b/schemas/botapi.json index 0ccd144..5b97ed1 100644 --- a/schemas/botapi.json +++ b/schemas/botapi.json @@ -1,5 +1,5 @@ { - "version": "7.2.0", + "version": "7.3.0", "types": [ { "name": "Update", @@ -394,7 +394,71 @@ "string" ], "optional": false, - "description": "Type of chat, can be either “private”, “group”, “supergroup” or “channel”" + "description": "Type of the chat, can be either “private”, “group”, “supergroup” or “channel”" + }, + { + "name": "title", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Title, for supergroups, channels and group chats" + }, + { + "name": "username", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Username, for private chats, supergroups and channels if available" + }, + { + "name": "first_name", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. First name of the other party in a private chat" + }, + { + "name": "last_name", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Last name of the other party in a private chat" + }, + { + "name": "is_forum", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the supergroup chat is a forum (has topics enabled)", + "default": true + } + ], + "extended_by": [] + }, + { + "name": "ChatFullInfo", + "description": "This object contains full information about a chat.", + "fields": [ + { + "name": "id", + "types": [ + "int" + ], + "optional": false, + "description": "Unique identifier for this chat. 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", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the chat, can be either “private”, “group”, “supergroup” or “channel”" }, { "name": "title", @@ -437,13 +501,29 @@ "description": "Optional. True, if the supergroup chat is a forum (has topics enabled)", "default": true }, + { + "name": "accent_color_id", + "types": [ + "int" + ], + "optional": false, + "description": "Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details." + }, + { + "name": "max_reaction_count", + "types": [ + "int" + ], + "optional": false, + "description": "The maximum number of reactions that can be set on a message in the chat" + }, { "name": "photo", "types": [ "ChatPhoto" ], "optional": true, - "description": "Optional. Chat photo. Returned only in getChat." + "description": "Optional. Chat photo" }, { "name": "active_usernames", @@ -451,7 +531,7 @@ "Array" ], "optional": true, - "description": "Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat." + "description": "Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels" }, { "name": "birthdate", @@ -459,7 +539,7 @@ "Birthdate" ], "optional": true, - "description": "Optional. For private chats, the date of birth of the user. Returned only in getChat." + "description": "Optional. For private chats, the date of birth of the user" }, { "name": "business_intro", @@ -467,7 +547,7 @@ "BusinessIntro" ], "optional": true, - "description": "Optional. For private chats with business accounts, the intro of the business. Returned only in getChat." + "description": "Optional. For private chats with business accounts, the intro of the business" }, { "name": "business_location", @@ -475,7 +555,7 @@ "BusinessLocation" ], "optional": true, - "description": "Optional. For private chats with business accounts, the location of the business. Returned only in getChat." + "description": "Optional. For private chats with business accounts, the location of the business" }, { "name": "business_opening_hours", @@ -483,7 +563,7 @@ "BusinessOpeningHours" ], "optional": true, - "description": "Optional. For private chats with business accounts, the opening hours of the business. Returned only in getChat." + "description": "Optional. For private chats with business accounts, the opening hours of the business" }, { "name": "personal_chat", @@ -491,7 +571,7 @@ "Chat" ], "optional": true, - "description": "Optional. For private chats, the personal channel of the user. Returned only in getChat." + "description": "Optional. For private chats, the personal channel of the user" }, { "name": "available_reactions", @@ -499,15 +579,7 @@ "Array" ], "optional": true, - "description": "Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat." - }, - { - "name": "accent_color_id", - "types": [ - "int" - ], - "optional": true, - "description": "Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat." + "description": "Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed." }, { "name": "background_custom_emoji_id", @@ -515,7 +587,7 @@ "string" ], "optional": true, - "description": "Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat." + "description": "Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background" }, { "name": "profile_accent_color_id", @@ -523,7 +595,7 @@ "int" ], "optional": true, - "description": "Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat." + "description": "Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details." }, { "name": "profile_background_custom_emoji_id", @@ -531,7 +603,7 @@ "string" ], "optional": true, - "description": "Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat." + "description": "Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background" }, { "name": "emoji_status_custom_emoji_id", @@ -539,7 +611,7 @@ "string" ], "optional": true, - "description": "Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat." + "description": "Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat" }, { "name": "emoji_status_expiration_date", @@ -547,7 +619,7 @@ "int" ], "optional": true, - "description": "Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat." + "description": "Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any" }, { "name": "bio", @@ -555,7 +627,7 @@ "string" ], "optional": true, - "description": "Optional. Bio of the other party in a private chat. Returned only in getChat." + "description": "Optional. Bio of the other party in a private chat" }, { "name": "has_private_forwards", @@ -563,7 +635,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user. Returned only in getChat.", + "description": "Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user", "default": true }, { @@ -572,7 +644,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.", + "description": "Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat", "default": true }, { @@ -581,7 +653,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.", + "description": "Optional. True, if users need to join the supergroup before they can send messages", "default": true }, { @@ -590,7 +662,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.", + "description": "Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators", "default": true }, { @@ -599,7 +671,7 @@ "string" ], "optional": true, - "description": "Optional. Description, for groups, supergroups and channel chats. Returned only in getChat." + "description": "Optional. Description, for groups, supergroups and channel chats" }, { "name": "invite_link", @@ -607,7 +679,7 @@ "string" ], "optional": true, - "description": "Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat." + "description": "Optional. Primary invite link, for groups, supergroups and channel chats" }, { "name": "pinned_message", @@ -615,7 +687,7 @@ "Message" ], "optional": true, - "description": "Optional. The most recent pinned message (by sending date). Returned only in getChat." + "description": "Optional. The most recent pinned message (by sending date)" }, { "name": "permissions", @@ -623,7 +695,7 @@ "ChatPermissions" ], "optional": true, - "description": "Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat." + "description": "Optional. Default chat member permissions, for groups and supergroups" }, { "name": "slow_mode_delay", @@ -631,7 +703,7 @@ "int" ], "optional": true, - "description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat." + "description": "Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds" }, { "name": "unrestrict_boost_count", @@ -639,7 +711,7 @@ "int" ], "optional": true, - "description": "Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat." + "description": "Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions" }, { "name": "message_auto_delete_time", @@ -647,7 +719,7 @@ "int" ], "optional": true, - "description": "Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat." + "description": "Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds" }, { "name": "has_aggressive_anti_spam_enabled", @@ -655,7 +727,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.", + "description": "Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.", "default": true }, { @@ -664,7 +736,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.", + "description": "Optional. True, if non-administrators can only get the list of bots and administrators in the chat", "default": true }, { @@ -673,7 +745,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.", + "description": "Optional. True, if messages from the chat can't be forwarded to other chats", "default": true }, { @@ -682,7 +754,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.", + "description": "Optional. True, if new chat members will have access to old messages; available only to chat administrators", "default": true }, { @@ -691,7 +763,7 @@ "string" ], "optional": true, - "description": "Optional. For supergroups, name of group sticker set. Returned only in getChat." + "description": "Optional. For supergroups, name of the group sticker set" }, { "name": "can_set_sticker_set", @@ -699,7 +771,7 @@ "bool" ], "optional": true, - "description": "Optional. True, if the bot can change the group sticker set. Returned only in getChat.", + "description": "Optional. True, if the bot can change the group sticker set", "default": true }, { @@ -708,7 +780,7 @@ "string" ], "optional": true, - "description": "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat." + "description": "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group." }, { "name": "linked_chat_id", @@ -716,7 +788,7 @@ "int" ], "optional": true, - "description": "Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat." + "description": "Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier." }, { "name": "location", @@ -724,7 +796,7 @@ "ChatLocation" ], "optional": true, - "description": "Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat." + "description": "Optional. For supergroups, the location to which the supergroup is connected" } ], "extended_by": [] @@ -1254,6 +1326,14 @@ "optional": true, "description": "Optional. Service message: user boosted the chat" }, + { + "name": "chat_background_set", + "types": [ + "ChatBackground" + ], + "optional": true, + "description": "Optional. Service message: chat background set" + }, { "name": "forum_topic_created", "types": [ @@ -2504,6 +2584,14 @@ "optional": false, "description": "Option text, 1-100 characters" }, + { + "name": "text_entities", + "types": [ + "Array" + ], + "optional": true, + "description": "Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts" + }, { "name": "voter_count", "types": [ @@ -2515,6 +2603,37 @@ ], "extended_by": [] }, + { + "name": "InputPollOption", + "description": "This object contains information about one answer option in a poll to send.", + "fields": [ + { + "name": "text", + "types": [ + "string" + ], + "optional": false, + "description": "Option text, 1-100 characters" + }, + { + "name": "text_parse_mode", + "types": [ + "string" + ], + "optional": true, + "description": "Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed" + }, + { + "name": "text_entities", + "types": [ + "Array" + ], + "optional": true, + "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" + } + ], + "extended_by": [] + }, { "name": "PollAnswer", "description": "This object represents an answer of a user in a non-anonymous poll.", @@ -2574,6 +2693,14 @@ "optional": false, "description": "Poll question, 1-300 characters" }, + { + "name": "question_entities", + "types": [ + "Array" + ], + "optional": true, + "description": "Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions" + }, { "name": "options", "types": [ @@ -2867,6 +2994,287 @@ ], "extended_by": [] }, + { + "name": "BackgroundFill", + "description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of", + "fields": [], + "extended_by": [ + "BackgroundFillSolid", + "BackgroundFillGradient", + "BackgroundFillFreeformGradient" + ] + }, + { + "name": "BackgroundFillSolid", + "description": "The background is filled using the selected color.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background fill, always “solid”" + }, + { + "name": "color", + "types": [ + "int" + ], + "optional": false, + "description": "The color of the background fill in the RGB24 format" + } + ], + "extended_by": [] + }, + { + "name": "BackgroundFillGradient", + "description": "The background is a gradient fill.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background fill, always “gradient”" + }, + { + "name": "top_color", + "types": [ + "int" + ], + "optional": false, + "description": "Top color of the gradient in the RGB24 format" + }, + { + "name": "bottom_color", + "types": [ + "int" + ], + "optional": false, + "description": "Bottom color of the gradient in the RGB24 format" + }, + { + "name": "rotation_angle", + "types": [ + "int" + ], + "optional": false, + "description": "Clockwise rotation angle of the background fill in degrees; 0-359" + } + ], + "extended_by": [] + }, + { + "name": "BackgroundFillFreeformGradient", + "description": "The background is a freeform gradient that rotates after every message in the chat.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background fill, always “freeform_gradient”" + }, + { + "name": "colors", + "types": [ + "Array" + ], + "optional": false, + "description": "A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format" + } + ], + "extended_by": [] + }, + { + "name": "BackgroundType", + "description": "This object describes the type of a background. Currently, it can be one of", + "fields": [], + "extended_by": [ + "BackgroundTypeFill", + "BackgroundTypeWallpaper", + "BackgroundTypePattern", + "BackgroundTypeChatTheme" + ] + }, + { + "name": "BackgroundTypeFill", + "description": "The background is automatically filled based on the selected colors.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background, always “fill”" + }, + { + "name": "fill", + "types": [ + "BackgroundFill" + ], + "optional": false, + "description": "The background fill" + }, + { + "name": "dark_theme_dimming", + "types": [ + "int" + ], + "optional": false, + "description": "Dimming of the background in dark themes, as a percentage; 0-100" + } + ], + "extended_by": [] + }, + { + "name": "BackgroundTypeWallpaper", + "description": "The background is a wallpaper in the JPEG format.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background, always “wallpaper”" + }, + { + "name": "document", + "types": [ + "Document" + ], + "optional": false, + "description": "Document with the wallpaper" + }, + { + "name": "dark_theme_dimming", + "types": [ + "int" + ], + "optional": false, + "description": "Dimming of the background in dark themes, as a percentage; 0-100" + }, + { + "name": "is_blurred", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12", + "default": true + }, + { + "name": "is_moving", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the background moves slightly when the device is tilted", + "default": true + } + ], + "extended_by": [] + }, + { + "name": "BackgroundTypePattern", + "description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background, always “pattern”" + }, + { + "name": "document", + "types": [ + "Document" + ], + "optional": false, + "description": "Document with the pattern" + }, + { + "name": "fill", + "types": [ + "BackgroundFill" + ], + "optional": false, + "description": "The background fill that is combined with the pattern" + }, + { + "name": "intensity", + "types": [ + "int" + ], + "optional": false, + "description": "Intensity of the pattern when it is shown above the filled background; 0-100" + }, + { + "name": "is_inverted", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only", + "default": true + }, + { + "name": "is_moving", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the background moves slightly when the device is tilted", + "default": true + } + ], + "extended_by": [] + }, + { + "name": "BackgroundTypeChatTheme", + "description": "The background is taken directly from a built-in chat theme.", + "fields": [ + { + "name": "type", + "types": [ + "string" + ], + "optional": false, + "description": "Type of the background, always “chat_theme”" + }, + { + "name": "theme_name", + "types": [ + "string" + ], + "optional": false, + "description": "Name of the chat theme, which is usually an emoji" + } + ], + "extended_by": [] + }, + { + "name": "ChatBackground", + "description": "This object represents a chat background.", + "fields": [ + { + "name": "type", + "types": [ + "BackgroundType" + ], + "optional": false, + "description": "Type of the background" + } + ], + "extended_by": [] + }, { "name": "ForumTopicCreated", "description": "This object represents a service message about a new forum topic created in the chat.", @@ -2947,7 +3355,7 @@ }, { "name": "SharedUser", - "description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.", + "description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.", "fields": [ { "name": "user_id", @@ -3477,7 +3885,7 @@ }, { "name": "ReplyKeyboardMarkup", - "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).", + "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.", "fields": [ { "name": "keyboard", @@ -3639,7 +4047,7 @@ "bool" ], "optional": true, - "description": "Optional. Pass True to request the users' first and last name" + "description": "Optional. Pass True to request the users' first and last names" }, { "name": "request_username", @@ -3647,7 +4055,7 @@ "bool" ], "optional": true, - "description": "Optional. Pass True to request the users' username" + "description": "Optional. Pass True to request the users' usernames" }, { "name": "request_photo", @@ -3655,14 +4063,14 @@ "bool" ], "optional": true, - "description": "Optional. Pass True to request the users' photo" + "description": "Optional. Pass True to request the users' photos" } ], "extended_by": [] }, { "name": "KeyboardButtonRequestChat", - "description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate More about requesting chats »", + "description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».", "fields": [ { "name": "request_id", @@ -3772,7 +4180,7 @@ }, { "name": "ReplyKeyboardRemove", - "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).", + "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.", "fields": [ { "name": "remove_keyboard", @@ -3835,7 +4243,7 @@ "string" ], "optional": true, - "description": "Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes" + "description": "Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account." }, { "name": "web_app", @@ -3843,7 +4251,7 @@ "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 send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot." + "description": "Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account." }, { "name": "login_url", @@ -3859,7 +4267,7 @@ "string" ], "optional": true, - "description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted." + "description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account." }, { "name": "switch_inline_query_current_chat", @@ -3867,7 +4275,7 @@ "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." + "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. Not supported in channels and for messages sent on behalf of a Telegram Business account." }, { "name": "switch_inline_query_chosen_chat", @@ -3875,7 +4283,7 @@ "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" + "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. Not supported for messages sent on behalf of a Telegram Business account." }, { "name": "callback_game", @@ -4047,7 +4455,7 @@ }, { "name": "ForceReply", - "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.", + "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.", "fields": [ { "name": "force_reply", @@ -4277,7 +4685,7 @@ "bool" ], "optional": false, - "description": "True, if the administrator can edit stories posted by other users" + "description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" }, { "name": "can_delete_stories", @@ -4374,6 +4782,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_join_request", + "types": [ + "bool" + ], + "optional": true, + "description": "Optional. True, if the user joined the chat after sending a direct join request and being approved by an administrator" + }, { "name": "via_chat_folder_invite_link", "types": [ @@ -4543,7 +4959,7 @@ "bool" ], "optional": false, - "description": "True, if the administrator can edit stories posted by other users" + "description": "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" }, { "name": "can_delete_stories", @@ -5000,7 +5416,7 @@ }, { "name": "Birthdate", - "description": "", + "description": "Describes the birthdate of a user.", "fields": [ { "name": "day", @@ -5031,7 +5447,7 @@ }, { "name": "BusinessIntro", - "description": "", + "description": "Contains information about the start page settings of a Telegram Business account.", "fields": [ { "name": "title", @@ -5062,7 +5478,7 @@ }, { "name": "BusinessLocation", - "description": "", + "description": "Contains information about the location of a Telegram Business account.", "fields": [ { "name": "address", @@ -5085,7 +5501,7 @@ }, { "name": "BusinessOpeningHoursInterval", - "description": "", + "description": "Describes an interval of time during which a business is open.", "fields": [ { "name": "opening_minute", @@ -5093,7 +5509,7 @@ "int" ], "optional": false, - "description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 24 60" + "description": "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60" }, { "name": "closing_minute", @@ -5101,14 +5517,14 @@ "int" ], "optional": false, - "description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 24 60" + "description": "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60" } ], "extended_by": [] }, { "name": "BusinessOpeningHours", - "description": "", + "description": "Describes the opening hours of a business.", "fields": [ { "name": "time_zone_name", @@ -5967,7 +6383,7 @@ "Array" ], "optional": false, - "description": "A JSON-serialized list of identifiers of deleted messages in the chat of the business account" + "description": "The list of identifiers of deleted messages in the chat of the business account" } ], "extended_by": [] @@ -7717,7 +8133,7 @@ "int" ], "optional": true, - "description": "Optional. Period in seconds for which the location can be updated, should be between 60 and 86400." + "description": "Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely." }, { "name": "heading", @@ -8751,7 +9167,7 @@ "int" ], "optional": true, - "description": "Optional. Period in seconds for which the location can be updated, should be between 60 and 86400." + "description": "Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely." }, { "name": "heading", @@ -10382,7 +10798,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -10602,7 +11018,7 @@ "ForceReply" ], "optional": true, - "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user." + "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" } ], "return_types": [ @@ -10779,7 +11195,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -10914,7 +11330,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11033,7 +11449,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11184,7 +11600,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11327,7 +11743,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11336,7 +11752,7 @@ }, { "name": "sendVoice", - "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.", + "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.", "fields": [ { "name": "business_connection_id", @@ -11437,7 +11853,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11540,7 +11956,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11672,7 +12088,7 @@ "int" ], "optional": true, - "description": "Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400." + "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." }, { "name": "heading", @@ -11723,7 +12139,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11856,7 +12272,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -11957,7 +12373,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -12001,13 +12417,29 @@ "optional": false, "description": "Poll question, 1-300 characters" }, + { + "name": "question_parse_mode", + "types": [ + "string" + ], + "optional": true, + "description": "Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed" + }, + { + "name": "question_entities", + "types": [ + "Array" + ], + "optional": true, + "description": "A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode" + }, { "name": "options", "types": [ - "Array" + "Array" ], "optional": false, - "description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each" + "description": "A JSON-serialized list of 2-10 answer options" }, { "name": "is_anonymous", @@ -12066,7 +12498,7 @@ "Array" ], "optional": true, - "description": "A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode" + "description": "A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode" }, { "name": "open_period", @@ -12125,7 +12557,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -12203,7 +12635,7 @@ "ForceReply" ], "optional": true, - "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. Not supported for messages sent on behalf of a business account" + "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" } ], "return_types": [ @@ -12570,7 +13002,7 @@ "bool" ], "optional": true, - "description": "Pass True if the administrator can edit stories posted by other users" + "description": "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" }, { "name": "can_delete_stories", @@ -13135,7 +13567,7 @@ }, { "name": "getChat", - "description": "Use this method to get up to date information about the chat. Returns a Chat object on success.", + "description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.", "fields": [ { "name": "chat_id", @@ -13148,7 +13580,7 @@ } ], "return_types": [ - "Chat" + "ChatFullInfo" ] }, { @@ -14198,6 +14630,14 @@ "optional": false, "description": "Longitude of new location" }, + { + "name": "live_period", + "types": [ + "int" + ], + "optional": true, + "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" + }, { "name": "horizontal_accuracy", "types": [ @@ -14487,7 +14927,7 @@ "ForceReply" ], "optional": true, - "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account." + "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" } ], "return_types": [ @@ -15563,7 +16003,7 @@ "InlineKeyboardMarkup" ], "optional": true, - "description": "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account." + "description": "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game." } ], "return_types": [ diff --git a/schemas/botapi.yaml b/schemas/botapi.yaml index 8021350..df78470 100644 --- a/schemas/botapi.yaml +++ b/schemas/botapi.yaml @@ -1,4 +1,4 @@ -version: 7.2.0 +version: 7.3.0 types: - name: Update @@ -296,7 +296,55 @@ types: types: - string optional: false - description: 'Type of chat, can be either “private”, “group”, “supergroup” or “channel”' + description: 'Type of the chat, can be either “private”, “group”, “supergroup” or “channel”' + - + name: title + types: + - string + optional: true + description: 'Optional. Title, for supergroups, channels and group chats' + - + name: username + types: + - string + optional: true + description: 'Optional. Username, for private chats, supergroups and channels if available' + - + name: first_name + types: + - string + optional: true + description: 'Optional. First name of the other party in a private chat' + - + name: last_name + types: + - string + optional: true + description: 'Optional. Last name of the other party in a private chat' + - + name: is_forum + types: + - bool + optional: true + description: 'Optional. True, if the supergroup chat is a forum (has topics enabled)' + default: true + extended_by: { } + - + name: ChatFullInfo + description: 'This object contains full information about a chat.' + fields: + - + name: id + types: + - int + optional: false + description: 'Unique identifier for this chat. 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 + types: + - string + optional: false + description: 'Type of the chat, can be either “private”, “group”, “supergroup” or “channel”' - name: title types: @@ -328,225 +376,231 @@ types: optional: true description: 'Optional. True, if the supergroup chat is a forum (has topics enabled)' default: true + - + name: accent_color_id + types: + - int + optional: false + description: 'Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.' + - + name: max_reaction_count + types: + - int + optional: false + description: 'The maximum number of reactions that can be set on a message in the chat' - name: photo types: - ChatPhoto optional: true - description: 'Optional. Chat photo. Returned only in getChat.' + description: 'Optional. Chat photo' - name: active_usernames types: - Array optional: true - description: 'Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.' + description: 'Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels' - name: birthdate types: - Birthdate optional: true - description: 'Optional. For private chats, the date of birth of the user. Returned only in getChat.' + description: 'Optional. For private chats, the date of birth of the user' - name: business_intro types: - BusinessIntro optional: true - description: 'Optional. For private chats with business accounts, the intro of the business. Returned only in getChat.' + description: 'Optional. For private chats with business accounts, the intro of the business' - name: business_location types: - BusinessLocation optional: true - description: 'Optional. For private chats with business accounts, the location of the business. Returned only in getChat.' + description: 'Optional. For private chats with business accounts, the location of the business' - name: business_opening_hours types: - BusinessOpeningHours optional: true - description: 'Optional. For private chats with business accounts, the opening hours of the business. Returned only in getChat.' + description: 'Optional. For private chats with business accounts, the opening hours of the business' - name: personal_chat types: - Chat optional: true - description: 'Optional. For private chats, the personal channel of the user. Returned only in getChat.' + description: 'Optional. For private chats, the personal channel of the user' - name: available_reactions types: - Array optional: true - description: 'Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. Returned only in getChat.' - - - name: accent_color_id - types: - - int - optional: true - description: 'Optional. Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. Returned only in getChat. Always returned in getChat.' + description: 'Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.' - name: background_custom_emoji_id types: - string optional: true - description: 'Optional. Custom emoji identifier of emoji chosen by the chat for the reply header and link preview background. Returned only in getChat.' + description: 'Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background' - name: profile_accent_color_id types: - int optional: true - description: "Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. Returned only in getChat." + description: "Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details." - name: profile_background_custom_emoji_id types: - string optional: true - description: 'Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background. Returned only in getChat.' + description: 'Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background' - name: emoji_status_custom_emoji_id types: - string optional: true - description: 'Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat. Returned only in getChat.' + description: 'Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat' - name: emoji_status_expiration_date types: - int optional: true - description: 'Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any. Returned only in getChat.' + description: 'Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any' - name: bio types: - string optional: true - description: 'Optional. Bio of the other party in a private chat. Returned only in getChat.' + description: 'Optional. Bio of the other party in a private chat' - name: has_private_forwards types: - bool optional: true - description: 'Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user. Returned only in getChat.' + description: 'Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user' default: true - name: has_restricted_voice_and_video_messages types: - bool optional: true - description: 'Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.' + description: 'Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat' default: true - name: join_to_send_messages types: - bool optional: true - description: 'Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.' + description: 'Optional. True, if users need to join the supergroup before they can send messages' default: true - name: join_by_request types: - bool optional: true - description: 'Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.' + description: 'Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators' default: true - name: description types: - string optional: true - description: 'Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.' + description: 'Optional. Description, for groups, supergroups and channel chats' - name: invite_link types: - string optional: true - description: 'Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.' + description: 'Optional. Primary invite link, for groups, supergroups and channel chats' - name: pinned_message types: - Message optional: true - description: 'Optional. The most recent pinned message (by sending date). Returned only in getChat.' + description: 'Optional. The most recent pinned message (by sending date)' - name: permissions types: - ChatPermissions optional: true - description: 'Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.' + description: 'Optional. Default chat member permissions, for groups and supergroups' - name: slow_mode_delay types: - int optional: true - description: 'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds. Returned only in getChat.' + description: 'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds' - name: unrestrict_boost_count types: - int optional: true - description: 'Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions. Returned only in getChat.' + description: 'Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions' - name: message_auto_delete_time types: - int optional: true - description: 'Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.' + description: 'Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds' - name: has_aggressive_anti_spam_enabled types: - bool optional: true - description: 'Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. Returned only in getChat.' + description: 'Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.' default: true - name: has_hidden_members types: - bool optional: true - description: 'Optional. True, if non-administrators can only get the list of bots and administrators in the chat. Returned only in getChat.' + description: 'Optional. True, if non-administrators can only get the list of bots and administrators in the chat' default: true - name: has_protected_content types: - bool optional: true - description: "Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat." + description: "Optional. True, if messages from the chat can't be forwarded to other chats" default: true - name: has_visible_history types: - bool optional: true - description: 'Optional. True, if new chat members will have access to old messages; available only to chat administrators. Returned only in getChat.' + description: 'Optional. True, if new chat members will have access to old messages; available only to chat administrators' default: true - name: sticker_set_name types: - string optional: true - description: 'Optional. For supergroups, name of group sticker set. Returned only in getChat.' + description: 'Optional. For supergroups, name of the group sticker set' - name: can_set_sticker_set types: - bool optional: true - description: 'Optional. True, if the bot can change the group sticker set. Returned only in getChat.' + description: 'Optional. True, if the bot can change the group sticker set' default: true - name: custom_emoji_sticker_set_name types: - string optional: true - description: "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. Returned only in getChat." + description: "Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group." - name: linked_chat_id types: - int optional: true - description: 'Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.' + description: 'Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.' - name: location types: - ChatLocation optional: true - description: 'Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.' + description: 'Optional. For supergroups, the location to which the supergroup is connected' extended_by: { } - name: Message @@ -945,6 +999,12 @@ types: - ChatBoostAdded optional: true description: 'Optional. Service message: user boosted the chat' + - + name: chat_background_set + types: + - ChatBackground + optional: true + description: 'Optional. Service message: chat background set' - name: forum_topic_created types: @@ -1879,6 +1939,12 @@ types: - string optional: false description: 'Option text, 1-100 characters' + - + name: text_entities + types: + - Array + optional: true + description: 'Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts' - name: voter_count types: @@ -1886,6 +1952,29 @@ types: optional: false description: 'Number of users that voted for this option' extended_by: { } + - + name: InputPollOption + description: 'This object contains information about one answer option in a poll to send.' + fields: + - + name: text + types: + - string + optional: false + description: 'Option text, 1-100 characters' + - + name: text_parse_mode + types: + - string + optional: true + description: 'Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed' + - + name: text_entities + types: + - Array + optional: true + 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' + extended_by: { } - name: PollAnswer description: 'This object represents an answer of a user in a non-anonymous poll.' @@ -1931,6 +2020,12 @@ types: - string optional: false description: 'Poll question, 1-300 characters' + - + name: question_entities + types: + - Array + optional: true + description: 'Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions' - name: options types: @@ -2148,6 +2243,217 @@ types: optional: false description: 'Number of boosts added by the user' extended_by: { } + - + name: BackgroundFill + description: 'This object describes the way a background is filled based on the selected colors. Currently, it can be one of' + fields: { } + extended_by: + - BackgroundFillSolid + - BackgroundFillGradient + - BackgroundFillFreeformGradient + - + name: BackgroundFillSolid + description: 'The background is filled using the selected color.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background fill, always “solid”' + - + name: color + types: + - int + optional: false + description: 'The color of the background fill in the RGB24 format' + extended_by: { } + - + name: BackgroundFillGradient + description: 'The background is a gradient fill.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background fill, always “gradient”' + - + name: top_color + types: + - int + optional: false + description: 'Top color of the gradient in the RGB24 format' + - + name: bottom_color + types: + - int + optional: false + description: 'Bottom color of the gradient in the RGB24 format' + - + name: rotation_angle + types: + - int + optional: false + description: 'Clockwise rotation angle of the background fill in degrees; 0-359' + extended_by: { } + - + name: BackgroundFillFreeformGradient + description: 'The background is a freeform gradient that rotates after every message in the chat.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background fill, always “freeform_gradient”' + - + name: colors + types: + - Array + optional: false + description: 'A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format' + extended_by: { } + - + name: BackgroundType + description: 'This object describes the type of a background. Currently, it can be one of' + fields: { } + extended_by: + - BackgroundTypeFill + - BackgroundTypeWallpaper + - BackgroundTypePattern + - BackgroundTypeChatTheme + - + name: BackgroundTypeFill + description: 'The background is automatically filled based on the selected colors.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background, always “fill”' + - + name: fill + types: + - BackgroundFill + optional: false + description: 'The background fill' + - + name: dark_theme_dimming + types: + - int + optional: false + description: 'Dimming of the background in dark themes, as a percentage; 0-100' + extended_by: { } + - + name: BackgroundTypeWallpaper + description: 'The background is a wallpaper in the JPEG format.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background, always “wallpaper”' + - + name: document + types: + - Document + optional: false + description: 'Document with the wallpaper' + - + name: dark_theme_dimming + types: + - int + optional: false + description: 'Dimming of the background in dark themes, as a percentage; 0-100' + - + name: is_blurred + types: + - bool + optional: true + description: 'Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12' + default: true + - + name: is_moving + types: + - bool + optional: true + description: 'Optional. True, if the background moves slightly when the device is tilted' + default: true + extended_by: { } + - + name: BackgroundTypePattern + description: 'The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background, always “pattern”' + - + name: document + types: + - Document + optional: false + description: 'Document with the pattern' + - + name: fill + types: + - BackgroundFill + optional: false + description: 'The background fill that is combined with the pattern' + - + name: intensity + types: + - int + optional: false + description: 'Intensity of the pattern when it is shown above the filled background; 0-100' + - + name: is_inverted + types: + - bool + optional: true + description: 'Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only' + default: true + - + name: is_moving + types: + - bool + optional: true + description: 'Optional. True, if the background moves slightly when the device is tilted' + default: true + extended_by: { } + - + name: BackgroundTypeChatTheme + description: 'The background is taken directly from a built-in chat theme.' + fields: + - + name: type + types: + - string + optional: false + description: 'Type of the background, always “chat_theme”' + - + name: theme_name + types: + - string + optional: false + description: 'Name of the chat theme, which is usually an emoji' + extended_by: { } + - + name: ChatBackground + description: 'This object represents a chat background.' + fields: + - + name: type + types: + - BackgroundType + optional: false + description: 'Type of the background' + extended_by: { } - name: ForumTopicCreated description: 'This object represents a service message about a new forum topic created in the chat.' @@ -2210,7 +2516,7 @@ types: extended_by: { } - name: SharedUser - description: 'This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.' + description: 'This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.' fields: - name: user_id @@ -2606,7 +2912,7 @@ types: extended_by: { } - name: ReplyKeyboardMarkup - description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).' + description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.' fields: - name: keyboard @@ -2729,23 +3035,23 @@ types: types: - bool optional: true - description: "Optional. Pass True to request the users' first and last name" + description: "Optional. Pass True to request the users' first and last names" - name: request_username types: - bool optional: true - description: "Optional. Pass True to request the users' username" + description: "Optional. Pass True to request the users' usernames" - name: request_photo types: - bool optional: true - description: "Optional. Pass True to request the users' photo" + description: "Optional. Pass True to request the users' photos" extended_by: { } - name: KeyboardButtonRequestChat - description: 'This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate More about requesting chats »' + description: 'This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».' fields: - name: request_id @@ -2827,7 +3133,7 @@ types: extended_by: { } - name: ReplyKeyboardRemove - description: 'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).' + description: 'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.' fields: - name: remove_keyboard @@ -2875,13 +3181,13 @@ types: types: - string optional: true - description: 'Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes' + description: 'Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.' - 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 send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.' + description: 'Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.' - name: login_url types: @@ -2893,19 +3199,19 @@ types: types: - string optional: true - description: "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted." + description: "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account." - name: switch_inline_query_current_chat 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." + 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. Not supported in channels and for messages sent on behalf of a Telegram Business account." - 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" + 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. Not supported for messages sent on behalf of a Telegram Business account." - name: callback_game types: @@ -3032,7 +3338,7 @@ types: extended_by: { } - name: ForceReply - description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode." + description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account." fields: - name: force_reply @@ -3205,7 +3511,7 @@ types: types: - bool optional: false - description: 'True, if the administrator can edit stories posted by other users' + description: "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" - name: can_delete_stories types: @@ -3277,6 +3583,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_join_request + types: + - bool + optional: true + description: 'Optional. True, if the user joined the chat after sending a direct join request and being approved by an administrator' - name: via_chat_folder_invite_link types: @@ -3405,7 +3717,7 @@ types: types: - bool optional: false - description: 'True, if the administrator can edit stories posted by other users' + description: "True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" - name: can_delete_stories types: @@ -3745,7 +4057,7 @@ types: extended_by: { } - name: Birthdate - description: '' + description: 'Describes the birthdate of a user.' fields: - name: day @@ -3768,7 +4080,7 @@ types: extended_by: { } - name: BusinessIntro - description: '' + description: 'Contains information about the start page settings of a Telegram Business account.' fields: - name: title @@ -3791,7 +4103,7 @@ types: extended_by: { } - name: BusinessLocation - description: '' + description: 'Contains information about the location of a Telegram Business account.' fields: - name: address @@ -3808,24 +4120,24 @@ types: extended_by: { } - name: BusinessOpeningHoursInterval - description: '' + description: 'Describes an interval of time during which a business is open.' fields: - name: opening_minute types: - int optional: false - description: "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 24 60" + description: "The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60" - name: closing_minute types: - int optional: false - description: "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 24 60" + description: "The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60" extended_by: { } - name: BusinessOpeningHours - description: '' + description: 'Describes the opening hours of a business.' fields: - name: time_zone_name @@ -4469,7 +4781,7 @@ types: types: - Array optional: false - description: 'A JSON-serialized list of identifiers of deleted messages in the chat of the business account' + description: 'The list of identifiers of deleted messages in the chat of the business account' extended_by: { } - name: ResponseParameters @@ -5788,7 +6100,7 @@ types: types: - int optional: true - description: 'Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.' + description: 'Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.' - name: heading types: @@ -6564,7 +6876,7 @@ types: types: - int optional: true - description: 'Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.' + description: 'Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.' - name: heading types: @@ -7784,7 +8096,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -7949,7 +8261,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - description: 'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.' + 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' return_types: - MessageId - @@ -8082,7 +8394,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8184,7 +8496,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8274,7 +8586,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8388,7 +8700,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8496,12 +8808,12 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - name: sendVoice - description: 'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.' + description: 'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.' fields: - name: business_connection_id @@ -8579,7 +8891,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8657,7 +8969,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8755,7 +9067,7 @@ methods: types: - int optional: true - description: 'Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.' + 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.' - name: heading types: @@ -8794,7 +9106,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8894,7 +9206,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -8970,7 +9282,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -9002,12 +9314,24 @@ methods: - string optional: false description: 'Poll question, 1-300 characters' + - + name: question_parse_mode + types: + - string + optional: true + description: 'Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed' + - + name: question_entities + types: + - Array + optional: true + description: 'A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode' - name: options types: - - Array + - Array optional: false - description: 'A JSON-serialized list of answer options, 2-10 strings 1-100 characters each' + description: 'A JSON-serialized list of 2-10 answer options' - name: is_anonymous types: @@ -9052,7 +9376,7 @@ methods: types: - Array optional: true - description: 'A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode' + description: 'A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode' - name: open_period types: @@ -9097,7 +9421,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -9156,7 +9480,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - 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. Not supported for messages sent on behalf of a business account' + 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' return_types: - Message - @@ -9427,7 +9751,7 @@ methods: types: - bool optional: true - description: 'Pass True if the administrator can edit stories posted by other users' + description: "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive" - name: can_delete_stories types: @@ -9840,7 +10164,7 @@ methods: - bool - name: getChat - description: 'Use this method to get up to date information about the chat. Returns a Chat object on success.' + description: 'Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.' fields: - name: chat_id @@ -9850,7 +10174,7 @@ methods: optional: false description: 'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)' return_types: - - Chat + - ChatFullInfo - name: getChatAdministrators description: "Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects." @@ -10618,6 +10942,12 @@ methods: - float optional: false description: 'Longitude of new location' + - + name: live_period + types: + - int + optional: true + 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' - name: horizontal_accuracy types: @@ -10834,7 +11164,7 @@ methods: - ReplyKeyboardRemove - ForceReply optional: true - description: 'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.' + 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' return_types: - Message - @@ -11625,7 +11955,7 @@ methods: types: - InlineKeyboardMarkup optional: true - description: "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account." + description: "A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game." return_types: - Message - diff --git a/schemas/botapi_openapi.json b/schemas/botapi_openapi.json index abf4f33..27311bf 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": "7.2.0" + "version": "7.3.0" }, "servers": [ { @@ -357,6 +357,46 @@ "is_forum": { "type": "boolean", "default": true + } + }, + "type": "object" + }, + "ChatFullInfo": { + "description": "This object contains full information about a chat.", + "required": [ + "id", + "type", + "accent_color_id", + "max_reaction_count" + ], + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "title": { + "type": "string" + }, + "username": { + "type": "string" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "is_forum": { + "type": "boolean", + "default": true + }, + "accent_color_id": { + "type": "integer" + }, + "max_reaction_count": { + "type": "integer" }, "photo": { "$ref": "#/components/schemas/ChatPhoto" @@ -388,9 +428,6 @@ "$ref": "#/components/schemas/ReactionType" } }, - "accent_color_id": { - "type": "integer" - }, "background_custom_emoji_id": { "type": "string" }, @@ -705,6 +742,9 @@ "boost_added": { "$ref": "#/components/schemas/ChatBoostAdded" }, + "chat_background_set": { + "$ref": "#/components/schemas/ChatBackground" + }, "forum_topic_created": { "$ref": "#/components/schemas/ForumTopicCreated" }, @@ -1382,12 +1422,39 @@ "text": { "type": "string" }, + "text_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + }, "voter_count": { "type": "integer" } }, "type": "object" }, + "InputPollOption": { + "description": "This object contains information about one answer option in a poll to send.", + "required": [ + "text" + ], + "properties": { + "text": { + "type": "string" + }, + "text_parse_mode": { + "type": "string" + }, + "text_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + } + }, + "type": "object" + }, "PollAnswer": { "description": "This object represents an answer of a user in a non-anonymous poll.", "required": [ @@ -1432,6 +1499,12 @@ "question": { "type": "string" }, + "question_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + }, "options": { "type": "array", "items": { @@ -1594,6 +1667,204 @@ }, "type": "object" }, + "BackgroundFill": { + "description": "This object describes the way a background is filled based on the selected colors. Currently, it can be one of", + "anyOf": [ + { + "$ref": "#/components/schemas/BackgroundFillSolid" + }, + { + "$ref": "#/components/schemas/BackgroundFillGradient" + }, + { + "$ref": "#/components/schemas/BackgroundFillFreeformGradient" + } + ] + }, + "BackgroundFillSolid": { + "description": "The background is filled using the selected color.", + "required": [ + "type", + "color" + ], + "properties": { + "type": { + "type": "string" + }, + "color": { + "type": "integer" + } + }, + "type": "object" + }, + "BackgroundFillGradient": { + "description": "The background is a gradient fill.", + "required": [ + "type", + "top_color", + "bottom_color", + "rotation_angle" + ], + "properties": { + "type": { + "type": "string" + }, + "top_color": { + "type": "integer" + }, + "bottom_color": { + "type": "integer" + }, + "rotation_angle": { + "type": "integer" + } + }, + "type": "object" + }, + "BackgroundFillFreeformGradient": { + "description": "The background is a freeform gradient that rotates after every message in the chat.", + "required": [ + "type", + "colors" + ], + "properties": { + "type": { + "type": "string" + }, + "colors": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "type": "object" + }, + "BackgroundType": { + "description": "This object describes the type of a background. Currently, it can be one of", + "anyOf": [ + { + "$ref": "#/components/schemas/BackgroundTypeFill" + }, + { + "$ref": "#/components/schemas/BackgroundTypeWallpaper" + }, + { + "$ref": "#/components/schemas/BackgroundTypePattern" + }, + { + "$ref": "#/components/schemas/BackgroundTypeChatTheme" + } + ] + }, + "BackgroundTypeFill": { + "description": "The background is automatically filled based on the selected colors.", + "required": [ + "type", + "fill", + "dark_theme_dimming" + ], + "properties": { + "type": { + "type": "string" + }, + "fill": { + "$ref": "#/components/schemas/BackgroundFill" + }, + "dark_theme_dimming": { + "type": "integer" + } + }, + "type": "object" + }, + "BackgroundTypeWallpaper": { + "description": "The background is a wallpaper in the JPEG format.", + "required": [ + "type", + "document", + "dark_theme_dimming" + ], + "properties": { + "type": { + "type": "string" + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "dark_theme_dimming": { + "type": "integer" + }, + "is_blurred": { + "type": "boolean", + "default": true + }, + "is_moving": { + "type": "boolean", + "default": true + } + }, + "type": "object" + }, + "BackgroundTypePattern": { + "description": "The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.", + "required": [ + "type", + "document", + "fill", + "intensity" + ], + "properties": { + "type": { + "type": "string" + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "fill": { + "$ref": "#/components/schemas/BackgroundFill" + }, + "intensity": { + "type": "integer" + }, + "is_inverted": { + "type": "boolean", + "default": true + }, + "is_moving": { + "type": "boolean", + "default": true + } + }, + "type": "object" + }, + "BackgroundTypeChatTheme": { + "description": "The background is taken directly from a built-in chat theme.", + "required": [ + "type", + "theme_name" + ], + "properties": { + "type": { + "type": "string" + }, + "theme_name": { + "type": "string" + } + }, + "type": "object" + }, + "ChatBackground": { + "description": "This object represents a chat background.", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/components/schemas/BackgroundType" + } + }, + "type": "object" + }, "ForumTopicCreated": { "description": "This object represents a service message about a new forum topic created in the chat.", "required": [ @@ -1642,7 +1913,7 @@ "type": "object" }, "SharedUser": { - "description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.", + "description": "This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.", "required": [ "user_id" ], @@ -1967,7 +2238,7 @@ "type": "object" }, "ReplyKeyboardMarkup": { - "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).", + "description": "This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.", "required": [ "keyboard" ], @@ -2061,7 +2332,7 @@ "type": "object" }, "KeyboardButtonRequestChat": { - "description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate More about requesting chats »", + "description": "This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».", "required": [ "request_id", "chat_is_channel" @@ -2113,7 +2384,7 @@ "type": "object" }, "ReplyKeyboardRemove": { - "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).", + "description": "Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.", "required": [ "remove_keyboard" ], @@ -2260,7 +2531,7 @@ "type": "object" }, "ForceReply": { - "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.", + "description": "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account.", "required": [ "force_reply" ], @@ -2434,6 +2705,9 @@ "invite_link": { "$ref": "#/components/schemas/ChatInviteLink" }, + "via_join_request": { + "type": "boolean" + }, "via_chat_folder_invite_link": { "type": "boolean" } @@ -2776,7 +3050,7 @@ "type": "object" }, "Birthdate": { - "description": "", + "description": "Describes the birthdate of a user.", "required": [ "day", "month" @@ -2795,7 +3069,7 @@ "type": "object" }, "BusinessIntro": { - "description": "", + "description": "Contains information about the start page settings of a Telegram Business account.", "properties": { "title": { "type": "string" @@ -2810,7 +3084,7 @@ "type": "object" }, "BusinessLocation": { - "description": "", + "description": "Contains information about the location of a Telegram Business account.", "required": [ "address" ], @@ -2825,7 +3099,7 @@ "type": "object" }, "BusinessOpeningHoursInterval": { - "description": "", + "description": "Describes an interval of time during which a business is open.", "required": [ "opening_minute", "closing_minute" @@ -2841,7 +3115,7 @@ "type": "object" }, "BusinessOpeningHours": { - "description": "", + "description": "Describes the opening hours of a business.", "required": [ "time_zone_name", "opening_hours" @@ -9327,7 +9601,7 @@ } }, "/sendVoice": { - "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.", + "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.", "post": { "requestBody": { "required": true, @@ -10981,10 +11255,19 @@ "question": { "type": "string" }, + "question_parse_mode": { + "type": "string" + }, + "question_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + }, "options": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/InputPollOption" } }, "is_anonymous": { @@ -11078,10 +11361,19 @@ "question": { "type": "string" }, + "question_parse_mode": { + "type": "string" + }, + "question_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + }, "options": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/InputPollOption" } }, "is_anonymous": { @@ -11175,10 +11467,19 @@ "question": { "type": "string" }, + "question_parse_mode": { + "type": "string" + }, + "question_entities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MessageEntity" + } + }, "options": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/InputPollOption" } }, "is_anonymous": { @@ -15133,7 +15434,7 @@ } }, "/getChat": { - "description": "Use this method to get up to date information about the chat. Returns a Chat object on success.", + "description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.", "post": { "requestBody": { "required": true, @@ -15214,7 +15515,7 @@ "type": "object", "properties": { "result": { - "$ref": "#/components/schemas/Chat" + "$ref": "#/components/schemas/ChatFullInfo" } } } @@ -19652,6 +19953,9 @@ "longitude": { "type": "number" }, + "live_period": { + "type": "integer" + }, "horizontal_accuracy": { "type": "number" }, @@ -19697,6 +20001,9 @@ "longitude": { "type": "number" }, + "live_period": { + "type": "integer" + }, "horizontal_accuracy": { "type": "number" }, @@ -19742,6 +20049,9 @@ "longitude": { "type": "number" }, + "live_period": { + "type": "integer" + }, "horizontal_accuracy": { "type": "number" }, diff --git a/schemas/botapi_openapi.yaml b/schemas/botapi_openapi.yaml index 5ef8cfa..bafc443 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: 7.2.0 + version: 7.3.0 servers: - url: 'https://api.telegram.org/bot{token}' @@ -236,6 +236,34 @@ components: is_forum: type: boolean default: true + type: object + ChatFullInfo: + description: 'This object contains full information about a chat.' + required: + - id + - type + - accent_color_id + - max_reaction_count + properties: + id: + type: integer + type: + type: string + title: + type: string + username: + type: string + first_name: + type: string + last_name: + type: string + is_forum: + type: boolean + default: true + accent_color_id: + type: integer + max_reaction_count: + type: integer photo: $ref: '#/components/schemas/ChatPhoto' active_usernames: @@ -256,8 +284,6 @@ components: type: array items: $ref: '#/components/schemas/ReactionType' - accent_color_id: - type: integer background_custom_emoji_id: type: string profile_accent_color_id: @@ -474,6 +500,8 @@ components: $ref: '#/components/schemas/ProximityAlertTriggered' boost_added: $ref: '#/components/schemas/ChatBoostAdded' + chat_background_set: + $ref: '#/components/schemas/ChatBackground' forum_topic_created: $ref: '#/components/schemas/ForumTopicCreated' forum_topic_edited: @@ -937,9 +965,27 @@ components: properties: text: type: string + text_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' voter_count: type: integer type: object + InputPollOption: + description: 'This object contains information about one answer option in a poll to send.' + required: + - text + properties: + text: + type: string + text_parse_mode: + type: string + text_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' + type: object PollAnswer: description: 'This object represents an answer of a user in a non-anonymous poll.' required: @@ -973,6 +1019,10 @@ components: type: string question: type: string + question_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' options: type: array items: @@ -1082,6 +1132,143 @@ components: boost_count: type: integer type: object + BackgroundFill: + description: 'This object describes the way a background is filled based on the selected colors. Currently, it can be one of' + anyOf: + - + $ref: '#/components/schemas/BackgroundFillSolid' + - + $ref: '#/components/schemas/BackgroundFillGradient' + - + $ref: '#/components/schemas/BackgroundFillFreeformGradient' + BackgroundFillSolid: + description: 'The background is filled using the selected color.' + required: + - type + - color + properties: + type: + type: string + color: + type: integer + type: object + BackgroundFillGradient: + description: 'The background is a gradient fill.' + required: + - type + - top_color + - bottom_color + - rotation_angle + properties: + type: + type: string + top_color: + type: integer + bottom_color: + type: integer + rotation_angle: + type: integer + type: object + BackgroundFillFreeformGradient: + description: 'The background is a freeform gradient that rotates after every message in the chat.' + required: + - type + - colors + properties: + type: + type: string + colors: + type: array + items: + type: integer + type: object + BackgroundType: + description: 'This object describes the type of a background. Currently, it can be one of' + anyOf: + - + $ref: '#/components/schemas/BackgroundTypeFill' + - + $ref: '#/components/schemas/BackgroundTypeWallpaper' + - + $ref: '#/components/schemas/BackgroundTypePattern' + - + $ref: '#/components/schemas/BackgroundTypeChatTheme' + BackgroundTypeFill: + description: 'The background is automatically filled based on the selected colors.' + required: + - type + - fill + - dark_theme_dimming + properties: + type: + type: string + fill: + $ref: '#/components/schemas/BackgroundFill' + dark_theme_dimming: + type: integer + type: object + BackgroundTypeWallpaper: + description: 'The background is a wallpaper in the JPEG format.' + required: + - type + - document + - dark_theme_dimming + properties: + type: + type: string + document: + $ref: '#/components/schemas/Document' + dark_theme_dimming: + type: integer + is_blurred: + type: boolean + default: true + is_moving: + type: boolean + default: true + type: object + BackgroundTypePattern: + description: 'The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.' + required: + - type + - document + - fill + - intensity + properties: + type: + type: string + document: + $ref: '#/components/schemas/Document' + fill: + $ref: '#/components/schemas/BackgroundFill' + intensity: + type: integer + is_inverted: + type: boolean + default: true + is_moving: + type: boolean + default: true + type: object + BackgroundTypeChatTheme: + description: 'The background is taken directly from a built-in chat theme.' + required: + - type + - theme_name + properties: + type: + type: string + theme_name: + type: string + type: object + ChatBackground: + description: 'This object represents a chat background.' + required: + - type + properties: + type: + $ref: '#/components/schemas/BackgroundType' + type: object ForumTopicCreated: description: 'This object represents a service message about a new forum topic created in the chat.' required: @@ -1116,7 +1303,7 @@ components: description: 'This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.' type: object SharedUser: - description: 'This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button.' + description: 'This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.' required: - user_id properties: @@ -1338,7 +1525,7 @@ components: type: string type: object ReplyKeyboardMarkup: - description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).' + description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a Telegram Business account.' required: - keyboard properties: @@ -1401,7 +1588,7 @@ components: type: boolean type: object KeyboardButtonRequestChat: - description: 'This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the сhat if appropriate More about requesting chats »' + description: 'This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».' required: - request_id - chat_is_channel @@ -1436,7 +1623,7 @@ components: type: string type: object ReplyKeyboardRemove: - description: 'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).' + description: 'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.' required: - remove_keyboard properties: @@ -1535,7 +1722,7 @@ components: type: string type: object ForceReply: - description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode." + description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a Telegram Business account." required: - force_reply properties: @@ -1659,6 +1846,8 @@ components: $ref: '#/components/schemas/ChatMember' invite_link: $ref: '#/components/schemas/ChatInviteLink' + via_join_request: + type: boolean via_chat_folder_invite_link: type: boolean type: object @@ -1899,7 +2088,7 @@ components: type: boolean type: object Birthdate: - description: '' + description: 'Describes the birthdate of a user.' required: - day - month @@ -1912,7 +2101,7 @@ components: type: integer type: object BusinessIntro: - description: '' + description: 'Contains information about the start page settings of a Telegram Business account.' properties: title: type: string @@ -1922,7 +2111,7 @@ components: $ref: '#/components/schemas/Sticker' type: object BusinessLocation: - description: '' + description: 'Contains information about the location of a Telegram Business account.' required: - address properties: @@ -1932,7 +2121,7 @@ components: $ref: '#/components/schemas/Location' type: object BusinessOpeningHoursInterval: - description: '' + description: 'Describes an interval of time during which a business is open.' required: - opening_minute - closing_minute @@ -1943,7 +2132,7 @@ components: type: integer type: object BusinessOpeningHours: - description: '' + description: 'Describes the opening hours of a business.' required: - time_zone_name - opening_hours @@ -6218,7 +6407,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /sendVoice: - description: 'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.' + description: 'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.' post: requestBody: required: true @@ -7276,10 +7465,16 @@ paths: type: integer question: type: string + question_parse_mode: + type: string + question_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' options: type: array items: - type: string + $ref: '#/components/schemas/InputPollOption' is_anonymous: type: boolean default: true @@ -7340,10 +7535,16 @@ paths: type: integer question: type: string + question_parse_mode: + type: string + question_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' options: type: array items: - type: string + $ref: '#/components/schemas/InputPollOption' is_anonymous: type: boolean default: true @@ -7404,10 +7605,16 @@ paths: type: integer question: type: string + question_parse_mode: + type: string + question_entities: + type: array + items: + $ref: '#/components/schemas/MessageEntity' options: type: array items: - type: string + $ref: '#/components/schemas/InputPollOption' is_anonymous: type: boolean default: true @@ -9880,7 +10087,7 @@ paths: default: $ref: '#/components/responses/UnknownError' /getChat: - description: 'Use this method to get up to date information about the chat. Returns a Chat object on success.' + description: 'Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.' post: requestBody: required: true @@ -9934,7 +10141,7 @@ paths: type: object properties: result: - $ref: '#/components/schemas/Chat' + $ref: '#/components/schemas/ChatFullInfo' 400: $ref: '#/components/responses/BadRequest' 401: @@ -12682,6 +12889,8 @@ paths: type: number longitude: type: number + live_period: + type: integer horizontal_accuracy: type: number heading: @@ -12711,6 +12920,8 @@ paths: type: number longitude: type: number + live_period: + type: integer horizontal_accuracy: type: number heading: @@ -12740,6 +12951,8 @@ paths: type: number longitude: type: number + live_period: + type: integer horizontal_accuracy: type: number heading: diff --git a/schemas/botapi_postman.json b/schemas/botapi_postman.json index bca288f..b1b2cea 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": "7.2.0" + "version": "7.3.0" }, "variable": { "key": "token", @@ -327,7 +327,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -540,7 +540,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.", + "description": "Optional. 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", "type": "text" } ] @@ -704,7 +704,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -819,7 +819,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -922,7 +922,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1049,7 +1049,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1170,7 +1170,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1267,7 +1267,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1285,7 +1285,7 @@ "sendVoice" ] }, - "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future." + "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future." } }, { @@ -1358,7 +1358,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1492,7 +1492,7 @@ { "key": "live_period", "disabled": true, - "description": "Optional. Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.", + "description": "Optional. 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.", "type": "text" }, { @@ -1528,7 +1528,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1643,7 +1643,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1734,7 +1734,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1786,10 +1786,22 @@ "description": "Required. Poll question, 1-300 characters", "type": "text" }, + { + "key": "question_parse_mode", + "disabled": true, + "description": "Optional. Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed", + "type": "text" + }, + { + "key": "question_entities", + "disabled": true, + "description": "Optional. A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode", + "type": "text" + }, { "key": "options", "disabled": false, - "description": "Required. A JSON-serialized list of answer options, 2-10 strings 1-100 characters each", + "description": "Required. A JSON-serialized list of 2-10 answer options", "type": "text" }, { @@ -1833,7 +1845,7 @@ { "key": "explanation_entities", "disabled": true, - "description": "Optional. A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode", + "description": "Optional. A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode", "type": "text" }, { @@ -1875,7 +1887,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -1949,7 +1961,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. 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. Not supported for messages sent on behalf of a business account", + "description": "Optional. 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", "type": "text" } ] @@ -2366,7 +2378,7 @@ { "key": "can_edit_stories", "disabled": true, - "description": "Optional. Pass True if the administrator can edit stories posted by other users", + "description": "Optional. Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive", "type": "text" }, { @@ -3147,7 +3159,7 @@ "getChat" ] }, - "description": "Use this method to get up to date information about the chat. Returns a Chat object on success." + "description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success." } }, { @@ -4595,6 +4607,12 @@ "description": "Required. Longitude of new location", "type": "text" }, + { + "key": "live_period", + "disabled": true, + "description": "Optional. 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", + "type": "text" + }, { "key": "horizontal_accuracy", "disabled": true, @@ -4910,7 +4928,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account.", + "description": "Optional. 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", "type": "text" } ] @@ -6134,7 +6152,7 @@ { "key": "reply_markup", "disabled": true, - "description": "Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. Not supported for messages sent on behalf of a business account.", + "description": "Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.", "type": "text" } ]