{ "openapi": "3.1.0", "info": { "title": "Telegram Bot API", "version": "10.3", "description": "> The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.\nTo learn how to create and set up a bot, please consult our [**Introduction to Bots**](https://core.telegram.org/bots) and [**Bot FAQ**](https://core.telegram.org/bots/faq).", "termsOfService": "https://telegram.org/tos/bots" }, "externalDocs": { "description": "Telegram Bot API", "url": "https://core.telegram.org/bots/api" }, "servers": [ { "url": "https://api.telegram.org/bot{token}", "variables": { "token": { "default": "", "description": "The authentication token of the bot" } } } ], "security": [], "tags": [ { "name": "Bot" }, { "name": "Business" }, { "name": "Chat members" }, { "name": "Editing" }, { "name": "Forwarding" }, { "name": "Games" }, { "name": "Gifts" }, { "name": "Inline" }, { "name": "Media" }, { "name": "Messages" }, { "name": "Passport" }, { "name": "Payments" }, { "name": "Stickers" }, { "name": "Updates" }, { "name": "Users and chats" } ], "paths": { "/getMe": { "post": { "operationId": "getMe", "summary": "A simple method for testing your bot's authentication token.", "tags": [ "Bot" ], "description": "A simple method for testing your bot's authentication token. Returns basic information about the bot as [User](https://core.telegram.org/bots/api#user) on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/User" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyCommands": { "post": { "operationId": "getMyCommands", "summary": "Use this method to get the current list of the bot's commands for the given scope and user language.", "tags": [ "Bot" ], "description": "Use this method to get the current list of the bot's commands for the given scope and user language. If commands aren't set, an empty list is returned. Returns an Array of [BotCommand](https://core.telegram.org/bots/api#botcommand) objects on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyCommandsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/BotCommandOutput" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyCommands": { "post": { "operationId": "setMyCommands", "summary": "Use this method to change the list of the bot's commands.", "tags": [ "Bot" ], "description": "Use this method to change the list of the bot's commands. See [this manual](https://core.telegram.org/bots/features#commands) for more details about bot commands. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyCommandsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteMyCommands": { "post": { "operationId": "deleteMyCommands", "summary": "Use this method to delete the list of the bot's commands for the given scope and user language.", "tags": [ "Bot" ], "description": "Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, [higher level commands](https://core.telegram.org/bots/api#determining-list-of-commands) will be shown to affected users. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMyCommandsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyDefaultAdministratorRights": { "post": { "operationId": "getMyDefaultAdministratorRights", "summary": "Use this method to get the current default administrator rights of the bot.", "tags": [ "Bot" ], "description": "Use this method to get the current default administrator rights of the bot. Returns [ChatAdministratorRights](https://core.telegram.org/bots/api#chatadministratorrights) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyDefaultAdministratorRightsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatAdministratorRightsOutput" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyDefaultAdministratorRights": { "post": { "operationId": "setMyDefaultAdministratorRights", "summary": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels.", "tags": [ "Bot" ], "description": "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyDefaultAdministratorRightsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyName": { "post": { "operationId": "getMyName", "summary": "Use this method to get the current bot name for the given user language.", "tags": [ "Bot" ], "description": "Use this method to get the current bot name for the given user language. Returns [BotName](https://core.telegram.org/bots/api#botname) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyNameParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/BotName" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyName": { "post": { "operationId": "setMyName", "summary": "Use this method to change the bot's name.", "tags": [ "Bot" ], "description": "Use this method to change the bot's name. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyNameParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyProfilePhoto": { "post": { "operationId": "setMyProfilePhoto", "summary": "Changes the profile photo of the bot.", "tags": [ "Bot" ], "description": "Changes the profile photo of the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyProfilePhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/removeMyProfilePhoto": { "post": { "operationId": "removeMyProfilePhoto", "summary": "Removes the profile photo of the bot.", "tags": [ "Bot" ], "description": "Removes the profile photo of the bot. Returns *True* on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyDescription": { "post": { "operationId": "getMyDescription", "summary": "Use this method to get the current bot description for the given user language.", "tags": [ "Bot" ], "description": "Use this method to get the current bot description for the given user language. Returns [BotDescription](https://core.telegram.org/bots/api#botdescription) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyDescriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/BotDescription" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyDescription": { "post": { "operationId": "setMyDescription", "summary": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty.", "tags": [ "Bot" ], "description": "Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyDescriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyShortDescription": { "post": { "operationId": "getMyShortDescription", "summary": "Use this method to get the current bot short description for the given user language.", "tags": [ "Bot" ], "description": "Use this method to get the current bot short description for the given user language. Returns [BotShortDescription](https://core.telegram.org/bots/api#botshortdescription) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMyShortDescriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/BotShortDescription" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMyShortDescription": { "post": { "operationId": "setMyShortDescription", "summary": "Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.", "tags": [ "Bot" ], "description": "Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMyShortDescriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChatMenuButton": { "post": { "operationId": "getChatMenuButton", "summary": "Use this method to get the current value of the bot's menu button in a private chat, or the default menu button.", "tags": [ "Bot" ], "description": "Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns [MenuButton](https://core.telegram.org/bots/api#menubutton) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatMenuButtonParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/MenuButton" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatMenuButton": { "post": { "operationId": "setChatMenuButton", "summary": "Use this method to change the bot's menu button in a private chat, or the default menu button.", "tags": [ "Bot" ], "description": "Use this method to change the bot's menu button in a private chat, or the default menu button. Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatMenuButtonParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getManagedBotToken": { "post": { "operationId": "getManagedBotToken", "summary": "Use this method to get the token of a managed bot.", "tags": [ "Bot" ], "description": "Use this method to get the token of a managed bot. Returns the token as *String* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagedBotTokenParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getManagedBotAccessSettings": { "post": { "operationId": "getManagedBotAccessSettings", "summary": "Use this method to get the access settings of a managed bot.", "tags": [ "Bot" ], "description": "Use this method to get the access settings of a managed bot. Returns [BotAccessSettings](https://core.telegram.org/bots/api#botaccesssettings) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetManagedBotAccessSettingsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/BotAccessSettings" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setManagedBotAccessSettings": { "post": { "operationId": "setManagedBotAccessSettings", "summary": "Use this method to change the access settings of a managed bot.", "tags": [ "Bot" ], "description": "Use this method to change the access settings of a managed bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetManagedBotAccessSettingsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/replaceManagedBotToken": { "post": { "operationId": "replaceManagedBotToken", "summary": "Use this method to revoke the current token of a managed bot and generate a new one.", "tags": [ "Bot" ], "description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as *String* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceManagedBotTokenParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/postStory": { "post": { "operationId": "postStory", "summary": "Posts a story on behalf of a managed business account.", "tags": [ "Business" ], "description": "Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns [Story](https://core.telegram.org/bots/api#story) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostStoryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Story" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/repostStory": { "post": { "operationId": "repostStory", "summary": "Reposts a story on behalf of a business account from another business account.", "tags": [ "Business" ], "description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns [Story](https://core.telegram.org/bots/api#story) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepostStoryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Story" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editStory": { "post": { "operationId": "editStory", "summary": "Edits a story previously posted by the bot on behalf of a managed business account.", "tags": [ "Business" ], "description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns [Story](https://core.telegram.org/bots/api#story) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditStoryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Story" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteStory": { "post": { "operationId": "deleteStory", "summary": "Deletes a story previously posted by the bot on behalf of a managed business account.", "tags": [ "Business" ], "description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStoryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getBusinessConnection": { "post": { "operationId": "getBusinessConnection", "summary": "Use this method to get information about the connection of the bot with a business account.", "tags": [ "Business" ], "description": "Use this method to get information about the connection of the bot with a business account. Returns [BusinessConnection](https://core.telegram.org/bots/api#businessconnection) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBusinessConnectionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/BusinessConnection" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/readBusinessMessage": { "post": { "operationId": "readBusinessMessage", "summary": "Marks incoming message as read on behalf of a business account.", "tags": [ "Business" ], "description": "Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadBusinessMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteBusinessMessages": { "post": { "operationId": "deleteBusinessMessages", "summary": "Delete messages on behalf of a business account.", "tags": [ "Business" ], "description": "Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteBusinessMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setBusinessAccountName": { "post": { "operationId": "setBusinessAccountName", "summary": "Changes the first and last name of a managed business account.", "tags": [ "Business" ], "description": "Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBusinessAccountNameParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setBusinessAccountUsername": { "post": { "operationId": "setBusinessAccountUsername", "summary": "Changes the username of a managed business account.", "tags": [ "Business" ], "description": "Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBusinessAccountUsernameParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setBusinessAccountBio": { "post": { "operationId": "setBusinessAccountBio", "summary": "Changes the bio of a managed business account.", "tags": [ "Business" ], "description": "Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBusinessAccountBioParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setBusinessAccountProfilePhoto": { "post": { "operationId": "setBusinessAccountProfilePhoto", "summary": "Changes the profile photo of a managed business account.", "tags": [ "Business" ], "description": "Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBusinessAccountProfilePhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/removeBusinessAccountProfilePhoto": { "post": { "operationId": "removeBusinessAccountProfilePhoto", "summary": "Removes the current profile photo of a managed business account.", "tags": [ "Business" ], "description": "Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBusinessAccountProfilePhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setBusinessAccountGiftSettings": { "post": { "operationId": "setBusinessAccountGiftSettings", "summary": "Changes the privacy settings pertaining to incoming gifts in a managed business account.", "tags": [ "Business" ], "description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetBusinessAccountGiftSettingsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getBusinessAccountStarBalance": { "post": { "operationId": "getBusinessAccountStarBalance", "summary": "Returns the amount of Telegram Stars owned by a managed business account.", "tags": [ "Business" ], "description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns [StarAmount](https://core.telegram.org/bots/api#staramount) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBusinessAccountStarBalanceParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/StarAmount" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/transferBusinessAccountStars": { "post": { "operationId": "transferBusinessAccountStars", "summary": "Transfers Telegram Stars from the business account balance to the bot's balance.", "tags": [ "Business" ], "description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferBusinessAccountStarsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChatMember": { "post": { "operationId": "getChatMember", "summary": "Use this method to get information about a member of a chat.", "tags": [ "Chat members" ], "description": "Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns [ChatMember](https://core.telegram.org/bots/api#chatmember) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatMemberParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatMember" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChatAdministrators": { "post": { "operationId": "getChatAdministrators", "summary": "Use this method to get a list of administrators in a chat.", "tags": [ "Chat members" ], "description": "Use this method to get a list of administrators in a chat. Returns an Array of [ChatMember](https://core.telegram.org/bots/api#chatmember) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatAdministratorsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMember" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChatMemberCount": { "post": { "operationId": "getChatMemberCount", "summary": "Use this method to get the number of members in a chat.", "tags": [ "Chat members" ], "description": "Use this method to get the number of members in a chat. Returns *Integer* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatMemberCountParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "integer" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/leaveChat": { "post": { "operationId": "leaveChat", "summary": "Use this method for your bot to leave a group, supergroup or channel.", "tags": [ "Chat members" ], "description": "Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveChatParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/promoteChatMember": { "post": { "operationId": "promoteChatMember", "summary": "Use this method to promote or demote a user in a supergroup or a channel.", "tags": [ "Chat members" ], "description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromoteChatMemberParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatAdministratorCustomTitle": { "post": { "operationId": "setChatAdministratorCustomTitle", "summary": "Use this method to set a custom title for an administrator in a supergroup promoted by the bot.", "tags": [ "Chat members" ], "description": "Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatAdministratorCustomTitleParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatMemberTag": { "post": { "operationId": "setChatMemberTag", "summary": "Use this method to set a tag for a regular member in a group or a supergroup.", "tags": [ "Chat members" ], "description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatMemberTagParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/banChatMember": { "post": { "operationId": "banChatMember", "summary": "Use this method to ban a user in a group, a supergroup or a channel.", "tags": [ "Chat members" ], "description": "Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless [unbanned](https://core.telegram.org/bots/api#unbanchatmember) first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BanChatMemberParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/restrictChatMember": { "post": { "operationId": "restrictChatMember", "summary": "Use this method to restrict a user in a supergroup.", "tags": [ "Chat members" ], "description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass *True* for all permissions to lift restrictions from a user. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestrictChatMemberParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unbanChatMember": { "post": { "operationId": "unbanChatMember", "summary": "Use this method to unban a previously banned user in a supergroup or channel.", "tags": [ "Chat members" ], "description": "Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnbanChatMemberParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/banChatSenderChat": { "post": { "operationId": "banChatSenderChat", "summary": "Use this method to ban a channel chat in a supergroup or a channel.", "tags": [ "Chat members" ], "description": "Use this method to ban a channel chat in a supergroup or a channel. Until the chat is [unbanned](https://core.telegram.org/bots/api#unbanchatsenderchat), the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BanChatSenderChatParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unbanChatSenderChat": { "post": { "operationId": "unbanChatSenderChat", "summary": "Use this method to unban a previously banned channel chat in a supergroup or channel.", "tags": [ "Chat members" ], "description": "Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnbanChatSenderChatParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/approveChatJoinRequest": { "post": { "operationId": "approveChatJoinRequest", "summary": "Use this method to approve a chat join request.", "tags": [ "Chat members" ], "description": "Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveChatJoinRequestParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/declineChatJoinRequest": { "post": { "operationId": "declineChatJoinRequest", "summary": "Use this method to decline a chat join request.", "tags": [ "Chat members" ], "description": "Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineChatJoinRequestParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/stopPoll": { "post": { "operationId": "stopPoll", "summary": "Use this method to stop a poll which was sent by the bot.", "tags": [ "Editing" ], "description": "Use this method to stop a poll which was sent by the bot. Returns [Poll](https://core.telegram.org/bots/api#poll) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopPollParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Poll" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageText": { "post": { "operationId": "editMessageText", "summary": "Use this method to edit text, rich and game messages.", "tags": [ "Editing" ], "description": "Use this method to edit text, rich and [game](https://core.telegram.org/bots/api#games) messages. *True* is returned for inline messages. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageTextParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageLiveLocation": { "post": { "operationId": "editMessageLiveLocation", "summary": "Use this method to edit live location messages.", "tags": [ "Editing" ], "description": "Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to [stopMessageLiveLocation](https://core.telegram.org/bots/api#stopmessagelivelocation). *True* is returned for inline messages. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageLiveLocationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/stopMessageLiveLocation": { "post": { "operationId": "stopMessageLiveLocation", "summary": "Use this method to stop updating a live location message before *live_period* expires.", "tags": [ "Editing" ], "description": "Use this method to stop updating a live location message before *live_period* expires. *True* is returned for inline messages. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopMessageLiveLocationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageMedia": { "post": { "operationId": "editMessageMedia", "summary": "Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media.", "tags": [ "Editing" ], "description": "Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. *True* is returned for inline messages. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageMediaParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageCaption": { "post": { "operationId": "editMessageCaption", "summary": "Use this method to edit captions of messages.", "tags": [ "Editing" ], "description": "Use this method to edit captions of messages. *True* is returned for inline messages. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageCaptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageChecklist": { "post": { "operationId": "editMessageChecklist", "summary": "Use this method to edit a checklist on behalf of a connected business account.", "tags": [ "Editing" ], "description": "Use this method to edit a checklist on behalf of a connected business account. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageChecklistParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editMessageReplyMarkup": { "post": { "operationId": "editMessageReplyMarkup", "summary": "Use this method to edit only the reply markup of messages.", "tags": [ "Editing" ], "description": "Use this method to edit only the reply markup of messages. *True* is returned for inline messages. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageReplyMarkupParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editEphemeralMessageText": { "post": { "operationId": "editEphemeralMessageText", "summary": "Use this method to edit an ephemeral text or rich message.", "tags": [ "Editing" ], "description": "Use this method to edit an ephemeral text or rich message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditEphemeralMessageTextParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editEphemeralMessageMedia": { "post": { "operationId": "editEphemeralMessageMedia", "summary": "Use this method to edit the media of an ephemeral message.", "tags": [ "Editing" ], "description": "Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditEphemeralMessageMediaParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editEphemeralMessageCaption": { "post": { "operationId": "editEphemeralMessageCaption", "summary": "Use this method to edit the caption of an ephemeral message.", "tags": [ "Editing" ], "description": "Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditEphemeralMessageCaptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editEphemeralMessageReplyMarkup": { "post": { "operationId": "editEphemeralMessageReplyMarkup", "summary": "Use this method to edit only the reply markup of an ephemeral message.", "tags": [ "Editing" ], "description": "Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditEphemeralMessageReplyMarkupParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteMessage": { "post": { "operationId": "deleteMessage", "summary": "Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.", "tags": [ "Editing" ], "description": "Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n- Bots can delete incoming messages in private chats.\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n- If the bot is an administrator of a group, it can delete any message there.\n- If the bot has *can_delete_messages* administrator right in a supergroup or a channel, it can delete any message there.\n- If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat.\nReturns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteMessages": { "post": { "operationId": "deleteMessages", "summary": "Use this method to delete multiple messages simultaneously.", "tags": [ "Editing" ], "description": "Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteEphemeralMessage": { "post": { "operationId": "deleteEphemeralMessage", "summary": "Use this method to delete an ephemeral message.", "tags": [ "Editing" ], "description": "Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteEphemeralMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteMessageReaction": { "post": { "operationId": "deleteMessageReaction", "summary": "Use this method to remove a reaction from a message in a group or a supergroup chat.", "tags": [ "Editing" ], "description": "Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMessageReactionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteAllMessageReactions": { "post": { "operationId": "deleteAllMessageReactions", "summary": "Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat.", "tags": [ "Editing" ], "description": "Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAllMessageReactionsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/approveSuggestedPost": { "post": { "operationId": "approveSuggestedPost", "summary": "Use this method to approve a suggested post in a direct messages chat.", "tags": [ "Editing" ], "description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveSuggestedPostParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/declineSuggestedPost": { "post": { "operationId": "declineSuggestedPost", "summary": "Use this method to decline a suggested post in a direct messages chat.", "tags": [ "Editing" ], "description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclineSuggestedPostParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/copyMessage": { "post": { "operationId": "copyMessage", "summary": "Use this method to copy messages of any kind.", "tags": [ "Forwarding" ], "description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz [poll](https://core.telegram.org/bots/api#poll) can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method [forwardMessage](https://core.telegram.org/bots/api#forwardmessage), but the copied message doesn't have a link to the original message. The sent [Message](https://core.telegram.org/bots/api#message) is returned only for messages sent on behalf of a business account. Returns [MessageId](https://core.telegram.org/bots/api#messageid) or [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/MessageId" }, { "$ref": "#/components/schemas/Message" } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/copyMessages": { "post": { "operationId": "copyMessages", "summary": "Use this method to copy messages of any kind.", "tags": [ "Forwarding" ], "description": "Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz [poll](https://core.telegram.org/bots/api#poll) can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method [forwardMessages](https://core.telegram.org/bots/api#forwardmessages), but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. Returns the identifiers of the sent messages as an Array of [MessageId](https://core.telegram.org/bots/api#messageid) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/MessageId" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/forwardMessage": { "post": { "operationId": "forwardMessage", "summary": "Use this method to forward messages of any kind.", "tags": [ "Forwarding" ], "description": "Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/forwardMessages": { "post": { "operationId": "forwardMessages", "summary": "Use this method to forward multiple messages of any kind.", "tags": [ "Forwarding" ], "description": "Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. Returns the identifiers of the sent messages as an Array of [MessageId](https://core.telegram.org/bots/api#messageid) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForwardMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/MessageId" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendGame": { "post": { "operationId": "sendGame", "summary": "Use this method to send a game.", "tags": [ "Games" ], "description": "Use this method to send a game. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendGameParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setGameScore": { "post": { "operationId": "setGameScore", "summary": "Use this method to set the score of the specified user in a game message.", "tags": [ "Games" ], "description": "Use this method to set the score of the specified user in a game message. *True* is returned for inline messages. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*. Returns [Message](https://core.telegram.org/bots/api#message) or *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGameScoreParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "boolean", "const": true } ] } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getGameHighScores": { "post": { "operationId": "getGameHighScores", "summary": "Use this method to get data for high score tables.", "tags": [ "Games" ], "description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of [GameHighScore](https://core.telegram.org/bots/api#gamehighscore) objects on success.\n\n>This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGameHighScoresParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/GameHighScore" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getAvailableGifts": { "post": { "operationId": "getAvailableGifts", "summary": "Returns the list of gifts that can be sent by the bot to users and channel chats.", "tags": [ "Gifts" ], "description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Returns [Gifts](https://core.telegram.org/bots/api#gifts) on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Gifts" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendGift": { "post": { "operationId": "sendGift", "summary": "Sends a gift to the given user or channel chat.", "tags": [ "Gifts" ], "description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendGiftParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/giftPremiumSubscription": { "post": { "operationId": "giftPremiumSubscription", "summary": "Gifts a Telegram Premium subscription to the given user.", "tags": [ "Gifts" ], "description": "Gifts a Telegram Premium subscription to the given user. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GiftPremiumSubscriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getBusinessAccountGifts": { "post": { "operationId": "getBusinessAccountGifts", "summary": "Returns the gifts received and owned by a managed business account.", "tags": [ "Gifts" ], "description": "Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBusinessAccountGiftsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/OwnedGifts" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUserGifts": { "post": { "operationId": "getUserGifts", "summary": "Returns the gifts owned and hosted by a user.", "tags": [ "Gifts" ], "description": "Returns the gifts owned and hosted by a user. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserGiftsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/OwnedGifts" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChatGifts": { "post": { "operationId": "getChatGifts", "summary": "Returns the gifts owned by a chat.", "tags": [ "Gifts" ], "description": "Returns the gifts owned by a chat. Returns [OwnedGifts](https://core.telegram.org/bots/api#ownedgifts) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatGiftsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/OwnedGifts" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/convertGiftToStars": { "post": { "operationId": "convertGiftToStars", "summary": "Converts a given regular gift to Telegram Stars.", "tags": [ "Gifts" ], "description": "Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertGiftToStarsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/upgradeGift": { "post": { "operationId": "upgradeGift", "summary": "Upgrades a given regular gift to a unique gift.", "tags": [ "Gifts" ], "description": "Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpgradeGiftParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/transferGift": { "post": { "operationId": "transferGift", "summary": "Transfers an owned unique gift to another user.", "tags": [ "Gifts" ], "description": "Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferGiftParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerWebAppQuery": { "post": { "operationId": "answerWebAppQuery", "summary": "Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated.", "tags": [ "Inline" ], "description": "Use this method to set the result of an interaction with a [Web App](https://core.telegram.org/bots/webapps) and send a corresponding message on behalf of the user to the chat from which the query originated. Returns [SentWebAppMessage](https://core.telegram.org/bots/api#sentwebappmessage) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerWebAppQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/SentWebAppMessage" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerGuestQuery": { "post": { "operationId": "answerGuestQuery", "summary": "Use this method to reply to a received guest message.", "tags": [ "Inline" ], "description": "Use this method to reply to a received guest message. Returns [SentGuestMessage](https://core.telegram.org/bots/api#sentguestmessage) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerGuestQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/SentGuestMessage" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerInlineQuery": { "post": { "operationId": "answerInlineQuery", "summary": "Use this method to send answers to an inline query.", "tags": [ "Inline" ], "description": "Use this method to send answers to an inline query.\nNo more than **50** results per query are allowed. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerInlineQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerChatJoinRequestQuery": { "post": { "operationId": "answerChatJoinRequestQuery", "summary": "Use this method to process a received chat join request query.", "tags": [ "Inline" ], "description": "Use this method to process a received chat join request query. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerChatJoinRequestQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendChatJoinRequestWebApp": { "post": { "operationId": "sendChatJoinRequestWebApp", "summary": "Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome.", "tags": [ "Inline" ], "description": "Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call [answerChatJoinRequestQuery](https://core.telegram.org/bots/api#answerchatjoinrequestquery) to resolve the join request query based on the user interaction with the Mini App. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChatJoinRequestWebAppParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/savePreparedInlineMessage": { "post": { "operationId": "savePreparedInlineMessage", "summary": "Stores a message that can be sent by a user of a Mini App.", "tags": [ "Inline" ], "description": "Stores a message that can be sent by a user of a Mini App. Returns [PreparedInlineMessage](https://core.telegram.org/bots/api#preparedinlinemessage) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePreparedInlineMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/PreparedInlineMessage" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/savePreparedKeyboardButton": { "post": { "operationId": "savePreparedKeyboardButton", "summary": "Stores a keyboard button that can be used by a user within a Mini App.", "tags": [ "Inline" ], "description": "Stores a keyboard button that can be used by a user within a Mini App. Returns [PreparedKeyboardButton](https://core.telegram.org/bots/api#preparedkeyboardbutton) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePreparedKeyboardButtonParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/PreparedKeyboardButton" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerCallbackQuery": { "post": { "operationId": "answerCallbackQuery", "summary": "Use this method to send answers to callback queries sent from inline keyboards.", "tags": [ "Inline" ], "description": "Use this method to send answers to callback queries sent from [inline keyboards](https://core.telegram.org/bots/features#inline-keyboards). The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. Returns *True* on success.\n\n> Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via [@BotFather](https://t.me/botfather) and accept the terms. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerCallbackQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendAnimation": { "post": { "operationId": "sendAnimation", "summary": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).", "tags": [ "Media" ], "description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAnimationParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendAnimationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendAudio": { "post": { "operationId": "sendAudio", "summary": "Use this method to send audio files, if you want Telegram clients to display them in the music player.", "tags": [ "Media" ], "description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. Returns [Message](https://core.telegram.org/bots/api#message) on success.\n\nFor sending voice messages, use the [sendVoice](https://core.telegram.org/bots/api#sendvoice) method instead.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAudioParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendAudioParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendDocument": { "post": { "operationId": "sendDocument", "summary": "Use this method to send general files.", "tags": [ "Media" ], "description": "Use this method to send general files. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDocumentParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendDocumentParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendLivePhoto": { "post": { "operationId": "sendLivePhoto", "summary": "Use this method to send live photos.", "tags": [ "Media" ], "description": "Use this method to send live photos. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendLivePhotoParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendLivePhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendPhoto": { "post": { "operationId": "sendPhoto", "summary": "Use this method to send photos.", "tags": [ "Media" ], "description": "Use this method to send photos. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPhotoParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendPhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendVideo": { "post": { "operationId": "sendVideo", "summary": "Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document).", "tags": [ "Media" ], "description": "Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as [Document](https://core.telegram.org/bots/api#document)). Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVideoParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendVideoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendVideoNote": { "post": { "operationId": "sendVideoNote", "summary": "Use this method to send a rounded square MPEG4 video of up to 1 minute long.", "tags": [ "Media" ], "description": "Use this method to send a rounded square MPEG4 video of up to 1 minute long. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVideoNoteParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendVideoNoteParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendVoice": { "post": { "operationId": "sendVoice", "summary": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.", "tags": [ "Media" ], "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](https://core.telegram.org/bots/api#audio) or [Document](https://core.telegram.org/bots/api#document)). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVoiceParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendVoiceParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendPaidMedia": { "post": { "operationId": "sendPaidMedia", "summary": "Use this method to send paid media.", "tags": [ "Media" ], "description": "Use this method to send paid media. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPaidMediaParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendMediaGroup": { "post": { "operationId": "sendMediaGroup", "summary": "Use this method to send a group of photos, live photos, videos, documents or audios as an album.", "tags": [ "Media" ], "description": "Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns an Array of [Message](https://core.telegram.org/bots/api#message) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMediaGroupParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getFile": { "post": { "operationId": "getFile", "summary": "Use this method to get basic information about a file and prepare it for downloading.", "tags": [ "Media" ], "description": "Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. The file can then be downloaded via the link `https://api.telegram.org/file/bot/`, where `` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api#getfile) again. Returns [File](https://core.telegram.org/bots/api#file) on success.\n\n**Note:** This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFileParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/File" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendMessage": { "post": { "operationId": "sendMessage", "summary": "Use this method to send text messages.", "tags": [ "Messages" ], "description": "Use this method to send text messages. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendRichMessage": { "post": { "operationId": "sendRichMessage", "summary": "Use this method to send rich messages.", "tags": [ "Messages" ], "description": "Use this method to send rich messages. If the message contains a block with a media element, then the bot must have the right to send the media to the chat. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendRichMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendDice": { "post": { "operationId": "sendDice", "summary": "Use this method to send an animated emoji that will display a random value.", "tags": [ "Messages" ], "description": "Use this method to send an animated emoji that will display a random value. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDiceParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendLocation": { "post": { "operationId": "sendLocation", "summary": "Use this method to send point on the map.", "tags": [ "Messages" ], "description": "Use this method to send point on the map. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendLocationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendVenue": { "post": { "operationId": "sendVenue", "summary": "Use this method to send information about a venue.", "tags": [ "Messages" ], "description": "Use this method to send information about a venue. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendVenueParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendContact": { "post": { "operationId": "sendContact", "summary": "Use this method to send phone contacts.", "tags": [ "Messages" ], "description": "Use this method to send phone contacts. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendContactParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendPoll": { "post": { "operationId": "sendPoll", "summary": "Use this method to send a native poll.", "tags": [ "Messages" ], "description": "Use this method to send a native poll. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPollParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendChecklist": { "post": { "operationId": "sendChecklist", "summary": "Use this method to send a checklist on behalf of a connected business account.", "tags": [ "Messages" ], "description": "Use this method to send a checklist on behalf of a connected business account. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChecklistParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendChatAction": { "post": { "operationId": "sendChatAction", "summary": "Use this method when you need to tell the user that something is happening on the bot's side.", "tags": [ "Messages" ], "description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success.\n\n>Example: The [ImageBot](https://t.me/imagebot) needs some time to process a request and upload the image. Instead of sending a text message along the lines of \"Retrieving image, please wait...\", the bot may use [sendChatAction](https://core.telegram.org/bots/api#sendchataction) with *action* = *upload_photo*. The user will see a \"sending photo\" status for the bot.\n\nWe only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendChatActionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendMessageDraft": { "post": { "operationId": "sendMessageDraft", "summary": "Use this method to stream a partial message to a user while the message is being generated.", "tags": [ "Messages" ], "description": "Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you **must** call [sendMessage](https://core.telegram.org/bots/api#sendmessage) with the complete message to persist it in the user's chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageDraftParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendRichMessageDraft": { "post": { "operationId": "sendRichMessageDraft", "summary": "Use this method to stream a partial rich message to a user while the message is being generated.", "tags": [ "Messages" ], "description": "Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you **must** call [sendRichMessage](https://core.telegram.org/bots/api#sendrichmessage) with the complete message to persist it in the user's chat. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendRichMessageDraftParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setMessageReaction": { "post": { "operationId": "setMessageReaction", "summary": "Use this method to change the chosen reactions on a message.", "tags": [ "Messages" ], "description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMessageReactionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUserPersonalChatMessages": { "post": { "operationId": "getUserPersonalChatMessages", "summary": "Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user.", "tags": [ "Messages" ], "description": "Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. Returns an Array of [Message](https://core.telegram.org/bots/api#message) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserPersonalChatMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setPassportDataErrors": { "post": { "operationId": "setPassportDataErrors", "summary": "Informs a user that some of the Telegram Passport elements they provided contains errors.", "tags": [ "Passport" ], "description": "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns *True* on success.\n\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPassportDataErrorsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendInvoice": { "post": { "operationId": "sendInvoice", "summary": "Use this method to send invoices.", "tags": [ "Payments" ], "description": "Use this method to send invoices. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendInvoiceParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/createInvoiceLink": { "post": { "operationId": "createInvoiceLink", "summary": "Use this method to create a link for an invoice.", "tags": [ "Payments" ], "description": "Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getMyStarBalance": { "post": { "operationId": "getMyStarBalance", "summary": "A method to get the current Telegram Stars balance of the bot.", "tags": [ "Payments" ], "description": "A method to get the current Telegram Stars balance of the bot. Returns [StarAmount](https://core.telegram.org/bots/api#staramount) on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/StarAmount" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getStarTransactions": { "post": { "operationId": "getStarTransactions", "summary": "Returns the bot's Telegram Star transactions in chronological order.", "tags": [ "Payments" ], "description": "Returns the bot's Telegram Star transactions in chronological order. Returns [StarTransactions](https://core.telegram.org/bots/api#startransactions) on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStarTransactionsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/StarTransactions" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/refundStarPayment": { "post": { "operationId": "refundStarPayment", "summary": "Refunds a successful payment in Telegram Stars.", "tags": [ "Payments" ], "description": "Refunds a successful payment in [Telegram Stars](https://t.me/BotNews/90). Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundStarPaymentParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editUserStarSubscription": { "post": { "operationId": "editUserStarSubscription", "summary": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars.", "tags": [ "Payments" ], "description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditUserStarSubscriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerShippingQuery": { "post": { "operationId": "answerShippingQuery", "summary": "If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an Update with a *shipping_query* field to the bot.", "tags": [ "Payments" ], "description": "If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an [Update](https://core.telegram.org/bots/api#update) with a *shipping_query* field to the bot. Use this method to reply to shipping queries. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerShippingQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/answerPreCheckoutQuery": { "post": { "operationId": "answerPreCheckoutQuery", "summary": "Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field *pre_checkout_query*.", "tags": [ "Payments" ], "description": "Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an [Update](https://core.telegram.org/bots/api#update) with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerPreCheckoutQueryParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/sendSticker": { "post": { "operationId": "sendSticker", "summary": "Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers.", "tags": [ "Stickers" ], "description": "Use this method to send static .WEBP, [animated](https://telegram.org/blog/animated-stickers) .TGS, or [video](https://telegram.org/blog/video-stickers-better-reactions) .WEBM stickers. Returns [Message](https://core.telegram.org/bots/api#message) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendStickerParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendStickerParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/Message" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getStickerSet": { "post": { "operationId": "getStickerSet", "summary": "Use this method to get a sticker set.", "tags": [ "Stickers" ], "description": "Use this method to get a sticker set. Returns [StickerSet](https://core.telegram.org/bots/api#stickerset) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStickerSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/StickerSet" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getCustomEmojiStickers": { "post": { "operationId": "getCustomEmojiStickers", "summary": "Use this method to get information about custom emoji stickers by their identifiers.", "tags": [ "Stickers" ], "description": "Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of [Sticker](https://core.telegram.org/bots/api#sticker) objects on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomEmojiStickersParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Sticker" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/uploadStickerFile": { "post": { "operationId": "uploadStickerFile", "summary": "Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times).", "tags": [ "Stickers" ], "description": "Use this method to upload a file with a sticker for later use in the [createNewStickerSet](https://core.telegram.org/bots/api#createnewstickerset), [addStickerToSet](https://core.telegram.org/bots/api#addstickertoset), or [replaceStickerInSet](https://core.telegram.org/bots/api#replacestickerinset) methods (the file can be used multiple times). Returns the uploaded file as [File](https://core.telegram.org/bots/api#file) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadStickerFileParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadStickerFileParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/File" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/createNewStickerSet": { "post": { "operationId": "createNewStickerSet", "summary": "Use this method to create a new sticker set owned by a user.", "tags": [ "Stickers" ], "description": "Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNewStickerSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/addStickerToSet": { "post": { "operationId": "addStickerToSet", "summary": "Use this method to add a new sticker to a set created by the bot.", "tags": [ "Stickers" ], "description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddStickerToSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/replaceStickerInSet": { "post": { "operationId": "replaceStickerInSet", "summary": "Use this method to replace an existing sticker in a sticker set with a new one.", "tags": [ "Stickers" ], "description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling [deleteStickerFromSet](https://core.telegram.org/bots/api#deletestickerfromset), then [addStickerToSet](https://core.telegram.org/bots/api#addstickertoset), then [setStickerPositionInSet](https://core.telegram.org/bots/api#setstickerpositioninset). Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceStickerInSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerSetTitle": { "post": { "operationId": "setStickerSetTitle", "summary": "Use this method to set the title of a created sticker set.", "tags": [ "Stickers" ], "description": "Use this method to set the title of a created sticker set. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerSetTitleParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerSetThumbnail": { "post": { "operationId": "setStickerSetThumbnail", "summary": "Use this method to set the thumbnail of a regular or mask sticker set.", "tags": [ "Stickers" ], "description": "Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerSetThumbnailParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SetStickerSetThumbnailParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setCustomEmojiStickerSetThumbnail": { "post": { "operationId": "setCustomEmojiStickerSetThumbnail", "summary": "Use this method to set the thumbnail of a custom emoji sticker set.", "tags": [ "Stickers" ], "description": "Use this method to set the thumbnail of a custom emoji sticker set. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCustomEmojiStickerSetThumbnailParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteStickerSet": { "post": { "operationId": "deleteStickerSet", "summary": "Use this method to delete a sticker set that was created by the bot.", "tags": [ "Stickers" ], "description": "Use this method to delete a sticker set that was created by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStickerSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerPositionInSet": { "post": { "operationId": "setStickerPositionInSet", "summary": "Use this method to move a sticker in a set created by the bot to a specific position.", "tags": [ "Stickers" ], "description": "Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerPositionInSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteStickerFromSet": { "post": { "operationId": "deleteStickerFromSet", "summary": "Use this method to delete a sticker from a set created by the bot.", "tags": [ "Stickers" ], "description": "Use this method to delete a sticker from a set created by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStickerFromSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerEmojiList": { "post": { "operationId": "setStickerEmojiList", "summary": "Use this method to change the list of emoji assigned to a regular or custom emoji sticker.", "tags": [ "Stickers" ], "description": "Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerEmojiListParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerKeywords": { "post": { "operationId": "setStickerKeywords", "summary": "Use this method to change search keywords assigned to a regular or custom emoji sticker.", "tags": [ "Stickers" ], "description": "Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerKeywordsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setStickerMaskPosition": { "post": { "operationId": "setStickerMaskPosition", "summary": "Use this method to change the mask position of a mask sticker.", "tags": [ "Stickers" ], "description": "Use this method to change the [mask position](https://core.telegram.org/bots/api#maskposition) of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStickerMaskPositionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUpdates": { "post": { "operationId": "getUpdates", "summary": "Use this method to receive incoming updates using long polling (wiki).", "tags": [ "Updates" ], "description": "Use this method to receive incoming updates using long polling ([wiki](https://en.wikipedia.org/wiki/Push_technology#Long_polling)). Returns an Array of [Update](https://core.telegram.org/bots/api#update) objects on success.\n\n>**Notes**\n**1.** This method will not work if an outgoing webhook is set up.\n**2.** In order to avoid getting duplicate updates, recalculate *offset* after each server response.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUpdatesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Update" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setWebhook": { "post": { "operationId": "setWebhook", "summary": "Use this method to specify a URL and receive incoming updates via an outgoing webhook.", "tags": [ "Updates" ], "description": "Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized [Update](https://core.telegram.org/bots/api#update). In case of an unsuccessful request (a request with response [HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) different from `2XY`), we will repeat the request and give up after a reasonable amount of attempts. Returns *True* on success.\n\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret_token*. If specified, the request will contain a header \"X-Telegram-Bot-Api-Secret-Token\" with the secret token as content.\n\n>**Notes**\n**1.** You will not be able to receive updates using [getUpdates](https://core.telegram.org/bots/api#getupdates) for as long as an outgoing webhook is set up.\n**2.** To use a self-signed certificate, you need to upload your [public key certificate](https://core.telegram.org/bots/self-signed) using *certificate* parameter. Please upload as InputFile, sending a String will not work.\n**3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**.\n\n>If you're having any trouble setting up webhooks, please check out this [amazing guide to webhooks](https://core.telegram.org/bots/webhooks).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWebhookParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SetWebhookParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteWebhook": { "post": { "operationId": "deleteWebhook", "summary": "Use this method to remove webhook integration if you decide to switch back to getUpdates.", "tags": [ "Updates" ], "description": "Use this method to remove webhook integration if you decide to switch back to [getUpdates](https://core.telegram.org/bots/api#getupdates). Returns *True* on success.", "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getWebhookInfo": { "post": { "operationId": "getWebhookInfo", "summary": "Use this method to get current webhook status.", "tags": [ "Updates" ], "description": "Use this method to get current webhook status. If the bot is using [getUpdates](https://core.telegram.org/bots/api#getupdates), will return an object with the *url* field empty. Returns [WebhookInfo](https://core.telegram.org/bots/api#webhookinfo) on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/WebhookInfo" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUserProfilePhotos": { "post": { "operationId": "getUserProfilePhotos", "summary": "Use this method to get a list of profile pictures for a user.", "tags": [ "Users and chats" ], "description": "Use this method to get a list of profile pictures for a user. Returns [UserProfilePhotos](https://core.telegram.org/bots/api#userprofilephotos) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserProfilePhotosParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/UserProfilePhotos" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUserProfileAudios": { "post": { "operationId": "getUserProfileAudios", "summary": "Use this method to get a list of profile audios for a user.", "tags": [ "Users and chats" ], "description": "Use this method to get a list of profile audios for a user. Returns [UserProfileAudios](https://core.telegram.org/bots/api#userprofileaudios) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserProfileAudiosParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/UserProfileAudios" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/verifyUser": { "post": { "operationId": "verifyUser", "summary": "Verifies a user on behalf of the organization which is represented by the bot.", "tags": [ "Users and chats" ], "description": "Verifies a user [on behalf of the organization](https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyUserParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/verifyChat": { "post": { "operationId": "verifyChat", "summary": "Verifies a chat on behalf of the organization which is represented by the bot.", "tags": [ "Users and chats" ], "description": "Verifies a chat [on behalf of the organization](https://telegram.org/verify#third-party-verification) which is represented by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyChatParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/removeUserVerification": { "post": { "operationId": "removeUserVerification", "summary": "Removes verification from a user who is currently verified on behalf of the organization represented by the bot.", "tags": [ "Users and chats" ], "description": "Removes verification from a user who is currently verified [on behalf of the organization](https://telegram.org/verify#third-party-verification) represented by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveUserVerificationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/removeChatVerification": { "post": { "operationId": "removeChatVerification", "summary": "Removes verification from a chat that is currently verified on behalf of the organization represented by the bot.", "tags": [ "Users and chats" ], "description": "Removes verification from a chat that is currently verified [on behalf of the organization](https://telegram.org/verify#third-party-verification) represented by the bot. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveChatVerificationParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/exportChatInviteLink": { "post": { "operationId": "exportChatInviteLink", "summary": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked.", "tags": [ "Users and chats" ], "description": "Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as *String* on success.\n\n>Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using [exportChatInviteLink](https://core.telegram.org/bots/api#exportchatinvitelink) or by calling the [getChat](https://core.telegram.org/bots/api#getchat) method. If your bot needs to generate a new primary invite link replacing its previous one, use [exportChatInviteLink](https://core.telegram.org/bots/api#exportchatinvitelink) again.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportChatInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "string" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/createChatInviteLink": { "post": { "operationId": "createChatInviteLink", "summary": "Use this method to create an additional invite link for a chat.", "tags": [ "Users and chats" ], "description": "Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method [revokeChatInviteLink](https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatInviteLink" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/createChatSubscriptionInviteLink": { "post": { "operationId": "createChatSubscriptionInviteLink", "summary": "Use this method to create a subscription invite link for a channel chat.", "tags": [ "Users and chats" ], "description": "Use this method to create a [subscription invite link](https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions) for a channel chat. The bot must have the *can_invite_users* administrator rights. The link can be edited using the method [editChatSubscriptionInviteLink](https://core.telegram.org/bots/api#editchatsubscriptioninvitelink) or revoked using the method [revokeChatInviteLink](https://core.telegram.org/bots/api#revokechatinvitelink). Returns the new invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateChatSubscriptionInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatInviteLink" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editChatInviteLink": { "post": { "operationId": "editChatInviteLink", "summary": "Use this method to edit a non-primary invite link created by the bot.", "tags": [ "Users and chats" ], "description": "Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditChatInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatInviteLink" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editChatSubscriptionInviteLink": { "post": { "operationId": "editChatSubscriptionInviteLink", "summary": "Use this method to edit a subscription invite link created by the bot.", "tags": [ "Users and chats" ], "description": "Use this method to edit a subscription invite link created by the bot. The bot must have the *can_invite_users* administrator rights. Returns the edited invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditChatSubscriptionInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatInviteLink" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/revokeChatInviteLink": { "post": { "operationId": "revokeChatInviteLink", "summary": "Use this method to revoke an invite link created by the bot.", "tags": [ "Users and chats" ], "description": "Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as [ChatInviteLink](https://core.telegram.org/bots/api#chatinvitelink) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeChatInviteLinkParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatInviteLink" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setUserEmojiStatus": { "post": { "operationId": "setUserEmojiStatus", "summary": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess.", "tags": [ "Users and chats" ], "description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method [requestEmojiStatusAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps). Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetUserEmojiStatusParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getChat": { "post": { "operationId": "getChat", "summary": "Use this method to get up-to-date information about the chat.", "tags": [ "Users and chats" ], "description": "Use this method to get up-to-date information about the chat. Returns [ChatFullInfo](https://core.telegram.org/bots/api#chatfullinfo) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetChatParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ChatFullInfo" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatPhoto": { "post": { "operationId": "setChatPhoto", "summary": "Use this method to set a new profile photo for the chat.", "tags": [ "Users and chats" ], "description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatPhotoParams" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SetChatPhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteChatPhoto": { "post": { "operationId": "deleteChatPhoto", "summary": "Use this method to delete a chat photo.", "tags": [ "Users and chats" ], "description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteChatPhotoParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatTitle": { "post": { "operationId": "setChatTitle", "summary": "Use this method to change the title of a chat.", "tags": [ "Users and chats" ], "description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatTitleParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatPermissions": { "post": { "operationId": "setChatPermissions", "summary": "Use this method to set default chat permissions for all members.", "tags": [ "Users and chats" ], "description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatPermissionsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatDescription": { "post": { "operationId": "setChatDescription", "summary": "Use this method to change the description of a group, a supergroup or a channel.", "tags": [ "Users and chats" ], "description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatDescriptionParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/pinChatMessage": { "post": { "operationId": "pinChatMessage", "summary": "Use this method to add a message to the list of pinned messages in a chat.", "tags": [ "Users and chats" ], "description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinChatMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unpinChatMessage": { "post": { "operationId": "unpinChatMessage", "summary": "Use this method to remove a message from the list of pinned messages in a chat.", "tags": [ "Users and chats" ], "description": "Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinChatMessageParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unpinAllChatMessages": { "post": { "operationId": "unpinAllChatMessages", "summary": "Use this method to clear the list of pinned messages in a chat.", "tags": [ "Users and chats" ], "description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinAllChatMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/setChatStickerSet": { "post": { "operationId": "setChatStickerSet", "summary": "Use this method to set a new group sticker set for a supergroup.", "tags": [ "Users and chats" ], "description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in [getChat](https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetChatStickerSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteChatStickerSet": { "post": { "operationId": "deleteChatStickerSet", "summary": "Use this method to delete a group sticker set from a supergroup.", "tags": [ "Users and chats" ], "description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in [getChat](https://core.telegram.org/bots/api#getchat) requests to check if the bot can use this method. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteChatStickerSetParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getForumTopicIconStickers": { "post": { "operationId": "getForumTopicIconStickers", "summary": "Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user.", "tags": [ "Users and chats" ], "description": "Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Returns an Array of [Sticker](https://core.telegram.org/bots/api#sticker) objects on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/Sticker" } } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/createForumTopic": { "post": { "operationId": "createForumTopic", "summary": "Use this method to create a topic in a forum supergroup chat or a private chat with a user.", "tags": [ "Users and chats" ], "description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as [ForumTopic](https://core.telegram.org/bots/api#forumtopic) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/ForumTopic" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editForumTopic": { "post": { "operationId": "editForumTopic", "summary": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user.", "tags": [ "Users and chats" ], "description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/closeForumTopic": { "post": { "operationId": "closeForumTopic", "summary": "Use this method to close an open topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/reopenForumTopic": { "post": { "operationId": "reopenForumTopic", "summary": "Use this method to reopen a closed topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/deleteForumTopic": { "post": { "operationId": "deleteForumTopic", "summary": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user.", "tags": [ "Users and chats" ], "description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unpinAllForumTopicMessages": { "post": { "operationId": "unpinAllForumTopicMessages", "summary": "Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user.", "tags": [ "Users and chats" ], "description": "Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinAllForumTopicMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/editGeneralForumTopic": { "post": { "operationId": "editGeneralForumTopic", "summary": "Use this method to edit the name of the 'General' topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditGeneralForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/closeGeneralForumTopic": { "post": { "operationId": "closeGeneralForumTopic", "summary": "Use this method to close an open 'General' topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseGeneralForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/reopenGeneralForumTopic": { "post": { "operationId": "reopenGeneralForumTopic", "summary": "Use this method to reopen a closed 'General' topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenGeneralForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/hideGeneralForumTopic": { "post": { "operationId": "hideGeneralForumTopic", "summary": "Use this method to hide the 'General' topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HideGeneralForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unhideGeneralForumTopic": { "post": { "operationId": "unhideGeneralForumTopic", "summary": "Use this method to unhide the 'General' topic in a forum supergroup chat.", "tags": [ "Users and chats" ], "description": "Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnhideGeneralForumTopicParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/unpinAllGeneralForumTopicMessages": { "post": { "operationId": "unpinAllGeneralForumTopicMessages", "summary": "Use this method to clear the list of pinned messages in a General forum topic.", "tags": [ "Users and chats" ], "description": "Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpinAllGeneralForumTopicMessagesParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/getUserChatBoosts": { "post": { "operationId": "getUserChatBoosts", "summary": "Use this method to get the list of boosts added to a chat by a user.", "tags": [ "Users and chats" ], "description": "Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns [UserChatBoosts](https://core.telegram.org/bots/api#userchatboosts) on success.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserChatBoostsParams" } } } }, "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "result" ], "properties": { "ok": { "type": "boolean", "const": true }, "result": { "$ref": "#/components/schemas/UserChatBoosts" } } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/logOut": { "post": { "operationId": "logOut", "summary": "Use this method to log out from the cloud Bot API server before launching the bot locally.", "tags": [ "Bot" ], "description": "Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns *True* on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } }, "/close": { "post": { "operationId": "close", "summary": "Use this method to close the bot instance before moving it from one local server to another.", "tags": [ "Bot" ], "description": "Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success.", "responses": { "200": { "description": "The request was successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrueResponse" } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "5XX": { "$ref": "#/components/responses/Error" } } } } }, "webhooks": { "update": { "post": { "operationId": "receiveUpdate", "summary": "Receive an incoming update.", "description": "Sent to the URL given to [setWebhook](https://core.telegram.org/bots/api#setwebhook) for each incoming update, one update per request.", "tags": [ "Updates" ], "security": [ [], { "secretToken": [] }, { "basicAuth": [] }, { "secretToken": [], "basicAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Update" } } } }, "responses": { "2XX": { "description": "The update was received. The response can also make a request to a method, giving its name in *method* and its parameters as in a request, files included; the result of the request is not returned. Methods whose name starts with \"get\", setWebhook, deleteWebhook, close and logOut can't be requested this way.", "content": { "application/json": { "schema": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/SetMyCommandsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyCommands" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMyCommandsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMyCommands" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyDefaultAdministratorRightsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyDefaultAdministratorRights" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyNameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyName" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyProfilePhoto" } } } ] }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeMyProfilePhoto" } } }, { "allOf": [ { "$ref": "#/components/schemas/SetMyDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyShortDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyShortDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatMenuButtonParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatMenuButton" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetManagedBotAccessSettingsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setManagedBotAccessSettings" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReplaceManagedBotTokenParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "replaceManagedBotToken" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PostStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "postStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RepostStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "repostStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReadBusinessMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "readBusinessMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteBusinessMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteBusinessMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountNameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountName" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountUsernameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountUsername" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountBioParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountBio" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountProfilePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveBusinessAccountProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeBusinessAccountProfilePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountGiftSettingsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountGiftSettings" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/TransferBusinessAccountStarsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "transferBusinessAccountStars" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/LeaveChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "leaveChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PromoteChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "promoteChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatAdministratorCustomTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatAdministratorCustomTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatMemberTagParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatMemberTag" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/BanChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "banChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RestrictChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "restrictChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnbanChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unbanChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/BanChatSenderChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "banChatSenderChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnbanChatSenderChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unbanChatSenderChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ApproveChatJoinRequestParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "approveChatJoinRequest" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeclineChatJoinRequestParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "declineChatJoinRequest" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/StopPollParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "stopPoll" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageTextParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageText" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageLiveLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageLiveLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/StopMessageLiveLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "stopMessageLiveLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageCaptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageCaption" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageChecklistParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageChecklist" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageReplyMarkupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageReplyMarkup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageTextParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageText" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageCaptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageCaption" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageReplyMarkupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageReplyMarkup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteEphemeralMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteEphemeralMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessageReactionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessageReaction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteAllMessageReactionsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteAllMessageReactions" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ApproveSuggestedPostParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "approveSuggestedPost" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeclineSuggestedPostParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "declineSuggestedPost" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CopyMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "copyMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CopyMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "copyMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ForwardMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "forwardMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ForwardMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "forwardMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendGameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendGame" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetGameScoreParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setGameScore" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/GiftPremiumSubscriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "giftPremiumSubscription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ConvertGiftToStarsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "convertGiftToStars" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UpgradeGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "upgradeGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/TransferGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "transferGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerWebAppQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerWebAppQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerGuestQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerGuestQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerInlineQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerInlineQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerChatJoinRequestQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerChatJoinRequestQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChatJoinRequestWebAppParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChatJoinRequestWebApp" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SavePreparedInlineMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "savePreparedInlineMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SavePreparedKeyboardButtonParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "savePreparedKeyboardButton" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerCallbackQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerCallbackQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendAnimationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendAnimation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendAudioParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendAudio" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendDocumentParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendDocument" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendLivePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendLivePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVideoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVideo" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVideoNoteParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVideoNote" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVoiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVoice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPaidMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPaidMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMediaGroupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMediaGroup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendRichMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendRichMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendDiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendDice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVenueParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVenue" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendContactParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendContact" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPollParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPoll" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChecklistParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChecklist" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChatActionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChatAction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMessageDraftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMessageDraft" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendRichMessageDraftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendRichMessageDraft" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMessageReactionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMessageReaction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetPassportDataErrorsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setPassportDataErrors" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendInvoiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendInvoice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateInvoiceLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createInvoiceLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RefundStarPaymentParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "refundStarPayment" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditUserStarSubscriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editUserStarSubscription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerShippingQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerShippingQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerPreCheckoutQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerPreCheckoutQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendStickerParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendSticker" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UploadStickerFileParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "uploadStickerFile" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateNewStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createNewStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AddStickerToSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "addStickerToSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReplaceStickerInSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "replaceStickerInSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerSetTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerSetTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerSetThumbnailParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerSetThumbnail" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetCustomEmojiStickerSetThumbnailParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setCustomEmojiStickerSetThumbnail" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerPositionInSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerPositionInSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStickerFromSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStickerFromSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerEmojiListParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerEmojiList" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerKeywordsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerKeywords" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerMaskPositionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerMaskPosition" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/VerifyUserParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "verifyUser" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/VerifyChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "verifyChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveUserVerificationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeUserVerification" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveChatVerificationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeChatVerification" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ExportChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "exportChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateChatSubscriptionInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createChatSubscriptionInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditChatSubscriptionInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editChatSubscriptionInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RevokeChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "revokeChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetUserEmojiStatusParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setUserEmojiStatus" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteChatPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteChatPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatPermissionsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatPermissions" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PinChatMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "pinChatMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinChatMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinChatMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllChatMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllChatMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteChatStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteChatStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CloseForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "closeForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReopenForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "reopenForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllForumTopicMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllForumTopicMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CloseGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "closeGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReopenGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "reopenGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/HideGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "hideGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnhideGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unhideGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllGeneralForumTopicMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllGeneralForumTopicMessages" } } } ] } ] } }, "multipart/form-data": { "schema": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/SetMyCommandsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyCommands" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMyCommandsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMyCommands" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyDefaultAdministratorRightsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyDefaultAdministratorRights" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyNameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyName" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyProfilePhoto" } } } ] }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeMyProfilePhoto" } } }, { "allOf": [ { "$ref": "#/components/schemas/SetMyDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMyShortDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMyShortDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatMenuButtonParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatMenuButton" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetManagedBotAccessSettingsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setManagedBotAccessSettings" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReplaceManagedBotTokenParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "replaceManagedBotToken" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PostStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "postStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RepostStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "repostStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStoryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStory" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReadBusinessMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "readBusinessMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteBusinessMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteBusinessMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountNameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountName" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountUsernameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountUsername" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountBioParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountBio" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountProfilePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveBusinessAccountProfilePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeBusinessAccountProfilePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetBusinessAccountGiftSettingsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setBusinessAccountGiftSettings" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/TransferBusinessAccountStarsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "transferBusinessAccountStars" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/LeaveChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "leaveChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PromoteChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "promoteChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatAdministratorCustomTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatAdministratorCustomTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatMemberTagParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatMemberTag" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/BanChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "banChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RestrictChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "restrictChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnbanChatMemberParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unbanChatMember" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/BanChatSenderChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "banChatSenderChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnbanChatSenderChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unbanChatSenderChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ApproveChatJoinRequestParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "approveChatJoinRequest" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeclineChatJoinRequestParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "declineChatJoinRequest" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/StopPollParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "stopPoll" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageTextParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageText" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageLiveLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageLiveLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/StopMessageLiveLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "stopMessageLiveLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageCaptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageCaption" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageChecklistParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageChecklist" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditMessageReplyMarkupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editMessageReplyMarkup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageTextParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageText" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageCaptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageCaption" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditEphemeralMessageReplyMarkupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editEphemeralMessageReplyMarkup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteEphemeralMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteEphemeralMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteMessageReactionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteMessageReaction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteAllMessageReactionsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteAllMessageReactions" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ApproveSuggestedPostParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "approveSuggestedPost" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeclineSuggestedPostParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "declineSuggestedPost" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CopyMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "copyMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CopyMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "copyMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ForwardMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "forwardMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ForwardMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "forwardMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendGameParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendGame" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetGameScoreParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setGameScore" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/GiftPremiumSubscriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "giftPremiumSubscription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ConvertGiftToStarsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "convertGiftToStars" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UpgradeGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "upgradeGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/TransferGiftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "transferGift" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerWebAppQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerWebAppQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerGuestQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerGuestQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerInlineQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerInlineQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerChatJoinRequestQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerChatJoinRequestQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChatJoinRequestWebAppParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChatJoinRequestWebApp" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SavePreparedInlineMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "savePreparedInlineMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SavePreparedKeyboardButtonParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "savePreparedKeyboardButton" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerCallbackQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerCallbackQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendAnimationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendAnimation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendAudioParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendAudio" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendDocumentParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendDocument" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendLivePhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendLivePhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVideoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVideo" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVideoNoteParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVideoNote" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVoiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVoice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPaidMediaParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPaidMedia" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMediaGroupParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMediaGroup" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendRichMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendRichMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendDiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendDice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendLocationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendLocation" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendVenueParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendVenue" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendContactParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendContact" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendPollParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendPoll" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChecklistParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChecklist" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendChatActionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendChatAction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendMessageDraftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendMessageDraft" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendRichMessageDraftParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendRichMessageDraft" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetMessageReactionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setMessageReaction" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetPassportDataErrorsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setPassportDataErrors" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendInvoiceParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendInvoice" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateInvoiceLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createInvoiceLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RefundStarPaymentParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "refundStarPayment" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditUserStarSubscriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editUserStarSubscription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerShippingQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerShippingQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AnswerPreCheckoutQueryParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "answerPreCheckoutQuery" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SendStickerParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "sendSticker" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UploadStickerFileParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "uploadStickerFile" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateNewStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createNewStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/AddStickerToSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "addStickerToSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReplaceStickerInSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "replaceStickerInSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerSetTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerSetTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerSetThumbnailParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerSetThumbnail" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetCustomEmojiStickerSetThumbnailParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setCustomEmojiStickerSetThumbnail" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerPositionInSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerPositionInSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteStickerFromSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteStickerFromSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerEmojiListParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerEmojiList" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerKeywordsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerKeywords" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetStickerMaskPositionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setStickerMaskPosition" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/VerifyUserParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "verifyUser" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/VerifyChatParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "verifyChat" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveUserVerificationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeUserVerification" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RemoveChatVerificationParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "removeChatVerification" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ExportChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "exportChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateChatSubscriptionInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createChatSubscriptionInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditChatSubscriptionInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editChatSubscriptionInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/RevokeChatInviteLinkParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "revokeChatInviteLink" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetUserEmojiStatusParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setUserEmojiStatus" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteChatPhotoParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteChatPhoto" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatTitleParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatTitle" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatPermissionsParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatPermissions" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatDescriptionParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatDescription" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/PinChatMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "pinChatMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinChatMessageParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinChatMessage" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllChatMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllChatMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/SetChatStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "setChatStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteChatStickerSetParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteChatStickerSet" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CreateForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "createForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CloseForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "closeForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReopenForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "reopenForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/DeleteForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "deleteForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllForumTopicMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllForumTopicMessages" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/EditGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "editGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/CloseGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "closeGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/ReopenGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "reopenGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/HideGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "hideGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnhideGeneralForumTopicParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unhideGeneralForumTopic" } } } ] }, { "allOf": [ { "$ref": "#/components/schemas/UnpinAllGeneralForumTopicMessagesParams" }, { "type": "object", "required": [ "method" ], "properties": { "method": { "const": "unpinAllGeneralForumTopicMessages" } } } ] } ] } } } }, "default": { "description": "The update is sent again later, after the number of seconds in the Retry-After header, if any. If the webhook keeps responding with the status 410 for 23 hours, it is deleted." } } } } }, "components": { "schemas": { "WebAppInfo": { "type": "object", "description": "Describes a [Web App](https://core.telegram.org/bots/webapps).", "required": [ "url" ], "properties": { "url": { "description": "An HTTPS URL of a Web App to be opened with additional data as specified in [Initializing Web Apps](https://core.telegram.org/bots/webapps#initializing-mini-apps)", "type": "string" } } }, "CopyTextButton": { "type": "object", "description": "This object represents an inline keyboard button that copies specified text to the clipboard.", "required": [ "text" ], "properties": { "text": { "description": "The text to be copied to the clipboard, 1-256 characters", "type": "string", "minLength": 1, "maxLength": 256 } } }, "CallbackGame": { "type": "object", "description": "A placeholder, currently holds no information. Use [BotFather](https://t.me/botfather) to set up your game." }, "DisabledButton": { "type": "object", "description": "This object represents a disabled button which does nothing. Currently holds no information." }, "SwitchInlineQueryChosenChatInput": { "type": "object", "description": "This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.", "properties": { "query": { "description": "The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted.", "type": "string" }, "allow_user_chats": { "description": "*True*, if private chats with users can be chosen", "type": "boolean" }, "allow_bot_chats": { "description": "*True*, if private chats with bots can be chosen", "type": "boolean" }, "allow_group_chats": { "description": "*True*, if group and supergroup chats can be chosen", "type": "boolean" }, "allow_channel_chats": { "description": "*True*, if channel chats can be chosen", "type": "boolean" } } }, "SwitchInlineQueryChosenChatOutput": { "type": "object", "description": "This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.", "required": [ "query", "allow_user_chats", "allow_bot_chats", "allow_group_chats", "allow_channel_chats" ], "properties": { "query": { "description": "The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted.", "type": "string" }, "allow_user_chats": { "description": "*True*, if private chats with users can be chosen", "type": "boolean" }, "allow_bot_chats": { "description": "*True*, if private chats with bots can be chosen", "type": "boolean" }, "allow_group_chats": { "description": "*True*, if group and supergroup chats can be chosen", "type": "boolean" }, "allow_channel_chats": { "description": "*True*, if channel chats can be chosen", "type": "boolean" } } }, "InlineKeyboardButtonInput": { "type": "object", "description": "This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button.", "required": [ "text" ], "properties": { "text": { "description": "Label text on the button", "type": "string" }, "icon_custom_emoji_id": { "description": "Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on [Fragment](https://fragment.com) or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "style": { "description": "Style of the button. Must be one of \"danger\" (red), \"success\" (green) or \"primary\" (blue). If omitted, then an app-specific style is used.", "type": "string", "enum": [ "primary", "danger", "success" ] }, "url": { "description": "HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.", "type": "string" }, "web_app": { "description": "Description of the [Web App](https://core.telegram.org/bots/webapps) 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](https://core.telegram.org/bots/api#answerwebappquery). Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.", "$ref": "#/components/schemas/WebAppInfo" }, "callback_data": { "description": "Data to be sent in a [callback query](https://core.telegram.org/bots/api#callbackquery) to the bot when the button is pressed, 1-64 bytes", "type": "string" }, "switch_inline_query_current_chat": { "description": "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.\n\nThis 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 in channel direct messages chats and on behalf of a business account.", "type": "string" }, "switch_inline_query": { "description": "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 in channel direct messages chats and on behalf of a business account.", "type": "string" }, "switch_inline_query_chosen_chat": { "description": "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 in channel direct messages chats and on behalf of a business account.", "$ref": "#/components/schemas/SwitchInlineQueryChosenChatInput" }, "copy_text": { "description": "Description of the button that copies the specified text to the clipboard", "$ref": "#/components/schemas/CopyTextButton" }, "login_url": { "$ref": "#/components/schemas/LoginUrl" } } }, "InlineKeyboardButtonOutput": { "type": "object", "description": "This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button.", "required": [ "text" ], "properties": { "text": { "description": "Label text on the button", "type": "string" }, "icon_custom_emoji_id": { "description": "Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on [Fragment](https://fragment.com) or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.", "type": "string" }, "style": { "description": "Style of the button. Must be one of \"danger\" (red), \"success\" (green) or \"primary\" (blue). If omitted, then an app-specific style is used.", "type": "string", "enum": [ "primary", "danger", "success" ] }, "url": { "description": "HTTP or tg:// URL to be opened when the button is pressed. Links `tg://user?id=` can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.", "type": "string" }, "web_app": { "description": "Description of the [Web App](https://core.telegram.org/bots/webapps) 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](https://core.telegram.org/bots/api#answerwebappquery). Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.", "$ref": "#/components/schemas/WebAppInfo" }, "callback_data": { "description": "Data to be sent in a [callback query](https://core.telegram.org/bots/api#callbackquery) to the bot when the button is pressed, 1-64 bytes", "type": "string" }, "callback_game": { "description": "Description of the game that will be launched when the user presses the button.\n\n**NOTE:** This type of button **must** always be the first button in the first row.", "$ref": "#/components/schemas/CallbackGame" }, "switch_inline_query_current_chat": { "description": "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.\n\nThis 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 in channel direct messages chats and on behalf of a business account.", "type": "string" }, "switch_inline_query": { "description": "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 in channel direct messages chats and on behalf of a business account.", "type": "string" }, "switch_inline_query_chosen_chat": { "description": "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 in channel direct messages chats and on behalf of a business account.", "$ref": "#/components/schemas/SwitchInlineQueryChosenChatOutput" }, "pay": { "description": "Specify *True*, to send a [Pay button](https://core.telegram.org/bots/api#payments). Substrings \"⭐\" and \"XTR\" in the buttons's text will be replaced with a Telegram Star icon. \n\n**NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages.", "type": "boolean", "const": true }, "copy_text": { "description": "Description of the button that copies the specified text to the clipboard", "$ref": "#/components/schemas/CopyTextButton" }, "disabled": { "description": "If set, then the button is disabled and does nothing", "$ref": "#/components/schemas/DisabledButton" } } }, "PreparedKeyboardButton": { "type": "object", "description": "Describes a keyboard button to be used by a user of a Mini App.", "required": [ "id" ], "properties": { "id": { "description": "Unique identifier of the keyboard button", "type": "string" } } }, "File": { "type": "object", "description": "This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot/`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api#getfile).\n\n> The maximum file size to download is 20 MB", "required": [ "file_id", "file_unique_id" ], "properties": { "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" }, "file_path": { "description": "File path. Use `https://api.telegram.org/file/bot/` to get the file.", "type": "string" } } }, "PassportFile": { "type": "object", "description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.", "required": [ "file_id", "file_unique_id", "file_size", "file_date" ], "properties": { "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes", "type": "integer" }, "file_date": { "description": "Unix time when the file was uploaded", "type": "integer" } } }, "MaskPosition": { "type": "object", "description": "This object describes the position on faces where a mask should be placed by default.", "required": [ "point", "x_shift", "y_shift", "scale" ], "properties": { "point": { "description": "The part of the face relative to which the mask should be placed. Currently, can be \"forehead\", \"eyes\", \"mouth\", or \"chin\".", "type": "string", "enum": [ "forehead", "eyes", "mouth", "chin" ] }, "x_shift": { "description": "Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.", "type": "number" }, "y_shift": { "description": "Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.", "type": "number" }, "scale": { "description": "Mask scaling coefficient. For example, 2.0 means double size.", "type": "number" } } }, "Sticker": { "type": "object", "description": "This object represents a sticker.", "required": [ "width", "height", "is_animated", "is_video", "type", "file_id", "file_unique_id" ], "properties": { "width": { "description": "Sticker width", "type": "integer" }, "height": { "description": "Sticker height", "type": "integer" }, "emoji": { "description": "Emoji associated with the sticker", "type": "string" }, "set_name": { "description": "Name of the sticker set to which the sticker belongs", "type": "string" }, "is_animated": { "description": "*True*, if the sticker is [animated](https://telegram.org/blog/animated-stickers)", "type": "boolean" }, "is_video": { "description": "*True*, if the sticker is a [video sticker](https://telegram.org/blog/video-stickers-better-reactions)", "type": "boolean" }, "type": { "description": "Type of the sticker, currently can be \"regular\", \"mask\", or \"custom_emoji\". The type of the sticker is independent from its format, which is determined by the fields *is_animated* and *is_video*.", "type": "string", "enum": [ "regular", "mask", "custom_emoji" ] }, "premium_animation": { "description": "For premium regular stickers, premium animation for the sticker", "$ref": "#/components/schemas/File" }, "mask_position": { "description": "For mask stickers, the position where the mask should be placed", "$ref": "#/components/schemas/MaskPosition" }, "custom_emoji_id": { "description": "For custom emoji stickers, unique identifier of the custom emoji", "type": "string" }, "needs_repainting": { "description": "*True*, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places", "type": "boolean", "const": true }, "thumbnail": { "description": "Sticker thumbnail in the .WEBP or .JPG format", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "Audio": { "type": "object", "description": "This object represents an audio file to be treated as music by the Telegram clients.", "required": [ "duration", "file_id", "file_unique_id" ], "properties": { "duration": { "description": "Duration of the audio in seconds as defined by the sender", "type": "integer" }, "file_name": { "description": "Original filename as defined by the sender", "type": "string" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "title": { "description": "Title of the audio as defined by the sender or by audio tags", "type": "string" }, "performer": { "description": "Performer of the audio as defined by the sender or by audio tags", "type": "string" }, "thumbnail": { "description": "Thumbnail of the album cover to which the music file belongs", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "UserProfileAudios": { "type": "object", "description": "This object represents the audios displayed on a user's profile.", "required": [ "total_count", "audios" ], "properties": { "total_count": { "description": "Total number of profile audios for the target user", "type": "integer" }, "audios": { "description": "Requested profile audios", "type": "array", "items": { "$ref": "#/components/schemas/Audio" } } } }, "ChatPhoto": { "type": "object", "description": "This object represents a chat photo.", "required": [ "small_file_id", "small_file_unique_id", "big_file_id", "big_file_unique_id" ], "properties": { "small_file_id": { "description": "File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.", "type": "string" }, "small_file_unique_id": { "description": "Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "big_file_id": { "description": "File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.", "type": "string" }, "big_file_unique_id": { "description": "Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" } } }, "Animation": { "type": "object", "description": "This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).", "required": [ "duration", "width", "height", "file_id", "file_unique_id" ], "properties": { "file_name": { "description": "Original animation filename as defined by the sender", "type": "string" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "duration": { "description": "Duration of the video in seconds as defined by the sender", "type": "integer" }, "width": { "description": "Video width as defined by the sender", "type": "integer" }, "height": { "description": "Video height as defined by the sender", "type": "integer" }, "thumbnail": { "description": "Animation thumbnail as defined by the sender", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "Document": { "type": "object", "description": "This object represents a general file (as opposed to [photos](https://core.telegram.org/bots/api#photosize), [voice messages](https://core.telegram.org/bots/api#voice) and [audio files](https://core.telegram.org/bots/api#audio)).", "required": [ "file_id", "file_unique_id" ], "properties": { "file_name": { "description": "Original filename as defined by the sender", "type": "string" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "thumbnail": { "description": "Document thumbnail as defined by the sender", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "Link": { "type": "object", "description": "Represents an HTTP link.", "required": [ "url" ], "properties": { "url": { "description": "URL of the link", "type": "string" } } }, "PhotoSize": { "type": "object", "description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api#document) / [sticker](https://core.telegram.org/bots/api#sticker) thumbnail.", "required": [ "file_id", "file_unique_id", "width", "height" ], "properties": { "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" }, "width": { "description": "Photo width", "type": "integer" }, "height": { "description": "Photo height", "type": "integer" } } }, "LivePhoto": { "type": "object", "description": "This object represents a live photo.", "required": [ "photo", "duration", "width", "height", "file_id", "file_unique_id" ], "properties": { "photo": { "description": "Available sizes of the corresponding static photo", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "duration": { "description": "Duration of the video in seconds as defined by the sender", "type": "integer" }, "width": { "description": "Video width as defined by the sender", "type": "integer" }, "height": { "description": "Video height as defined by the sender", "type": "integer" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "file_id": { "description": "Identifier for the video file which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for the video file which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "VideoQuality": { "type": "object", "description": "This object represents a video file of a specific quality.", "required": [ "width", "height", "codec", "file_id", "file_unique_id" ], "properties": { "width": { "description": "Video width", "type": "integer" }, "height": { "description": "Video height", "type": "integer" }, "codec": { "description": "Codec that was used to encode the video, for example, \"h264\", \"h265\", or \"av01\"", "type": "string" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "Video": { "type": "object", "description": "This object represents a video file.", "required": [ "duration", "width", "height", "file_id", "file_unique_id" ], "properties": { "duration": { "description": "Duration of the video in seconds as defined by the sender", "type": "integer" }, "width": { "description": "Video width as defined by the sender", "type": "integer" }, "height": { "description": "Video height as defined by the sender", "type": "integer" }, "file_name": { "description": "Original filename as defined by the sender", "type": "string" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "thumbnail": { "description": "Video thumbnail", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" }, "cover": { "description": "Available sizes of the cover of the video in the message", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "start_timestamp": { "description": "Timestamp in seconds from which the video will play in the message", "type": "integer" }, "qualities": { "description": "List of available qualities of the video", "type": "array", "items": { "$ref": "#/components/schemas/VideoQuality" } } } }, "VideoNote": { "type": "object", "description": "This object represents a [video message](https://telegram.org/blog/video-messages-and-telescope).", "required": [ "duration", "length", "file_id", "file_unique_id" ], "properties": { "duration": { "description": "Duration of the video in seconds as defined by the sender", "type": "integer" }, "length": { "description": "Video width and height (diameter of the video message) as defined by the sender", "type": "integer" }, "thumbnail": { "description": "Video thumbnail", "$ref": "#/components/schemas/PhotoSize" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "Voice": { "type": "object", "description": "This object represents a voice note.", "required": [ "duration", "file_id", "file_unique_id" ], "properties": { "duration": { "description": "Duration of the audio in seconds as defined by the sender", "type": "integer" }, "mime_type": { "description": "MIME type of the file as defined by the sender", "type": "string" }, "file_id": { "description": "Identifier for this file, which can be used to download or reuse the file", "type": "string" }, "file_unique_id": { "description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.", "type": "string" }, "file_size": { "description": "File size in bytes. It can be bigger than 2^31 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 value.", "type": "integer" } } }, "PaidMediaPreview": { "type": "object", "description": "The paid media isn't available before the payment.", "required": [ "type" ], "properties": { "type": { "description": "Type of the paid media, always \"preview\"", "type": "string", "const": "preview" }, "width": { "description": "Media width as defined by the sender", "type": "integer" }, "height": { "description": "Media height as defined by the sender", "type": "integer" }, "duration": { "description": "Duration of the media in seconds as defined by the sender", "type": "integer" } } }, "PaidMediaPhoto": { "type": "object", "description": "The paid media is a photo.", "required": [ "type" ], "properties": { "type": { "description": "Type of the paid media, \"photo\", or \"live_photo\" for a live photo with its *live_photo* field", "type": "string", "enum": [ "live_photo", "photo" ] }, "live_photo": { "description": "The photo", "$ref": "#/components/schemas/LivePhoto" }, "photo": { "description": "The photo", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } } } }, "PaidMediaVideo": { "type": "object", "description": "The paid media is a video.", "required": [ "type", "video" ], "properties": { "type": { "description": "Type of the paid media, always \"video\"", "type": "string", "const": "video" }, "video": { "description": "The video", "$ref": "#/components/schemas/Video" } } }, "PaidMediaInfo": { "type": "object", "description": "Describes the paid media added to a message.", "required": [ "star_count", "paid_media" ], "properties": { "star_count": { "description": "The number of Telegram Stars that must be paid to buy access to the media", "type": "integer" }, "paid_media": { "description": "Information about the paid media", "type": "array", "items": { "$ref": "#/components/schemas/PaidMedia" } } } }, "UserProfilePhotos": { "type": "object", "description": "This object represent a user's profile pictures.", "required": [ "total_count", "photos" ], "properties": { "total_count": { "description": "Total number of profile pictures the target user has", "type": "integer" }, "photos": { "description": "Requested profile pictures (in up to 4 sizes each)", "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } } } } }, "StickerSet": { "type": "object", "description": "This object represents a sticker set.", "required": [ "name", "title", "sticker_type", "stickers" ], "properties": { "name": { "description": "Sticker set name", "type": "string" }, "title": { "description": "Sticker set title", "type": "string" }, "thumbnail": { "description": "Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format", "$ref": "#/components/schemas/PhotoSize" }, "sticker_type": { "description": "Type of stickers in the set, currently can be \"regular\", \"mask\", or \"custom_emoji\"", "type": "string", "enum": [ "regular", "mask", "custom_emoji" ] }, "stickers": { "description": "List of all set stickers", "type": "array", "items": { "$ref": "#/components/schemas/Sticker" } } } }, "PollAnswer": { "type": "object", "description": "This object represents an answer of a user in a non-anonymous poll.", "required": [ "poll_id", "option_ids", "option_persistent_ids" ], "properties": { "poll_id": { "description": "Unique poll identifier", "type": "string" }, "user": { "description": "The user that changed the answer to the poll, if the voter isn't anonymous", "$ref": "#/components/schemas/User" }, "voter_chat": { "description": "The chat that changed the answer to the poll, if the voter is anonymous", "$ref": "#/components/schemas/Chat" }, "option_ids": { "description": "0-based identifiers of chosen answer options. May be empty if the vote was retracted.", "type": "array", "items": { "type": "integer" } }, "option_persistent_ids": { "description": "Persistent identifiers of the chosen answer options. May be empty if the vote was retracted.", "type": "array", "items": { "type": "string" } } } }, "Giveaway": { "type": "object", "description": "This object represents a message about a scheduled giveaway.", "required": [ "chats", "winners_selection_date", "winner_count" ], "properties": { "chats": { "description": "The list of chats which the user must join to participate in the giveaway", "type": "array", "items": { "$ref": "#/components/schemas/Chat" } }, "winners_selection_date": { "description": "Point in time (Unix timestamp) when winners of the giveaway will be selected", "type": "integer" }, "winner_count": { "description": "The number of users which are supposed to be selected as winners of the giveaway", "type": "integer" }, "only_new_members": { "description": "*True*, if only users who join the chats after the giveaway started should be eligible to win", "type": "boolean", "const": true }, "has_public_winners": { "description": "*True*, if the list of giveaway winners will be visible to everyone", "type": "boolean", "const": true }, "country_codes": { "description": "A list of two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.", "type": "array", "items": { "type": "string" } }, "prize_description": { "description": "Description of additional giveaway prize", "type": "string" }, "premium_subscription_month_count": { "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only", "type": "integer" }, "prize_star_count": { "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only", "type": "integer" } } }, "LocationInput": { "type": "object", "description": "This object represents a point on the map.", "required": [ "latitude", "longitude" ], "properties": { "latitude": { "description": "Latitude as defined by the sender", "type": "number" }, "longitude": { "description": "Longitude as defined by the sender", "type": "number" }, "horizontal_accuracy": { "description": "The radius of uncertainty for the location, measured in meters, 0-1500", "type": "number", "minimum": 0, "maximum": 1500 } } }, "LocationOutput": { "type": "object", "description": "This object represents a point on the map.", "required": [ "latitude", "longitude" ], "properties": { "latitude": { "description": "Latitude as defined by the sender", "type": "number" }, "longitude": { "description": "Longitude as defined by the sender", "type": "number" }, "horizontal_accuracy": { "description": "The radius of uncertainty for the location, measured in meters, 0-1500", "type": "number", "minimum": 0, "maximum": 1500 }, "live_period": { "description": "Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.", "type": "integer" }, "heading": { "description": "The direction in which user is moving, in degrees; 1-360. For active live locations only.", "type": "integer" }, "proximity_alert_radius": { "description": "The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.", "type": "integer" } } }, "MessageOrigin": { "description": "This object describes the origin of a message.", "oneOf": [ { "$ref": "#/components/schemas/MessageOriginUser" }, { "$ref": "#/components/schemas/MessageOriginHiddenUser" }, { "$ref": "#/components/schemas/MessageOriginChat" }, { "$ref": "#/components/schemas/MessageOriginChannel" } ], "discriminator": { "propertyName": "type", "mapping": { "user": "#/components/schemas/MessageOriginUser", "hidden_user": "#/components/schemas/MessageOriginHiddenUser", "chat": "#/components/schemas/MessageOriginChat", "channel": "#/components/schemas/MessageOriginChannel" } } }, "MessageOriginUser": { "type": "object", "description": "The message was originally sent by a known user.", "required": [ "type", "sender_user", "date" ], "properties": { "type": { "description": "Type of the message origin, always \"user\"", "type": "string", "const": "user" }, "sender_user": { "description": "User that sent the message originally", "$ref": "#/components/schemas/User" }, "date": { "description": "Date the message was sent originally in Unix time", "type": "integer" } } }, "MessageOriginHiddenUser": { "type": "object", "description": "The message was originally sent by an unknown user.", "required": [ "type", "date" ], "properties": { "type": { "description": "Type of the message origin, always \"hidden_user\"", "type": "string", "const": "hidden_user" }, "sender_user_name": { "description": "Name of the user that sent the message originally", "type": "string" }, "date": { "description": "Date the message was sent originally in Unix time", "type": "integer" } } }, "MessageOriginChat": { "type": "object", "description": "The message was originally sent on behalf of a chat to a group chat.", "required": [ "type", "sender_chat", "date" ], "properties": { "type": { "description": "Type of the message origin, always \"chat\"", "type": "string", "const": "chat" }, "sender_chat": { "description": "Chat that sent the message originally", "$ref": "#/components/schemas/Chat" }, "author_signature": { "description": "For messages originally sent by an anonymous chat administrator, original message author signature", "type": "string" }, "date": { "description": "Date the message was sent originally in Unix time", "type": "integer" } } }, "MessageOriginChannel": { "type": "object", "description": "The message was originally sent to a channel chat.", "required": [ "type", "chat", "message_id", "date" ], "properties": { "type": { "description": "Type of the message origin, always \"channel\"", "type": "string", "const": "channel" }, "chat": { "description": "Channel chat to which the message was originally sent", "$ref": "#/components/schemas/Chat" }, "message_id": { "description": "Unique message identifier inside the chat", "type": "integer" }, "author_signature": { "description": "Signature of the original post author", "type": "string" }, "date": { "description": "Date the message was sent originally in Unix time", "type": "integer" } } }, "Venue": { "type": "object", "description": "This object represents a venue.", "required": [ "location", "title", "address" ], "properties": { "location": { "description": "Venue location. Can't be a live location.", "$ref": "#/components/schemas/LocationOutput" }, "title": { "description": "Name of the venue", "type": "string" }, "address": { "description": "Address of the venue", "type": "string" }, "foursquare_id": { "description": "Foursquare identifier of the venue", "type": "string" }, "foursquare_type": { "description": "Foursquare type of the venue. (For example, \"arts_entertainment/default\", \"arts_entertainment/aquarium\" or \"food/icecream\".)", "type": "string" }, "google_place_id": { "description": "Google Places identifier of the venue", "type": "string" }, "google_place_type": { "description": "Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).)", "type": "string" } } }, "Contact": { "type": "object", "description": "This object represents a phone contact.", "required": [ "phone_number", "first_name" ], "properties": { "phone_number": { "description": "Contact's phone number", "type": "string" }, "first_name": { "description": "Contact's first name", "type": "string" }, "last_name": { "description": "Contact's last name", "type": "string" }, "vcard": { "description": "Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard)", "type": "string" }, "user_id": { "description": "Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.", "type": "integer" } } }, "Dice": { "type": "object", "description": "This object represents an animated emoji that displays a random value.", "required": [ "emoji", "value" ], "properties": { "emoji": { "description": "Emoji on which the dice throw animation is based", "type": "string" }, "value": { "description": "Value of the dice, 1-6 for \"🎲\", \"🎯\" and \"🎳\" base emoji, 1-5 for \"🏀\" and \"⚽\" base emoji, 1-64 for \"🎰\" base emoji", "type": "integer" } } }, "Game": { "type": "object", "description": "This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.", "required": [ "title", "description", "photo" ], "properties": { "title": { "description": "Title of the game", "type": "string" }, "text": { "description": "Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls [setGameScore](https://core.telegram.org/bots/api#setgamescore), or manually edited using [editMessageText](https://core.telegram.org/bots/api#editmessagetext). 0-4096 characters.", "type": "string" }, "text_entities": { "description": "Special entities that appear in *text*, such as usernames, URLs, bot commands, etc.", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "description": { "description": "Description of the game", "type": "string" }, "photo": { "description": "Photo that will be displayed in the game message in chats", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "animation": { "description": "Animation that will be displayed in the game message in chats. Upload via [BotFather](https://t.me/botfather).", "$ref": "#/components/schemas/Animation" } } }, "PollOption": { "type": "object", "description": "This object contains information about one answer option in a poll.", "required": [ "persistent_id", "text", "voter_count" ], "properties": { "persistent_id": { "description": "Unique identifier of the option, persistent on option addition and deletion", "type": "string" }, "text": { "description": "Option text, 1-100 characters", "type": "string", "minLength": 1, "maxLength": 100 }, "text_entities": { "description": "Special entities that appear in the option *text*. Currently, only custom emoji entities are allowed in poll option texts", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "media": { "description": "Media added to the poll option", "$ref": "#/components/schemas/PollMedia" }, "voter_count": { "description": "Number of users who voted for this option; may be 0 if unknown", "type": "integer" }, "added_by_user": { "description": "User who added the option; omitted if the option wasn't added by a user after poll creation", "$ref": "#/components/schemas/User" }, "added_by_chat": { "description": "Chat that added the option; omitted if the option wasn't added by a chat after poll creation", "$ref": "#/components/schemas/Chat" }, "addition_date": { "description": "Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original poll", "type": "integer" } } }, "Poll": { "type": "object", "description": "This object contains information about a poll.", "required": [ "id", "question", "options", "total_voter_count", "is_closed", "is_anonymous", "allows_multiple_answers", "allows_revoting", "members_only", "type" ], "properties": { "id": { "description": "Unique poll identifier", "type": "string" }, "question": { "description": "Poll question, 1-300 characters", "type": "string", "minLength": 1, "maxLength": 300 }, "question_entities": { "description": "Special entities that appear in the *question*. Currently, only custom emoji entities are allowed in poll questions", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "options": { "description": "List of poll options", "type": "array", "items": { "$ref": "#/components/schemas/PollOption" } }, "total_voter_count": { "description": "Total number of users that voted in the poll", "type": "integer" }, "open_period": { "description": "Amount of time in seconds the poll will be active after creation", "type": "integer" }, "close_date": { "description": "Point in time (Unix timestamp) when the poll will be automatically closed", "type": "integer" }, "is_closed": { "description": "*True*, if the poll is closed", "type": "boolean" }, "is_anonymous": { "description": "*True*, if the poll is anonymous", "type": "boolean" }, "allows_multiple_answers": { "description": "*True*, if the poll allows multiple answers", "type": "boolean" }, "allows_revoting": { "description": "*True*, if the poll allows to change the chosen answer options", "type": "boolean" }, "members_only": { "description": "*True* if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours", "type": "boolean" }, "country_codes": { "description": "A list of two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes indicating the countries from which users can vote in the poll. The country code \"FT\" is used for users with anonymous numbers. If omitted, then users from any country can participate in the poll.", "type": "array", "items": { "type": "string" } }, "type": { "description": "Poll type, currently can be \"regular\" or \"quiz\"", "type": "string", "enum": [ "regular", "quiz" ] }, "correct_option_id": { "description": "The 0-based identifier of the correct answer option", "type": "integer" }, "correct_option_ids": { "description": "Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.", "type": "array", "items": { "type": "integer" } }, "explanation": { "description": "Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters", "type": "string", "minLength": 0, "maxLength": 200 }, "explanation_entities": { "description": "Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation*", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "explanation_media": { "description": "Media added to the quiz explanation", "$ref": "#/components/schemas/PollMedia" }, "description": { "description": "Description of the poll; for polls inside the [Message](https://core.telegram.org/bots/api#message) object only", "type": "string" }, "description_entities": { "description": "Special entities like usernames, URLs, bot commands, etc. that appear in the description", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "media": { "description": "Media added to the poll description; for polls inside the [Message](https://core.telegram.org/bots/api#message) object only", "$ref": "#/components/schemas/PollMedia" } } }, "PollOptionAdded": { "type": "object", "description": "Describes a service message about an option added to a poll.", "required": [ "option_persistent_id", "option_text" ], "properties": { "poll_message": { "description": "Message containing the poll to which the option was added, if known. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/MaybeInaccessibleMessage" }, "option_persistent_id": { "description": "Unique identifier of the added option", "type": "string" }, "option_text": { "description": "Option text", "type": "string" }, "option_entities": { "description": "Special entities that appear in the option_text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } } } }, "PollOptionDeleted": { "type": "object", "description": "Describes a service message about an option deleted from a poll.", "required": [ "option_persistent_id", "option_text" ], "properties": { "poll_message": { "description": "Message containing the poll from which the option was deleted, if known. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/MaybeInaccessibleMessage" }, "option_persistent_id": { "description": "Unique identifier of the deleted option", "type": "string" }, "option_text": { "description": "Option text", "type": "string" }, "option_entities": { "description": "Special entities that appear in the option_text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } } } }, "ChecklistTask": { "type": "object", "description": "Describes a task in a checklist.", "required": [ "id", "text" ], "properties": { "id": { "description": "Unique identifier of the task", "type": "integer" }, "text": { "description": "Text of the task", "type": "string" }, "text_entities": { "description": "Special entities that appear in the task text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "completed_by_user": { "description": "User that completed the task; omitted if the task wasn't completed by a user", "$ref": "#/components/schemas/User" }, "completed_by_chat": { "description": "Chat that completed the task; omitted if the task wasn't completed by a chat", "$ref": "#/components/schemas/Chat" }, "completion_date": { "description": "Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed", "type": "integer" } } }, "Checklist": { "type": "object", "description": "Describes a checklist.", "required": [ "title", "tasks" ], "properties": { "title": { "description": "Title of the checklist", "type": "string" }, "title_entities": { "description": "Special entities that appear in the checklist title", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "tasks": { "description": "List of tasks in the checklist", "type": "array", "items": { "$ref": "#/components/schemas/ChecklistTask" } }, "others_can_add_tasks": { "description": "*True*, if users other than the creator of the list can add tasks to the list", "type": "boolean", "const": true }, "others_can_mark_tasks_as_done": { "description": "*True*, if users other than the creator of the list can mark tasks as done or not done", "type": "boolean", "const": true } } }, "ChecklistTasksDone": { "type": "object", "description": "Describes a service message about checklist tasks marked as done or not done.", "properties": { "checklist_message": { "description": "Message containing the checklist whose tasks were marked as done or not done. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "marked_as_done_task_ids": { "description": "Identifiers of the tasks that were marked as done", "type": "array", "items": { "type": "integer" } }, "marked_as_not_done_task_ids": { "description": "Identifiers of the tasks that were marked as not done", "type": "array", "items": { "type": "integer" } } } }, "ChecklistTasksAdded": { "type": "object", "description": "Describes a service message about tasks added to a checklist.", "required": [ "tasks" ], "properties": { "checklist_message": { "description": "Message containing the checklist to which the tasks were added. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "tasks": { "description": "List of tasks added to the checklist", "type": "array", "items": { "$ref": "#/components/schemas/ChecklistTask" } } } }, "SuggestedPostApprovalFailed": { "type": "object", "description": "Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.", "required": [ "price" ], "properties": { "suggested_post_message": { "description": "Message containing the suggested post whose approval has failed. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "price": { "description": "Expected price of the post", "$ref": "#/components/schemas/SuggestedPostPrice" } } }, "SuggestedPostApproved": { "type": "object", "description": "Describes a service message about the approval of a suggested post.", "required": [ "send_date" ], "properties": { "suggested_post_message": { "description": "Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "price": { "description": "Amount paid for the post", "$ref": "#/components/schemas/SuggestedPostPrice" }, "send_date": { "description": "Date when the post will be published", "type": "integer" } } }, "SuggestedPostDeclined": { "type": "object", "description": "Describes a service message about the rejection of a suggested post.", "properties": { "suggested_post_message": { "description": "Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "comment": { "description": "Comment with which the post was declined", "type": "string" } } }, "SuggestedPostPaid": { "type": "object", "description": "Describes a service message about a successful payment for a suggested post.", "required": [ "currency" ], "properties": { "suggested_post_message": { "description": "Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "currency": { "description": "Currency in which the payment was made. Currently, one of \"XTR\" for Telegram Stars or \"TON\" for TON grams.", "type": "string", "enum": [ "XTR", "TON" ] }, "star_amount": { "description": "The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only", "$ref": "#/components/schemas/StarAmount" }, "amount": { "description": "The amount of the currency that was received by the channel in nanograms; for payments in TON grams only", "type": "integer" } } }, "SuggestedPostRefunded": { "type": "object", "description": "Describes a service message about a payment refund for a suggested post.", "required": [ "reason" ], "properties": { "suggested_post_message": { "description": "Message containing the suggested post. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain the *reply_to_message* field even if it itself is a reply.", "$ref": "#/components/schemas/Message" }, "reason": { "description": "Reason for the refund. Currently, one of \"post_deleted\" if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or \"payment_refunded\" if the payer refunded their payment.", "type": "string", "enum": [ "post_deleted", "payment_refunded" ] } } }, "Story": { "type": "object", "description": "This object represents a story.", "required": [ "chat", "id" ], "properties": { "chat": { "description": "Chat that posted the story", "$ref": "#/components/schemas/Chat" }, "id": { "description": "Unique identifier for the story in the chat", "type": "integer" } } }, "ChatOwnerChanged": { "type": "object", "description": "Describes a service message about an ownership change in the chat.", "required": [ "new_owner" ], "properties": { "new_owner": { "description": "The new owner of the chat", "$ref": "#/components/schemas/User" } } }, "ChatOwnerLeft": { "type": "object", "description": "Describes a service message about the chat owner leaving the chat.", "properties": { "new_owner": { "description": "The user who will become the new owner of the chat if the previous owner does not return to the chat", "$ref": "#/components/schemas/User" } } }, "ForumTopicCreated": { "type": "object", "description": "This object represents a service message about a new forum topic created in the chat.", "required": [ "name", "icon_color" ], "properties": { "name": { "description": "Name of the topic", "type": "string" }, "icon_color": { "description": "Color of the topic icon in RGB format", "type": "integer" }, "icon_custom_emoji_id": { "description": "Unique identifier of the custom emoji shown as the topic icon", "type": "string" }, "is_name_implicit": { "description": "*True*, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot", "type": "boolean", "const": true } } }, "ForumTopicEdited": { "type": "object", "description": "This object represents a service message about an edited forum topic.", "properties": { "name": { "description": "New name of the topic, if it was edited", "type": "string" }, "icon_custom_emoji_id": { "description": "New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed", "type": "string" } } }, "ForumTopic": { "type": "object", "description": "This object represents a forum topic.", "required": [ "message_thread_id", "name", "icon_color" ], "properties": { "message_thread_id": { "description": "Unique identifier of the forum topic", "type": "integer" }, "name": { "description": "Name of the topic", "type": "string" }, "icon_color": { "description": "Color of the topic icon in RGB format", "type": "integer" }, "icon_custom_emoji_id": { "description": "Unique identifier of the custom emoji shown as the topic icon", "type": "string" } } }, "WebAppData": { "type": "object", "description": "Describes data sent from a [Web App](https://core.telegram.org/bots/webapps) to the bot.", "required": [ "button_text", "data" ], "properties": { "button_text": { "description": "Text of the *web_app* keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.", "type": "string" }, "data": { "description": "The data. Be aware that a bad client can send arbitrary data in this field.", "type": "string" } } }, "ProximityAlertTriggered": { "type": "object", "description": "This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.", "required": [ "traveler", "watcher", "distance" ], "properties": { "traveler": { "description": "User that triggered the alert", "oneOf": [ { "$ref": "#/components/schemas/User" }, { "$ref": "#/components/schemas/Chat" } ] }, "watcher": { "description": "User that set the alert", "oneOf": [ { "$ref": "#/components/schemas/User" }, { "$ref": "#/components/schemas/Chat" } ] }, "distance": { "description": "The distance between the users", "type": "integer" } } }, "VideoChatScheduled": { "type": "object", "description": "This object represents a service message about a video chat scheduled in the chat.", "required": [ "start_date" ], "properties": { "start_date": { "description": "Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator", "type": "integer" } } }, "VideoChatEnded": { "type": "object", "description": "This object represents a service message about a video chat ended in the chat.", "required": [ "duration" ], "properties": { "duration": { "description": "Video chat duration in seconds", "type": "integer" } } }, "VideoChatParticipantsInvited": { "type": "object", "description": "This object represents a service message about new members invited to a video chat.", "required": [ "users" ], "properties": { "users": { "description": "New members that were invited to the video chat", "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "MessageAutoDeleteTimerChanged": { "type": "object", "description": "This object represents a service message about a change in auto-delete timer settings.", "required": [ "message_auto_delete_time" ], "properties": { "message_auto_delete_time": { "description": "New auto-delete time for messages in the chat; in seconds", "type": "integer" } } }, "WriteAccessAllowed": { "type": "object", "description": "This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps).", "properties": { "web_app_name": { "description": "Name of the Web App, if the access was granted when the Web App was launched from a link", "type": "string" }, "from_request": { "description": "*True*, if the access was granted after the user accepted an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps)", "type": "boolean", "const": true }, "from_attachment_menu": { "description": "*True*, if the access was granted when the bot was added to the attachment or side menu", "type": "boolean", "const": true } } }, "SharedUser": { "type": "object", "description": "This object contains information about a user that was shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.", "required": [ "user_id" ], "properties": { "user_id": { "description": "Identifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.", "type": "integer" }, "first_name": { "description": "First name of the user, if the name was requested by the bot", "type": "string" }, "last_name": { "description": "Last name of the user, if the name was requested by the bot", "type": "string" }, "username": { "description": "Username of the user, if the username was requested by the bot", "type": "string" }, "photo": { "description": "Available sizes of the chat photo, if the photo was requested by the bot", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } } } }, "UsersShared": { "type": "object", "description": "This object contains information about the users whose identifiers were shared with the bot using a [KeyboardButtonRequestUsers](https://core.telegram.org/bots/api#keyboardbuttonrequestusers) button.", "required": [ "users", "request_id" ], "properties": { "users": { "description": "Information about users shared with the bot", "type": "array", "items": { "$ref": "#/components/schemas/SharedUser" } }, "request_id": { "description": "Identifier of the request", "type": "integer" } } }, "ChatShared": { "type": "object", "description": "This object contains information about a chat that was shared with the bot using a [KeyboardButtonRequestChat](https://core.telegram.org/bots/api#keyboardbuttonrequestchat) button.", "required": [ "chat_id", "request_id" ], "properties": { "chat_id": { "description": "Identifier of the shared 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 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.", "type": "integer" }, "title": { "description": "Title of the chat, if the title was requested by the bot", "type": "string" }, "username": { "description": "Username of the chat, if the username was requested by the bot and available", "type": "string" }, "photo": { "description": "Available sizes of the chat photo, if the photo was requested by the bot", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "request_id": { "description": "Identifier of the request", "type": "integer" } } }, "ManagedBotCreated": { "type": "object", "description": "This object contains information about the bot that was created to be managed by the current bot.", "required": [ "bot" ], "properties": { "bot": { "description": "Information about the bot. The bot's token can be fetched using the method [getManagedBotToken](https://core.telegram.org/bots/api#getmanagedbottoken).", "$ref": "#/components/schemas/User" } } }, "ManagedBotUpdated": { "type": "object", "description": "This object contains information about the creation, token update, or owner update of a bot that is managed by the current bot.", "required": [ "user", "bot" ], "properties": { "user": { "description": "User that created the bot", "$ref": "#/components/schemas/User" }, "bot": { "description": "Information about the bot. Token of the bot can be fetched using the method [getManagedBotToken](https://core.telegram.org/bots/api#getmanagedbottoken).", "$ref": "#/components/schemas/User" } } }, "BotSubscriptionUpdated": { "type": "object", "description": "This object contains information about changes to a user payment subscription toward the current bot.", "required": [ "user", "invoice_payload", "state" ], "properties": { "user": { "description": "User who subscribed for payments toward the bot", "$ref": "#/components/schemas/User" }, "invoice_payload": { "description": "Bot-specified invoice payload", "type": "string" }, "state": { "description": "The new state of the subscription. Currently, it can be one of \"canceled\" if the user canceled the subscription, \"active\" if the user re-enabled a previously canceled subscription, or \"failed\" if payment for the subscription failed.", "type": "string", "enum": [ "canceled", "active", "failed" ] } } }, "MessageGenerationStopped": { "type": "object", "description": "This object describes an update about a user stopping message generation.", "required": [ "chat", "draft_id" ], "properties": { "chat": { "description": "Chat in which the message is generated", "$ref": "#/components/schemas/Chat" }, "message_thread_id": { "description": "Unique identifier of the message thread in which the message is generated", "type": "integer" }, "draft_id": { "description": "Unique identifier of the message draft which was stopped", "type": "string" } } }, "CommunityChatAdded": { "type": "object", "description": "Describes a service message about a chat or a bot being added to a community.", "required": [ "community" ], "properties": { "community": { "description": "The new community to which the chat or the bot belongs", "$ref": "#/components/schemas/Community" } } }, "CommunityChatJoined": { "type": "object", "description": "Describes a service message about a chat being joined by a user from a community.", "required": [ "community" ], "properties": { "community": { "description": "The community from which the chat was joined", "$ref": "#/components/schemas/Community" } } }, "GiveawayCreated": { "type": "object", "description": "This object represents a service message about the creation of a scheduled giveaway.", "properties": { "prize_star_count": { "description": "The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only", "type": "integer" } } }, "GiveawayWinners": { "type": "object", "description": "This object represents a message about the completion of a giveaway with public winners.", "required": [ "chat", "giveaway_message_id", "winners_selection_date", "winner_count", "winners" ], "properties": { "chat": { "description": "The chat that created the giveaway", "$ref": "#/components/schemas/Chat" }, "giveaway_message_id": { "description": "Identifier of the message with the giveaway in the chat", "type": "integer" }, "additional_chat_count": { "description": "The number of other chats the user had to join in order to be eligible for the giveaway", "type": "integer" }, "winners_selection_date": { "description": "Point in time (Unix timestamp) when winners of the giveaway were selected", "type": "integer" }, "only_new_members": { "description": "*True*, if only users who had joined the chats after the giveaway started were eligible to win", "type": "boolean", "const": true }, "was_refunded": { "description": "*True*, if the giveaway was canceled because the payment for it was refunded", "type": "boolean", "const": true }, "premium_subscription_month_count": { "description": "The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only", "type": "integer" }, "prize_star_count": { "description": "The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only", "type": "integer" }, "prize_description": { "description": "Description of additional giveaway prize", "type": "string" }, "winner_count": { "description": "Total number of winners in the giveaway", "type": "integer" }, "unclaimed_prize_count": { "description": "Number of undistributed prizes", "type": "integer" }, "winners": { "description": "List of winners of the giveaway, at most 100 elements", "type": "array", "items": { "$ref": "#/components/schemas/User" }, "maxItems": 100 } } }, "GiveawayCompleted": { "type": "object", "description": "This object represents a service message about the completion of a giveaway without public winners.", "required": [ "winner_count" ], "properties": { "winner_count": { "description": "Number of winners in the giveaway", "type": "integer" }, "unclaimed_prize_count": { "description": "Number of undistributed prizes", "type": "integer" }, "is_star_giveaway": { "description": "*True*, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.", "type": "boolean", "const": true }, "giveaway_message": { "description": "Message with the giveaway that was completed, if it wasn't deleted", "$ref": "#/components/schemas/Message" } } }, "PaidMessagePriceChanged": { "type": "object", "description": "Describes a service message about a change in the price of paid messages within a chat.", "required": [ "paid_message_star_count" ], "properties": { "paid_message_star_count": { "description": "The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message", "type": "integer" } } }, "DirectMessagePriceChanged": { "type": "object", "description": "Describes a service message about a change in the price of direct messages sent to a channel chat.", "required": [ "are_direct_messages_enabled" ], "properties": { "are_direct_messages_enabled": { "description": "*True*, if direct messages are enabled for the channel chat; *False* otherwise", "type": "boolean" }, "direct_message_star_count": { "description": "The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.", "type": "integer" } } }, "DirectMessagesTopic": { "type": "object", "description": "Describes a topic of a direct messages chat.", "required": [ "topic_id", "user" ], "properties": { "topic_id": { "description": "Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.", "type": "integer" }, "user": { "description": "Information about the user that created the topic. Currently, it is always present.", "$ref": "#/components/schemas/User" } } }, "ExternalReplyInfo": { "type": "object", "description": "This object contains information about a message that is being replied to, which may come from another chat or forum topic.", "required": [ "origin" ], "properties": { "origin": { "description": "Origin of the message replied to by the given message", "$ref": "#/components/schemas/MessageOrigin" }, "chat": { "description": "Chat the original message belongs to. Available only if the chat is a supergroup or a channel.", "$ref": "#/components/schemas/Chat" }, "message_id": { "description": "Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.", "type": "integer" }, "link_preview_options": { "description": "Options used for link preview generation for the original message, if it is a text message", "$ref": "#/components/schemas/LinkPreviewOptionsOutput" }, "animation": { "description": "Message is an animation, information about the animation", "$ref": "#/components/schemas/Animation" }, "has_media_spoiler": { "description": "*True*, if the message media is covered by a spoiler animation", "type": "boolean", "const": true }, "audio": { "description": "Message is an audio file, information about the file", "$ref": "#/components/schemas/Audio" }, "document": { "description": "Message is a general file, information about the file", "$ref": "#/components/schemas/Document" }, "paid_media": { "description": "Message contains paid media; information about the paid media", "$ref": "#/components/schemas/PaidMediaInfo" }, "live_photo": { "description": "Message is a live photo, information about the live photo", "$ref": "#/components/schemas/LivePhoto" }, "photo": { "description": "Message is a photo, available sizes of the photo", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "sticker": { "description": "Message is a sticker, information about the sticker", "$ref": "#/components/schemas/Sticker" }, "video": { "description": "Message is a video, information about the video", "$ref": "#/components/schemas/Video" }, "video_note": { "description": "Message is a [video note](https://telegram.org/blog/video-messages-and-telescope), information about the video message", "$ref": "#/components/schemas/VideoNote" }, "voice": { "description": "Message is a voice message, information about the file", "$ref": "#/components/schemas/Voice" }, "location": { "description": "Message is a shared location, information about the location", "$ref": "#/components/schemas/LocationOutput" }, "venue": { "description": "Message is a venue, information about the venue", "$ref": "#/components/schemas/Venue" }, "contact": { "description": "Message is a shared contact, information about the contact", "$ref": "#/components/schemas/Contact" }, "dice": { "description": "Message is a dice with random value", "$ref": "#/components/schemas/Dice" }, "game": { "description": "Message is a game, information about the game. [More about games »](https://core.telegram.org/bots/api#games)", "$ref": "#/components/schemas/Game" }, "poll": { "description": "Message is a native poll, information about the poll", "$ref": "#/components/schemas/Poll" }, "story": { "description": "Message is a forwarded story", "$ref": "#/components/schemas/Story" }, "checklist": { "description": "Message is a checklist", "$ref": "#/components/schemas/Checklist" }, "invoice": { "description": "Message is an invoice for a [payment](https://core.telegram.org/bots/api#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api#payments)", "$ref": "#/components/schemas/Invoice" }, "giveaway": { "description": "Message is a scheduled giveaway, information about the giveaway", "$ref": "#/components/schemas/Giveaway" }, "giveaway_winners": { "description": "A giveaway with public winners was completed", "$ref": "#/components/schemas/GiveawayWinners" } } }, "Message": { "type": "object", "description": "This object represents a message.", "required": [ "message_id", "chat", "date" ], "properties": { "business_connection_id": { "description": "Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.", "type": "string" }, "sender_business_bot": { "description": "The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.", "$ref": "#/components/schemas/User" }, "message_id": { "description": "Unique message identifier inside this chat; 0 for ephemeral messages. In specific instances (e.g., a message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.", "type": "integer" }, "ephemeral_message_id": { "description": "For ephemeral messages, identifier of the ephemeral message inside this chat. The identifier may be reused for another ephemeral message after the message is deleted or expires.", "type": "integer" }, "from": { "description": "Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.", "$ref": "#/components/schemas/User" }, "author_signature": { "description": "Signature of the post author for messages in channels, or the custom title of an anonymous group administrator", "type": "string" }, "sender_chat": { "description": "Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field *from* contains a fake sender user in non-channel chats.", "$ref": "#/components/schemas/Chat" }, "chat": { "description": "Chat the message belongs to", "$ref": "#/components/schemas/Chat" }, "date": { "description": "Date the message was sent in Unix time. It is always a positive number, representing a valid date.", "type": "integer" }, "edit_date": { "description": "Date the message was last edited in Unix time", "type": "integer" }, "message_thread_id": { "description": "Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only", "type": "integer" }, "receiver_user": { "description": "For ephemeral messages, the user who received the message", "$ref": "#/components/schemas/User" }, "forward_origin": { "description": "Information about the original message for forwarded messages", "$ref": "#/components/schemas/MessageOrigin" }, "is_automatic_forward": { "description": "*True*, if the message is a channel post that was automatically forwarded to the connected discussion group", "type": "boolean", "const": true }, "reply_to_message": { "description": "For replies in the same chat and message thread, the original message. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain further *reply_to_message* fields even if it itself is a reply. If the message is a reply to an ephemeral message, then this field may be omitted.", "$ref": "#/components/schemas/Message" }, "external_reply": { "description": "Information about the message that is being replied to, which may come from another chat or forum topic", "$ref": "#/components/schemas/ExternalReplyInfo" }, "quote": { "description": "For replies that quote part of the original message, the quoted part of the message", "$ref": "#/components/schemas/TextQuote" }, "reply_to_checklist_task_id": { "description": "Identifier of the specific checklist task that is being replied to", "type": "integer" }, "reply_to_poll_option_id": { "description": "Persistent identifier of the specific poll option that is being replied to", "type": "string" }, "reply_to_story": { "description": "For replies to a story, the original story", "$ref": "#/components/schemas/Story" }, "media_group_id": { "description": "The unique identifier inside this chat of a media message group this message belongs to", "type": "string" }, "guest_query_id": { "description": "The unique identifier for the guest query. Use this identifier with the method [answerGuestQuery](https://core.telegram.org/bots/api#answerguestquery) to send a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not coincide with other existing bot chats sharing the same identifier.", "type": "string" }, "text": { "description": "For text messages, the actual UTF-8 text of the message", "type": "string" }, "entities": { "description": "For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "link_preview_options": { "description": "Options used for link preview generation for the message, if it is a text message and link preview options were changed", "$ref": "#/components/schemas/LinkPreviewOptionsOutput" }, "rich_message": { "description": "Message is a rich formatted message", "$ref": "#/components/schemas/RichMessage" }, "animation": { "description": "Message is an animation, information about the animation. For backward compatibility, when this field is set, the *document* field will also be set.", "$ref": "#/components/schemas/Animation" }, "document": { "description": "Message is a general file, information about the file", "$ref": "#/components/schemas/Document" }, "caption": { "description": "Caption for the animation, audio, document, paid media, photo, video or voice", "type": "string" }, "caption_entities": { "description": "For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "show_caption_above_media": { "description": "*True*, if the caption must be shown above the message media", "type": "boolean", "const": true }, "has_media_spoiler": { "description": "*True*, if the message media is covered by a spoiler animation", "type": "boolean", "const": true }, "audio": { "description": "Message is an audio file, information about the file", "$ref": "#/components/schemas/Audio" }, "paid_media": { "description": "Message contains paid media; information about the paid media", "$ref": "#/components/schemas/PaidMediaInfo" }, "live_photo": { "description": "Message is a live photo, information about the live photo. For backward compatibility, when this field is set, the *photo* field will also be set.", "$ref": "#/components/schemas/LivePhoto" }, "photo": { "description": "Message is a photo, available sizes of the photo", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "sticker": { "description": "Message is a sticker, information about the sticker", "$ref": "#/components/schemas/Sticker" }, "video": { "description": "Message is a video, information about the video", "$ref": "#/components/schemas/Video" }, "video_note": { "description": "Message is a [video note](https://telegram.org/blog/video-messages-and-telescope), information about the video message", "$ref": "#/components/schemas/VideoNote" }, "voice": { "description": "Message is a voice message, information about the file", "$ref": "#/components/schemas/Voice" }, "location": { "description": "Message is a shared location, information about the location", "$ref": "#/components/schemas/LocationOutput" }, "venue": { "description": "Message is a venue, information about the venue. For backward compatibility, when this field is set, the *location* field will also be set.", "$ref": "#/components/schemas/Venue" }, "contact": { "description": "Message is a shared contact, information about the contact", "$ref": "#/components/schemas/Contact" }, "dice": { "description": "Message is a dice with random value", "$ref": "#/components/schemas/Dice" }, "game": { "description": "Message is a game, information about the game. [More about games »](https://core.telegram.org/bots/api#games)", "$ref": "#/components/schemas/Game" }, "poll": { "description": "Message is a native poll, information about the poll", "$ref": "#/components/schemas/Poll" }, "story": { "description": "Message is a forwarded story", "$ref": "#/components/schemas/Story" }, "checklist": { "description": "Message is a checklist", "$ref": "#/components/schemas/Checklist" }, "invoice": { "description": "Message is an invoice for a [payment](https://core.telegram.org/bots/api#payments), information about the invoice. [More about payments »](https://core.telegram.org/bots/api#payments)", "$ref": "#/components/schemas/Invoice" }, "video_chat_scheduled": { "description": "Service message: video chat scheduled", "$ref": "#/components/schemas/VideoChatScheduled" }, "video_chat_started": { "description": "Service message: video chat started", "$ref": "#/components/schemas/VideoChatStarted" }, "video_chat_ended": { "description": "Service message: video chat ended", "$ref": "#/components/schemas/VideoChatEnded" }, "video_chat_participants_invited": { "description": "Service message: new participants invited to a video chat", "$ref": "#/components/schemas/VideoChatParticipantsInvited" }, "poll_option_added": { "description": "Service message: answer option was added to a poll", "$ref": "#/components/schemas/PollOptionAdded" }, "poll_option_deleted": { "description": "Service message: answer option was deleted from a poll", "$ref": "#/components/schemas/PollOptionDeleted" }, "group_chat_created": { "description": "Service message: the group has been created", "type": "boolean", "const": true }, "supergroup_chat_created": { "description": "Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.", "type": "boolean", "const": true }, "channel_chat_created": { "description": "Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.", "type": "boolean", "const": true }, "new_chat_title": { "description": "A chat title was changed to this value", "type": "string" }, "new_chat_photo": { "description": "A chat photo was change to this value", "type": "array", "items": { "$ref": "#/components/schemas/PhotoSize" } }, "delete_chat_photo": { "description": "Service message: the chat photo was deleted", "type": "boolean", "const": true }, "chat_owner_left": { "description": "Service message: chat owner has left", "$ref": "#/components/schemas/ChatOwnerLeft" }, "chat_owner_changed": { "description": "Service message: chat owner has changed", "$ref": "#/components/schemas/ChatOwnerChanged" }, "new_chat_members": { "description": "New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)", "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "community_chat_joined": { "description": "Service message: chat was joined by a user from a [Community](https://core.telegram.org/bots/api#community)", "$ref": "#/components/schemas/CommunityChatJoined" }, "left_chat_member": { "description": "A member was removed from the group, information about them (this member may be the bot itself)", "$ref": "#/components/schemas/User" }, "community_chat_added": { "description": "Service message: chat or bot added to a [Community](https://core.telegram.org/bots/api#community)", "$ref": "#/components/schemas/CommunityChatAdded" }, "community_chat_removed": { "description": "Service message: chat or bot removed from a [Community](https://core.telegram.org/bots/api#community)", "$ref": "#/components/schemas/CommunityChatRemoved" }, "migrate_to_chat_id": { "description": "The group has been migrated to a supergroup with the specified identifier. 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.", "type": "integer" }, "migrate_from_chat_id": { "description": "The supergroup has been migrated from a group with the specified identifier. 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.", "type": "integer" }, "pinned_message": { "description": "Specified message was pinned. Note that the [Message](https://core.telegram.org/bots/api#message) object in this field will not contain further *reply_to_message* fields even if it itself is a reply.", "$ref": "#/components/schemas/MaybeInaccessibleMessage" }, "chat_background_set": { "description": "Service message: chat background set", "$ref": "#/components/schemas/ChatBackground" }, "message_auto_delete_timer_changed": { "description": "Service message: auto-delete timer settings changed in the chat", "$ref": "#/components/schemas/MessageAutoDeleteTimerChanged" }, "boost_added": { "description": "Service message: user boosted the chat", "$ref": "#/components/schemas/ChatBoostAdded" }, "forum_topic_created": { "description": "Service message: forum topic created", "$ref": "#/components/schemas/ForumTopicCreated" }, "forum_topic_edited": { "description": "Service message: forum topic edited", "$ref": "#/components/schemas/ForumTopicEdited" }, "forum_topic_closed": { "description": "Service message: forum topic closed", "$ref": "#/components/schemas/ForumTopicClosed" }, "forum_topic_reopened": { "description": "Service message: forum topic reopened", "$ref": "#/components/schemas/ForumTopicReopened" }, "general_forum_topic_hidden": { "description": "Service message: the 'General' forum topic hidden", "$ref": "#/components/schemas/GeneralForumTopicHidden" }, "general_forum_topic_unhidden": { "description": "Service message: the 'General' forum topic unhidden", "$ref": "#/components/schemas/GeneralForumTopicUnhidden" }, "managed_bot_created": { "description": "Service message: user created a bot that will be managed by the current bot", "$ref": "#/components/schemas/ManagedBotCreated" }, "successful_payment": { "description": "Message is a service message about a successful payment, information about the payment. [More about payments »](https://core.telegram.org/bots/api#payments)", "$ref": "#/components/schemas/SuccessfulPayment" }, "refunded_payment": { "description": "Message is a service message about a refunded payment, information about the payment. [More about payments »](https://core.telegram.org/bots/api#payments)", "$ref": "#/components/schemas/RefundedPayment" }, "giveaway_created": { "description": "Service message: a scheduled giveaway was created", "$ref": "#/components/schemas/GiveawayCreated" }, "giveaway": { "description": "Message is a scheduled giveaway, information about the giveaway", "$ref": "#/components/schemas/Giveaway" }, "giveaway_completed": { "description": "Service message: a giveaway without public winners was completed", "$ref": "#/components/schemas/GiveawayCompleted" }, "giveaway_winners": { "description": "A giveaway with public winners was completed", "$ref": "#/components/schemas/GiveawayWinners" }, "gift_upgrade_sent": { "description": "Service message: upgrade of a gift was purchased after the gift was sent", "$ref": "#/components/schemas/GiftInfo" }, "gift": { "description": "Service message: a regular gift was sent or received", "$ref": "#/components/schemas/GiftInfo" }, "unique_gift": { "description": "Service message: a unique gift was sent or received", "$ref": "#/components/schemas/UniqueGiftInfo" }, "paid_message_price_changed": { "description": "Service message: the price for paid messages has changed in the chat", "$ref": "#/components/schemas/PaidMessagePriceChanged" }, "direct_message_price_changed": { "description": "Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed", "$ref": "#/components/schemas/DirectMessagePriceChanged" }, "checklist_tasks_done": { "description": "Service message: some tasks in a checklist were marked as done or not done", "$ref": "#/components/schemas/ChecklistTasksDone" }, "checklist_tasks_added": { "description": "Service message: tasks were added to a checklist", "$ref": "#/components/schemas/ChecklistTasksAdded" }, "suggested_post_approval_failed": { "description": "Service message: approval of a suggested post has failed", "$ref": "#/components/schemas/SuggestedPostApprovalFailed" }, "suggested_post_approved": { "description": "Service message: a suggested post was approved", "$ref": "#/components/schemas/SuggestedPostApproved" }, "suggested_post_declined": { "description": "Service message: a suggested post was declined", "$ref": "#/components/schemas/SuggestedPostDeclined" }, "suggested_post_paid": { "description": "Service message: payment for a suggested post was received", "$ref": "#/components/schemas/SuggestedPostPaid" }, "suggested_post_refunded": { "description": "Service message: payment for a suggested post was refunded", "$ref": "#/components/schemas/SuggestedPostRefunded" }, "users_shared": { "description": "Service message: users were shared with the bot", "$ref": "#/components/schemas/UsersShared" }, "chat_shared": { "description": "Service message: a chat was shared with the bot", "$ref": "#/components/schemas/ChatShared" }, "connected_website": { "description": "The domain name of the website on which the user has logged in. [More about Telegram Login »](https://core.telegram.org/widgets/login)", "type": "string" }, "write_access_allowed": { "description": "Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method [requestWriteAccess](https://core.telegram.org/bots/webapps#initializing-mini-apps)", "$ref": "#/components/schemas/WriteAccessAllowed" }, "web_app_data": { "description": "Service message: data sent by a Web App", "$ref": "#/components/schemas/WebAppData" }, "passport_data": { "description": "Telegram Passport data", "$ref": "#/components/schemas/PassportData" }, "proximity_alert_triggered": { "description": "Service message: a user in the chat triggered another user's proximity alert while sharing Live Location", "$ref": "#/components/schemas/ProximityAlertTriggered" }, "reply_markup": { "description": "[Inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) attached to the message. `login_url` buttons are represented as ordinary `url` buttons.", "$ref": "#/components/schemas/InlineKeyboardMarkupOutput" }, "via_bot": { "description": "Bot through which the message was sent", "$ref": "#/components/schemas/User" }, "guest_bot_caller_user": { "description": "For a message sent by a guest bot, this is the user whose original message triggered the bot's response", "$ref": "#/components/schemas/User" }, "guest_bot_caller_chat": { "description": "For a message sent by a guest bot, this is the chat whose original message triggered the bot's response", "$ref": "#/components/schemas/Chat" }, "has_protected_content": { "description": "*True*, if the message can't be forwarded", "type": "boolean", "const": true }, "is_topic_message": { "description": "*True*, if the message is sent to a topic in a forum supergroup or a private chat with the bot", "type": "boolean", "const": true }, "direct_messages_topic": { "description": "Information about the direct messages chat topic that contains the message", "$ref": "#/components/schemas/DirectMessagesTopic" }, "is_from_offline": { "description": "*True*, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message", "type": "boolean", "const": true }, "effect_id": { "description": "Unique identifier of the message effect added to the message", "type": "string" }, "sender_boost_count": { "description": "If the sender of the message boosted the chat, the number of boosts added by the user", "type": "integer" }, "sender_tag": { "description": "Tag or custom title of the sender of the message; for supergroups only", "type": "string" }, "paid_star_count": { "description": "The number of Telegram Stars that were paid by the sender of the message to send it", "type": "integer" }, "is_paid_post": { "description": "*True*, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.", "type": "boolean", "const": true }, "suggested_post_info": { "description": "Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.", "$ref": "#/components/schemas/SuggestedPostInfo" } } }, "InaccessibleMessage": { "type": "object", "description": "This object describes a message that was deleted or is otherwise inaccessible to the bot.", "required": [ "message_id", "chat", "date" ], "properties": { "message_id": { "description": "Unique message identifier inside the chat", "type": "integer" }, "chat": { "description": "Chat the message belonged to", "$ref": "#/components/schemas/Chat" }, "date": { "description": "Always 0. The field can be used to differentiate regular and inaccessible messages.", "type": "integer" } } }, "EncryptedPassportElement": { "type": "object", "description": "Describes documents or other Telegram Passport elements shared with the bot by the user.", "required": [ "type", "hash" ], "properties": { "type": { "description": "Element type. Currently, can be \"personal_details\", \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\", \"address\", \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\", \"temporary_registration\", \"phone_number\", or \"email\".", "type": "string", "enum": [ "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email" ] }, "phone_number": { "description": "User's verified phone number; available only for \"phone_number\" type", "type": "string" }, "email": { "description": "User's verified email address; available only for \"email\" type", "type": "string" }, "data": { "description": "Base64-encoded encrypted Telegram Passport element data provided by the user; available only for \"personal_details\", \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\" and \"address\" types. Can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "type": "string" }, "files": { "description": "Array of encrypted files with documents provided by the user; available only for \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\" and \"temporary_registration\" types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "type": "array", "items": { "$ref": "#/components/schemas/PassportFile" } }, "translation": { "description": "Array of encrypted files with translated versions of documents provided by the user; available if requested for \"passport\", \"driver_license\", \"identity_card\", \"internal_passport\", \"utility_bill\", \"bank_statement\", \"rental_agreement\", \"passport_registration\" and \"temporary_registration\" types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "type": "array", "items": { "$ref": "#/components/schemas/PassportFile" } }, "front_side": { "description": "Encrypted file with the front side of the document, provided by the user; available only for \"passport\", \"driver_license\", \"identity_card\" and \"internal_passport\". The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "$ref": "#/components/schemas/PassportFile" }, "reverse_side": { "description": "Encrypted file with the reverse side of the document, provided by the user; available only for \"driver_license\" and \"identity_card\". The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "$ref": "#/components/schemas/PassportFile" }, "selfie": { "description": "Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for \"passport\", \"driver_license\", \"identity_card\" and \"internal_passport\". The file can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api#encryptedcredentials).", "$ref": "#/components/schemas/PassportFile" }, "hash": { "description": "Base64-encoded element hash for using in [PassportElementErrorUnspecified](https://core.telegram.org/bots/api#passportelementerrorunspecified)", "type": "string" } } }, "EncryptedCredentials": { "type": "object", "description": "Describes data required for decrypting and authenticating [EncryptedPassportElement](https://core.telegram.org/bots/api#encryptedpassportelement). See the [Telegram Passport Documentation](https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes.", "required": [ "data", "hash", "secret" ], "properties": { "data": { "description": "Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for [EncryptedPassportElement](https://core.telegram.org/bots/api#encryptedpassportelement) decryption and authentication", "type": "string" }, "hash": { "description": "Base64-encoded data hash for data authentication", "type": "string" }, "secret": { "description": "Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption", "type": "string" } } }, "PassportData": { "type": "object", "description": "Describes Telegram Passport data shared with the bot by the user.", "required": [ "data", "credentials" ], "properties": { "data": { "description": "Array with information about documents and other Telegram Passport elements that was shared with the bot", "type": "array", "items": { "$ref": "#/components/schemas/EncryptedPassportElement" } }, "credentials": { "description": "Encrypted credentials required to decrypt the data", "$ref": "#/components/schemas/EncryptedCredentials" } } }, "UniqueGiftColors": { "type": "object", "description": "This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.", "required": [ "model_custom_emoji_id", "symbol_custom_emoji_id", "light_theme_main_color", "light_theme_other_colors", "dark_theme_main_color", "dark_theme_other_colors" ], "properties": { "model_custom_emoji_id": { "description": "Custom emoji identifier of the unique gift's model", "type": "string" }, "symbol_custom_emoji_id": { "description": "Custom emoji identifier of the unique gift's symbol", "type": "string" }, "light_theme_main_color": { "description": "Main color used in light themes; RGB format", "type": "integer" }, "light_theme_other_colors": { "description": "List of additional colors used in light themes, 1-3 elements; RGB format", "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 3 }, "dark_theme_main_color": { "description": "Main color used in dark themes; RGB format", "type": "integer" }, "dark_theme_other_colors": { "description": "List of additional colors used in dark themes, 1-3 elements; RGB format", "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 3 } } }, "GiftBackground": { "type": "object", "description": "This object describes the background of a gift.", "required": [ "center_color", "edge_color", "text_color" ], "properties": { "center_color": { "description": "Center color of the background in RGB format", "type": "integer" }, "edge_color": { "description": "Edge color of the background in RGB format", "type": "integer" }, "text_color": { "description": "Text color of the background in RGB format", "type": "integer" } } }, "Gift": { "type": "object", "description": "This object represents a gift that can be sent by the bot.", "required": [ "id", "sticker", "star_count" ], "properties": { "id": { "description": "Unique identifier of the gift", "type": "string" }, "sticker": { "description": "The sticker that represents the gift", "$ref": "#/components/schemas/Sticker" }, "star_count": { "description": "The number of Telegram Stars that must be paid to send the sticker", "type": "integer" }, "upgrade_star_count": { "description": "The number of Telegram Stars that must be paid to upgrade the gift to a unique one", "type": "integer" }, "remaining_count": { "description": "The number of remaining gifts of this type that can be sent by all users; for limited gifts only", "type": "integer" }, "total_count": { "description": "The total number of gifts of this type that can be sent by all users; for limited gifts only", "type": "integer" }, "personal_remaining_count": { "description": "The number of remaining gifts of this type that can be sent by the bot; for limited gifts only", "type": "integer" }, "personal_total_count": { "description": "The total number of gifts of this type that can be sent by the bot; for limited gifts only", "type": "integer" }, "publisher_chat": { "description": "Information about the chat that published the gift", "$ref": "#/components/schemas/Chat" }, "is_premium": { "description": "*True*, if the gift can only be purchased by Telegram Premium subscribers", "type": "boolean", "const": true }, "has_colors": { "description": "*True*, if the gift can be used (after being upgraded) to customize a user's appearance", "type": "boolean", "const": true }, "unique_gift_variant_count": { "description": "The total number of different unique gifts that can be obtained by upgrading the gift", "type": "integer" }, "background": { "description": "Background of the gift", "$ref": "#/components/schemas/GiftBackground" } } }, "UniqueGiftModel": { "type": "object", "description": "This object describes the model of a unique gift.", "required": [ "name", "sticker", "rarity_per_mille" ], "properties": { "name": { "description": "Name of the model", "type": "string" }, "sticker": { "description": "The sticker that represents the unique gift", "$ref": "#/components/schemas/Sticker" }, "rarity": { "description": "Rarity of the model if it is a crafted model. Currently, can be \"uncommon\", \"rare\", \"epic\", or \"legendary\".", "type": "string", "enum": [ "uncommon", "rare", "epic", "legendary" ] }, "rarity_per_mille": { "description": "The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts.", "type": "integer" } } }, "UniqueGiftSymbol": { "type": "object", "description": "This object describes the symbol shown on the pattern of a unique gift.", "required": [ "name", "sticker", "rarity_per_mille" ], "properties": { "name": { "description": "Name of the symbol", "type": "string" }, "sticker": { "description": "The sticker that represents the unique gift", "$ref": "#/components/schemas/Sticker" }, "rarity_per_mille": { "description": "The number of unique gifts that receive this model for every 1000 gifts upgraded", "type": "integer" } } }, "UniqueGiftBackdropColors": { "type": "object", "description": "This object describes the colors of the backdrop of a unique gift.", "required": [ "center_color", "edge_color", "symbol_color", "text_color" ], "properties": { "center_color": { "description": "The color in the center of the backdrop in RGB format", "type": "integer" }, "edge_color": { "description": "The color on the edges of the backdrop in RGB format", "type": "integer" }, "symbol_color": { "description": "The color to be applied to the symbol in RGB format", "type": "integer" }, "text_color": { "description": "The color for the text on the backdrop in RGB format", "type": "integer" } } }, "UniqueGiftBackdrop": { "type": "object", "description": "This object describes the backdrop of a unique gift.", "required": [ "name", "colors", "rarity_per_mille" ], "properties": { "name": { "description": "Name of the backdrop", "type": "string" }, "colors": { "description": "Colors of the backdrop", "$ref": "#/components/schemas/UniqueGiftBackdropColors" }, "rarity_per_mille": { "description": "The number of unique gifts that receive this backdrop for every 1000 gifts upgraded", "type": "integer" } } }, "UniqueGift": { "type": "object", "description": "This object describes a unique gift that was upgraded from a regular gift.", "required": [ "gift_id", "base_name", "name", "number", "model", "symbol", "backdrop" ], "properties": { "gift_id": { "description": "Identifier of the regular gift from which the gift was upgraded", "type": "string" }, "base_name": { "description": "Human-readable name of the regular gift from which this unique gift was upgraded", "type": "string" }, "name": { "description": "Unique name of the gift. This name can be used in `https://t.me/nft/...` links and story areas.", "type": "string" }, "number": { "description": "Unique number of the upgraded gift among gifts upgraded from the same regular gift", "type": "integer" }, "model": { "description": "Model of the gift", "$ref": "#/components/schemas/UniqueGiftModel" }, "symbol": { "description": "Symbol of the gift", "$ref": "#/components/schemas/UniqueGiftSymbol" }, "backdrop": { "description": "Backdrop of the gift", "$ref": "#/components/schemas/UniqueGiftBackdrop" }, "publisher_chat": { "description": "Information about the chat that published the gift", "$ref": "#/components/schemas/Chat" }, "is_premium": { "description": "*True*, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers", "type": "boolean", "const": true }, "colors": { "description": "The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only", "$ref": "#/components/schemas/UniqueGiftColors" }, "is_from_blockchain": { "description": "*True*, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram", "type": "boolean", "const": true }, "is_burned": { "description": "*True*, if the gift was used to craft another gift and isn't available anymore", "type": "boolean", "const": true } } }, "StarAmount": { "type": "object", "description": "Describes an amount of Telegram Stars.", "required": [ "amount" ], "properties": { "amount": { "description": "Integer amount of Telegram Stars, rounded to 0; can be negative", "type": "integer" }, "nanostar_amount": { "description": "The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if *amount* is non-positive", "type": "integer" } } }, "SuggestedPostInfo": { "type": "object", "description": "Contains information about a suggested post.", "required": [ "state" ], "properties": { "price": { "description": "Proposed price of the post. If the field is omitted, then the post is unpaid.", "$ref": "#/components/schemas/SuggestedPostPrice" }, "send_date": { "description": "Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.", "type": "integer" }, "state": { "description": "State of the suggested post. Currently, can be \"pending\", \"approved\", or \"declined\".", "type": "string", "enum": [ "pending", "approved", "declined" ] } } }, "Invoice": { "type": "object", "description": "This object contains basic information about an invoice.", "required": [ "title", "description", "start_parameter", "currency", "total_amount" ], "properties": { "title": { "description": "Product name", "type": "string" }, "description": { "description": "Product description", "type": "string" }, "start_parameter": { "description": "Unique bot deep-linking parameter that can be used to generate this invoice", "type": "string" }, "currency": { "description": "Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or \"XTR\" for payments in [Telegram Stars](https://t.me/BotNews/90)", "type": "string" }, "total_amount": { "description": "Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", "type": "integer" } } }, "ShippingAddress": { "type": "object", "description": "This object represents a shipping address.", "required": [ "country_code", "state", "city", "street_line1", "street_line2", "post_code" ], "properties": { "country_code": { "description": "Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code", "type": "string" }, "state": { "description": "State, if applicable", "type": "string" }, "city": { "description": "City", "type": "string" }, "street_line1": { "description": "First line for the address", "type": "string" }, "street_line2": { "description": "Second line for the address", "type": "string" }, "post_code": { "description": "Address post code", "type": "string" } } }, "OrderInfo": { "type": "object", "description": "This object represents information about an order.", "properties": { "name": { "description": "User name", "type": "string" }, "phone_number": { "description": "User's phone number", "type": "string" }, "email": { "description": "User email", "type": "string" }, "shipping_address": { "description": "User shipping address", "$ref": "#/components/schemas/ShippingAddress" } } }, "SuccessfulPayment": { "type": "object", "description": "This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.", "required": [ "currency", "total_amount", "invoice_payload", "telegram_payment_charge_id", "provider_payment_charge_id" ], "properties": { "currency": { "description": "Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or \"XTR\" for payments in [Telegram Stars](https://t.me/BotNews/90)", "type": "string" }, "total_amount": { "description": "Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", "type": "integer" }, "invoice_payload": { "description": "Bot-specified invoice payload", "type": "string" }, "shipping_option_id": { "description": "Identifier of the shipping option chosen by the user", "type": "string" }, "order_info": { "description": "Order information provided by the user", "$ref": "#/components/schemas/OrderInfo" }, "telegram_payment_charge_id": { "description": "Telegram payment identifier", "type": "string" }, "provider_payment_charge_id": { "description": "Provider payment identifier", "type": "string" }, "is_recurring": { "description": "*True*, if the payment is a recurring payment for a subscription", "type": "boolean", "const": true }, "is_first_recurring": { "description": "*True*, if the payment is the first payment for a subscription", "type": "boolean", "const": true }, "subscription_expiration_date": { "description": "Expiration date of the subscription, in Unix time; for recurring payments only", "type": "integer" } } }, "RefundedPayment": { "type": "object", "description": "This object contains basic information about a refunded payment.", "required": [ "currency", "total_amount", "invoice_payload", "telegram_payment_charge_id" ], "properties": { "currency": { "description": "Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or \"XTR\" for payments in [Telegram Stars](https://t.me/BotNews/90). Currently, always \"XTR\".", "type": "string" }, "total_amount": { "description": "Total refunded price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45`, `total_amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", "type": "integer" }, "invoice_payload": { "description": "Bot-specified invoice payload", "type": "string" }, "telegram_payment_charge_id": { "description": "Telegram payment identifier", "type": "string" }, "provider_payment_charge_id": { "description": "Provider payment identifier", "type": "string" } } }, "GiftInfo": { "type": "object", "description": "Describes a service message about a regular gift that was sent or received.", "required": [ "gift" ], "properties": { "gift": { "description": "Information about the gift", "$ref": "#/components/schemas/Gift" }, "owned_gift_id": { "description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts", "type": "string" }, "convert_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible", "type": "integer" }, "prepaid_upgrade_star_count": { "description": "Number of Telegram Stars that were prepaid for the ability to upgrade the gift", "type": "integer" }, "can_be_upgraded": { "description": "*True*, if the gift can be upgraded to a unique gift", "type": "boolean", "const": true }, "text": { "description": "Text of the message that was added to the gift", "type": "string" }, "entities": { "description": "Special entities that appear in the text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "is_private": { "description": "*True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "type": "boolean", "const": true }, "is_upgrade_separate": { "description": "*True*, if the gift's upgrade was purchased after the gift was sent", "type": "boolean", "const": true }, "unique_gift_number": { "description": "Unique number reserved for this gift when upgraded. See the *number* field in [UniqueGift](https://core.telegram.org/bots/api#uniquegift).", "type": "integer" } } }, "UniqueGiftInfo": { "type": "object", "description": "Describes a service message about a unique gift that was sent or received.", "required": [ "gift", "origin" ], "properties": { "gift": { "description": "Information about the gift", "$ref": "#/components/schemas/UniqueGift" }, "owned_gift_id": { "description": "Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts", "type": "string" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift", "type": "integer" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.", "type": "integer" }, "origin": { "description": "Origin of the gift. Currently, either \"upgrade\" for gifts upgraded from regular gifts, \"transfer\" for gifts transferred from other users or channels, \"resale\" for gifts bought from other users, \"blockchain\" for gifts assigned from the blockchain, \"gifted_upgrade\" for upgrades purchased after the gift was sent, \"offer\" for gifts bought or sold through gift purchase offers, or \"craft\" for gifts crafted from other gifts.", "type": "string", "enum": [ "upgrade", "transfer", "resale", "blockchain", "gifted_upgrade", "offer", "craft" ] }, "last_resale_currency": { "description": "For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of \"XTR\" for Telegram Stars or \"TON\" for TON grams.", "type": "string", "enum": [ "XTR", "TON" ] }, "last_resale_amount": { "description": "For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanograms", "type": "integer" }, "text": { "description": "Text of the message that was added to the gift", "type": "string" }, "entities": { "description": "Special entities that appear in the text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "is_private": { "description": "*True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "type": "boolean", "const": true } } }, "ShippingQuery": { "type": "object", "description": "This object contains information about an incoming shipping query.", "required": [ "id", "from", "invoice_payload", "shipping_address" ], "properties": { "id": { "description": "Unique query identifier", "type": "string" }, "from": { "description": "User who sent the query", "$ref": "#/components/schemas/User" }, "invoice_payload": { "description": "Bot-specified invoice payload", "type": "string" }, "shipping_address": { "description": "User specified shipping address", "$ref": "#/components/schemas/ShippingAddress" } } }, "PreCheckoutQuery": { "type": "object", "description": "This object contains information about an incoming pre-checkout query.", "required": [ "id", "from", "currency", "total_amount", "invoice_payload" ], "properties": { "id": { "description": "Unique query identifier", "type": "string" }, "from": { "description": "User who sent the query", "$ref": "#/components/schemas/User" }, "currency": { "description": "Three-letter ISO 4217 [currency](https://core.telegram.org/bots/payments#supported-currencies) code, or \"XTR\" for payments in [Telegram Stars](https://t.me/BotNews/90)", "type": "string" }, "total_amount": { "description": "Total price in the *smallest units* of the currency (integer, **not** float/double). For example, for a price of `US$ 1.45` pass `amount = 145`. See the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).", "type": "integer" }, "invoice_payload": { "description": "Bot-specified invoice payload", "type": "string" }, "shipping_option_id": { "description": "Identifier of the shipping option chosen by the user", "type": "string" }, "order_info": { "description": "Order information provided by the user", "$ref": "#/components/schemas/OrderInfo" } } }, "PaidMediaPurchased": { "type": "object", "description": "This object contains information about a paid media purchase.", "required": [ "from", "paid_media_payload" ], "properties": { "from": { "description": "User who purchased the media", "$ref": "#/components/schemas/User" }, "paid_media_payload": { "description": "Bot-specified paid media payload", "type": "string" } } }, "RevenueWithdrawalStatePending": { "type": "object", "description": "The withdrawal is in progress.", "required": [ "type" ], "properties": { "type": { "description": "Type of the state, always \"pending\"", "type": "string", "const": "pending" } } }, "RevenueWithdrawalStateSucceeded": { "type": "object", "description": "The withdrawal succeeded.", "required": [ "type", "date", "url" ], "properties": { "type": { "description": "Type of the state, always \"succeeded\"", "type": "string", "const": "succeeded" }, "date": { "description": "Date the withdrawal was completed in Unix time", "type": "integer" }, "url": { "description": "An HTTPS URL that can be used to see transaction details", "type": "string" } } }, "RevenueWithdrawalStateFailed": { "type": "object", "description": "The withdrawal failed and the transaction was refunded.", "required": [ "type" ], "properties": { "type": { "description": "Type of the state, always \"failed\"", "type": "string", "const": "failed" } } }, "AffiliateInfo": { "type": "object", "description": "Contains information about the affiliate that received a commission via this transaction.", "required": [ "commission_per_mille", "amount" ], "properties": { "affiliate_user": { "description": "The bot or the user that received an affiliate commission if it was received by a bot or a user", "$ref": "#/components/schemas/User" }, "affiliate_chat": { "description": "The chat that received an affiliate commission if it was received by a chat", "$ref": "#/components/schemas/Chat" }, "commission_per_mille": { "description": "The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users", "type": "integer" }, "amount": { "description": "Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds", "type": "integer" }, "nanostar_amount": { "description": "The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds", "type": "integer" } } }, "StarTransaction": { "type": "object", "description": "Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.", "required": [ "id", "date", "amount" ], "properties": { "id": { "description": "Unique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with *SuccessfulPayment.telegram_payment_charge_id* for successful incoming payments from users.", "type": "string" }, "date": { "description": "Date the transaction was created in Unix time", "type": "integer" }, "source": { "description": "Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.", "$ref": "#/components/schemas/TransactionPartner" }, "receiver": { "description": "Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.", "$ref": "#/components/schemas/TransactionPartner" }, "amount": { "description": "Integer amount of Telegram Stars transferred by the transaction", "type": "integer" }, "nanostar_amount": { "description": "The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999", "type": "integer" } } }, "StarTransactions": { "type": "object", "description": "Contains a list of Telegram Star transactions.", "required": [ "transactions" ], "properties": { "transactions": { "description": "The list of transactions", "type": "array", "items": { "$ref": "#/components/schemas/StarTransaction" } } } }, "OwnedGift": { "description": "This object describes a gift received and owned by a user or a chat.", "oneOf": [ { "$ref": "#/components/schemas/OwnedGiftRegular" }, { "$ref": "#/components/schemas/OwnedGiftUnique" } ], "discriminator": { "propertyName": "type", "mapping": { "regular": "#/components/schemas/OwnedGiftRegular", "unique": "#/components/schemas/OwnedGiftUnique" } } }, "OwnedGiftRegular": { "type": "object", "description": "Describes a regular gift owned by a user or a chat.", "required": [ "type", "gift", "send_date" ], "properties": { "type": { "description": "Type of the gift, always \"regular\"", "type": "string", "const": "regular" }, "gift": { "description": "Information about the regular gift", "$ref": "#/components/schemas/Gift" }, "owned_gift_id": { "description": "Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only", "type": "string" }, "sender_user": { "description": "Sender of the gift if it is a known user", "$ref": "#/components/schemas/User" }, "sender_chat": { "description": "Sender of the gift if it is a known chat", "$ref": "#/components/schemas/Chat" }, "send_date": { "description": "Date the gift was sent in Unix time", "type": "integer" }, "text": { "description": "Text of the message that was added to the gift", "type": "string" }, "entities": { "description": "Special entities that appear in the text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "is_private": { "description": "*True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "type": "boolean", "const": true }, "is_saved": { "description": "*True*, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "can_be_upgraded": { "description": "*True*, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "can_be_transferred": { "description": "*True*, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "was_refunded": { "description": "*True*, if the gift was refunded and isn't available anymore", "type": "boolean", "const": true }, "convert_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only", "type": "integer" }, "prepaid_upgrade_star_count": { "description": "Number of Telegram Stars that were paid for the ability to upgrade the gift", "type": "integer" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift", "type": "integer" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.", "type": "integer" }, "is_upgrade_separate": { "description": "*True*, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "unique_gift_number": { "description": "Unique number reserved for this gift when upgraded. See the *number* field in [UniqueGift](https://core.telegram.org/bots/api#uniquegift).", "type": "integer" } } }, "OwnedGiftUnique": { "type": "object", "description": "Describes a unique gift received and owned by a user or a chat.", "required": [ "type", "gift", "send_date" ], "properties": { "type": { "description": "Type of the gift, always \"unique\"", "type": "string", "const": "unique" }, "gift": { "description": "Information about the unique gift", "$ref": "#/components/schemas/UniqueGift" }, "owned_gift_id": { "description": "Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only", "type": "string" }, "sender_user": { "description": "Sender of the gift if it is a known user", "$ref": "#/components/schemas/User" }, "sender_chat": { "description": "Sender of the gift if it is a known chat", "$ref": "#/components/schemas/Chat" }, "send_date": { "description": "Date the gift was sent in Unix time", "type": "integer" }, "text": { "description": "Text of the message that was added to the gift", "type": "string" }, "entities": { "description": "Special entities that appear in the text", "type": "array", "items": { "$ref": "#/components/schemas/MessageEntityOutput" } }, "is_private": { "description": "*True*, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them", "type": "boolean", "const": true }, "is_saved": { "description": "*True*, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "can_be_upgraded": { "description": "*True*, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "can_be_transferred": { "description": "*True*, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "was_refunded": { "description": "*True*, if the gift was refunded and isn't available anymore", "type": "boolean", "const": true }, "convert_star_count": { "description": "Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only", "type": "integer" }, "prepaid_upgrade_star_count": { "description": "Number of Telegram Stars that were paid for the ability to upgrade the gift", "type": "integer" }, "transfer_star_count": { "description": "Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift", "type": "integer" }, "next_transfer_date": { "description": "Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.", "type": "integer" }, "is_upgrade_separate": { "description": "*True*, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only", "type": "boolean", "const": true }, "unique_gift_number": { "description": "Unique number reserved for this gift when upgraded. See the *number* field in [UniqueGift](https://core.telegram.org/bots/api#uniquegift).", "type": "integer" } } }, "OwnedGifts": { "type": "object", "description": "Contains the list of gifts received and owned by a user or a chat.", "required": [ "total_count", "gifts" ], "properties": { "total_count": { "description": "The total number of gifts owned by the user or the chat", "type": "integer" }, "gifts": { "description": "The list of gifts", "type": "array", "items": { "$ref": "#/components/schemas/OwnedGift" } }, "next_offset": { "description": "Offset for the next request. If empty, then there are no more results.", "type": "string" } } }, "Gifts": { "type": "object", "description": "This object represent a list of gifts.", "required": [ "gifts" ], "properties": { "gifts": { "description": "The list of gifts", "type": "array", "items": { "$ref": "#/components/schemas/Gift" } } } }, "AcceptedGiftTypesInput": { "type": "object", "description": "This object describes the types of gifts that can be gifted to a user or a chat.", "required": [ "unlimited_gifts", "limited_gifts", "unique_gifts", "premium_subscription" ], "properties": { "unlimited_gifts": { "description": "*True*, if unlimited regular gifts are accepted", "type": "boolean" }, "limited_gifts": { "description": "*True*, if limited regular gifts are accepted", "type": "boolean" }, "unique_gifts": { "description": "*True*, if unique gifts or gifts that can be upgraded to unique for free are accepted", "type": "boolean" }, "premium_subscription": { "description": "*True*, if a Telegram Premium subscription is accepted", "type": "boolean" }, "gifts_from_channels": { "description": "*True*, if transfers of unique gifts from channels are accepted, defaults to *True*", "type": "boolean", "default": true } } }, "AcceptedGiftTypesOutput": { "type": "object", "description": "This object describes the types of gifts that can be gifted to a user or a chat.", "required": [ "unlimited_gifts", "limited_gifts", "unique_gifts", "premium_subscription", "gifts_from_channels" ], "properties": { "unlimited_gifts": { "description": "*True*, if unlimited regular gifts are accepted", "type": "boolean" }, "limited_gifts": { "description": "*True*, if limited regular gifts are accepted", "type": "boolean" }, "unique_gifts": { "description": "*True*, if unique gifts or gifts that can be upgraded to unique for free are accepted", "type": "boolean" }, "premium_subscription": { "description": "*True*, if a Telegram Premium subscription is accepted", "type": "boolean" }, "gifts_from_channels": { "description": "*True*, if transfers of unique gifts from channels are accepted, defaults to *True*", "type": "boolean", "default": true } } }, "MessageEntityInput": { "type": "object", "description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.", "required": [ "offset", "length", "type" ], "properties": { "offset": { "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity", "type": "integer" }, "length": { "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)", "type": "integer" }, "type": { "description": "Type of the entity. Currently, can be \"mention\" (`@username`), \"hashtag\" (`#hashtag` or `#hashtag@chatusername`), \"cashtag\" (`$USD` or `$USD@chatusername`), \"bot_command\" (`/start@jobs_bot`), \"url\" (`https://telegram.org`), \"email\" (`do-not-reply@telegram.org`), \"phone_number\" (`+1-212-555-0123`), \"bold\" (**bold text**), \"italic\" (*italic text*), \"underline\" (underlined text), \"strikethrough\" (strikethrough text), \"spoiler\" (spoiler message), \"blockquote\" (block quotation), \"expandable_blockquote\" (collapsed-by-default block quotation), \"code\" (monowidth string), \"pre\" (monowidth block), \"text_link\" (for clickable text URLs), \"text_mention\" (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), \"custom_emoji\" (for inline custom emoji stickers), or \"date_time\" (for formatted date and time).", "type": "string", "enum": [ "mention", "hashtag", "cashtag", "bot_command", "url", "email", "phone_number", "bold", "italic", "underline", "strikethrough", "spoiler", "code", "pre", "blockquote", "expandable_blockquote", "text_link", "text_mention", "custom_emoji", "date_time" ] }, "language": { "description": "For \"pre\" only, the programming language of the entity text", "type": "string" }, "url": { "description": "For \"text_link\" only, URL that will be opened after user taps on the text", "type": "string" }, "user": { "description": "For \"text_mention\" only, the mentioned user", "$ref": "#/components/schemas/User" }, "custom_emoji_id": { "description": "For \"custom_emoji\" only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker.", "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "unix_time": { "description": "For \"date_time\" only, the Unix time associated with the entity", "type": "integer" }, "date_time_format": { "description": "For \"date_time\" only, the string that defines the formatting of the date and time. See [date-time entity formatting](https://core.telegram.org/bots/api#date-time-entity-formatting) for more details.", "type": "string" } } }, "MessageEntityOutput": { "type": "object", "description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.", "required": [ "offset", "length", "type" ], "properties": { "offset": { "description": "Offset in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length) to the start of the entity", "type": "integer" }, "length": { "description": "Length of the entity in [UTF-16 code units](https://core.telegram.org/api/entities#entity-length)", "type": "integer" }, "type": { "description": "Type of the entity. Currently, can be \"mention\" (`@username`), \"hashtag\" (`#hashtag` or `#hashtag@chatusername`), \"cashtag\" (`$USD` or `$USD@chatusername`), \"bot_command\" (`/start@jobs_bot`), \"url\" (`https://telegram.org`), \"email\" (`do-not-reply@telegram.org`), \"phone_number\" (`+1-212-555-0123`), \"bold\" (**bold text**), \"italic\" (*italic text*), \"underline\" (underlined text), \"strikethrough\" (strikethrough text), \"spoiler\" (spoiler message), \"blockquote\" (block quotation), \"expandable_blockquote\" (collapsed-by-default block quotation), \"code\" (monowidth string), \"pre\" (monowidth block), \"text_link\" (for clickable text URLs), \"text_mention\" (for users [without usernames](https://telegram.org/blog/edit#new-mentions)), \"custom_emoji\" (for inline custom emoji stickers), or \"date_time\" (for formatted date and time).", "type": "string", "enum": [ "mention", "hashtag", "cashtag", "bot_command", "url", "email", "phone_number", "bold", "italic", "underline", "strikethrough", "spoiler", "code", "pre", "blockquote", "expandable_blockquote", "text_link", "text_mention", "custom_emoji", "date_time" ] }, "language": { "description": "For \"pre\" only, the programming language of the entity text", "type": "string" }, "url": { "description": "For \"text_link\" only, URL that will be opened after user taps on the text", "type": "string" }, "user": { "description": "For \"text_mention\" only, the mentioned user", "$ref": "#/components/schemas/User" }, "custom_emoji_id": { "description": "For \"custom_emoji\" only, unique identifier of the custom emoji. Use [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers) to get full information about the sticker.", "type": "string" }, "unix_time": { "description": "For \"date_time\" only, the Unix time associated with the entity", "type": "integer" }, "date_time_format": { "description": "For \"date_time\" only, the string that defines the formatting of the date and time. See [date-time entity formatting](https://core.telegram.org/bots/api#date-time-entity-formatting) for more details.", "type": "string" } } }, "RichBlockSectionHeading": { "type": "object", "description": "A section heading, corresponding to the HTML tags `

`, `

`, `

`, `

`, `

`, or `
`.", "required": [ "type", "text", "size" ], "properties": { "type": { "description": "Type of the block, always \"heading\"", "type": "string", "const": "heading" }, "text": { "description": "Text of the block", "$ref": "#/components/schemas/RichTextOutput" }, "size": { "description": "Relative size of the text font; 1-6, 1 is the largest, 6 is the smallest", "type": "integer" } } }, "RichBlockParagraph": { "type": "object", "description": "A text paragraph, corresponding to the HTML tag `

`.", "required": [ "type", "text" ], "properties": { "type": { "description": "Type of the block, always \"paragraph\"", "type": "string", "const": "paragraph" }, "text": { "description": "Text of the block", "$ref": "#/components/schemas/RichTextOutput" } } }, "RichBlockPreformatted": { "type": "object", "description": "A preformatted text block, corresponding to the nested HTML tags `

` and ``.",
                "required": [
                    "type",
                    "text"
                ],
                "properties": {
                    "type": {
                        "description": "Type of the block, always \"pre\"",
                        "type": "string",
                        "const": "pre"
                    },
                    "text": {
                        "description": "Text of the block",
                        "$ref": "#/components/schemas/RichTextOutput"
                    },
                    "language": {
                        "description": "The programming language of the text",
                        "type": "string"
                    }
                }
            },
            "RichBlockFooter": {
                "type": "object",
                "description": "A footer, corresponding to the HTML tag `