openapi: 3.0.0 info: title: 'Telegram Bot API' description: 'Auto-generated OpenAPI schema by TGScraper.' version: 2.3.1 servers: - url: 'https://api.telegram.org/bot{token}' variables: token: default: '1234:AAbbcc' description: "Bot's unique authentication token, given by @BotFather." externalDocs: description: 'Official Telegram Bot API documentation.' url: 'https://core.telegram.org/bots/api' components: responses: BadRequest: description: 'Bad request, you have provided malformed data.' content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: 'The authorization token is invalid or it has been revoked.' content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: 'This action is forbidden.' content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: 'The specified resource was not found.' content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: 'There is a conflict with another instance using webhook or polling.' content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: "You're doing too many requests, retry after a while." content: application/json: schema: $ref: '#/components/schemas/Error' ServerError: description: 'The bot API is experiencing some issues, try again later.' content: application/json: schema: $ref: '#/components/schemas/Error' UnknownError: description: 'An unknown error occurred.' content: application/json: schema: $ref: '#/components/schemas/Error' schemas: Response: type: object description: 'Represents the default response object.' required: - ok properties: ok: type: boolean Success: description: 'Request was successful, the result is returned.' allOf: - $ref: '#/components/schemas/Response' - type: object required: - result properties: result: type: object Error: description: 'Request was unsuccessful, so an error occurred.' allOf: - $ref: '#/components/schemas/Response' - type: object required: - error_code - description properties: error_code: type: integer description: type: string parameters: $ref: '#/components/schemas/ResponseParameters' Update: description: 'This object represents an incoming update.At most one of the optional parameters can be present in any given update.' required: - Field - update_id properties: Field: $ref: '#/components/schemas/Type' update_id: type: integer message: $ref: '#/components/schemas/Message' edited_message: $ref: '#/components/schemas/Message' channel_post: $ref: '#/components/schemas/Message' edited_channel_post: $ref: '#/components/schemas/Message' inline_query: $ref: '#/components/schemas/InlineQuery' chosen_inline_result: $ref: '#/components/schemas/ChosenInlineResult' callback_query: $ref: '#/components/schemas/CallbackQuery' type: object WebhookInfo: description: 'Contains information about the current status of a webhook.' required: - Field - url - has_custom_certificate - pending_update_count properties: Field: $ref: '#/components/schemas/Type' url: type: string has_custom_certificate: type: boolean pending_update_count: type: integer last_error_date: type: integer last_error_message: type: string max_connections: type: integer allowed_updates: type: array items: type: string type: object User: description: 'This object represents a Telegram user or bot.' required: - Field - id - first_name properties: Field: $ref: '#/components/schemas/Type' id: type: integer first_name: type: string last_name: type: string username: type: string type: object Chat: description: 'This object represents a chat.' required: - Field - id - type properties: Field: $ref: '#/components/schemas/Type' id: type: integer type: type: string title: type: string username: type: string first_name: type: string last_name: type: string all_members_are_administrators: type: boolean type: object Message: description: 'This object represents a message.' required: - Field - message_id - date - chat properties: Field: $ref: '#/components/schemas/Type' message_id: type: integer from: $ref: '#/components/schemas/User' date: type: integer chat: $ref: '#/components/schemas/Chat' forward_from: $ref: '#/components/schemas/User' forward_from_chat: $ref: '#/components/schemas/Chat' forward_from_message_id: type: integer forward_date: type: integer reply_to_message: $ref: '#/components/schemas/Message' edit_date: type: integer text: type: string entities: type: array items: $ref: '#/components/schemas/MessageEntity' audio: $ref: '#/components/schemas/Audio' document: $ref: '#/components/schemas/Document' game: $ref: '#/components/schemas/Game' photo: type: array items: $ref: '#/components/schemas/PhotoSize' sticker: $ref: '#/components/schemas/Sticker' video: $ref: '#/components/schemas/Video' voice: $ref: '#/components/schemas/Voice' caption: type: string contact: $ref: '#/components/schemas/Contact' location: $ref: '#/components/schemas/Location' venue: $ref: '#/components/schemas/Venue' new_chat_member: $ref: '#/components/schemas/User' left_chat_member: $ref: '#/components/schemas/User' new_chat_title: type: string new_chat_photo: type: array items: $ref: '#/components/schemas/PhotoSize' delete_chat_photo: type: boolean default: true group_chat_created: type: boolean default: true supergroup_chat_created: type: boolean default: true channel_chat_created: type: boolean default: true migrate_to_chat_id: type: integer migrate_from_chat_id: type: integer pinned_message: $ref: '#/components/schemas/Message' type: object MessageEntity: description: 'This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.' required: - Field - type - offset - length properties: Field: $ref: '#/components/schemas/Type' type: type: string offset: type: integer length: type: integer url: type: string user: $ref: '#/components/schemas/User' type: object PhotoSize: description: 'This object represents one size of a photo or a file / sticker thumbnail.' required: - Field - file_id - width - height properties: Field: $ref: '#/components/schemas/Type' file_id: type: string width: type: integer height: type: integer file_size: type: integer type: object Audio: description: 'This object represents an audio file to be treated as music by the Telegram clients.' required: - Field - file_id - duration properties: Field: $ref: '#/components/schemas/Type' file_id: type: string duration: type: integer performer: type: string title: type: string mime_type: type: string file_size: type: integer type: object Document: description: 'This object represents a general file (as opposed to photos, voice messages and audio files).' required: - Field - file_id properties: Field: $ref: '#/components/schemas/Type' file_id: type: string thumb: $ref: '#/components/schemas/PhotoSize' file_name: type: string mime_type: type: string file_size: type: integer type: object Sticker: description: 'This object represents a sticker.' required: - Field - file_id - width - height properties: Field: $ref: '#/components/schemas/Type' file_id: type: string width: type: integer height: type: integer thumb: $ref: '#/components/schemas/PhotoSize' emoji: type: string file_size: type: integer type: object Video: description: 'This object represents a video file.' required: - Field - file_id - width - height - duration properties: Field: $ref: '#/components/schemas/Type' file_id: type: string width: type: integer height: type: integer duration: type: integer thumb: $ref: '#/components/schemas/PhotoSize' mime_type: type: string file_size: type: integer type: object Voice: description: 'This object represents a voice note.' required: - Field - file_id - duration properties: Field: $ref: '#/components/schemas/Type' file_id: type: string duration: type: integer mime_type: type: string file_size: type: integer type: object Contact: description: 'This object represents a phone contact.' required: - Field - phone_number - first_name properties: Field: $ref: '#/components/schemas/Type' phone_number: type: string first_name: type: string last_name: type: string user_id: type: integer type: object Location: description: 'This object represents a point on the map.' required: - Field - longitude - latitude properties: Field: $ref: '#/components/schemas/Type' longitude: type: number latitude: type: number type: object Venue: description: 'This object represents a venue.' required: - Field - location - title - address properties: Field: $ref: '#/components/schemas/Type' location: $ref: '#/components/schemas/Location' title: type: string address: type: string foursquare_id: type: string type: object UserProfilePhotos: description: "This object represent a user's profile pictures." required: - Field - total_count - photos properties: Field: $ref: '#/components/schemas/Type' total_count: type: integer photos: type: array items: type: array items: $ref: '#/components/schemas/PhotoSize' type: object File: 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.' required: - Field - file_id properties: Field: $ref: '#/components/schemas/Type' file_id: type: string file_size: type: integer file_path: type: string type: object ReplyKeyboardMarkup: description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).' required: - Field - keyboard properties: Field: $ref: '#/components/schemas/Type' keyboard: type: array items: type: array items: $ref: '#/components/schemas/KeyboardButton' resize_keyboard: type: boolean one_time_keyboard: type: boolean selective: type: boolean type: object KeyboardButton: description: 'This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive.' required: - Field - text properties: Field: $ref: '#/components/schemas/Type' text: type: string request_contact: type: boolean request_location: type: boolean type: object ReplyKeyboardRemove: description: 'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).' required: - Field - remove_keyboard properties: Field: $ref: '#/components/schemas/Type' remove_keyboard: type: boolean default: true selective: type: boolean type: object InlineKeyboardMarkup: description: 'This object represents an inline keyboard that appears right next to the message it belongs to.' required: - Field - inline_keyboard properties: Field: $ref: '#/components/schemas/Type' inline_keyboard: type: array items: type: array items: $ref: '#/components/schemas/InlineKeyboardButton' type: object InlineKeyboardButton: description: 'This object represents one button of an inline keyboard. You must use exactly one of the optional fields.' required: - Field - text properties: Field: $ref: '#/components/schemas/Type' text: type: string url: type: string callback_data: type: string switch_inline_query: type: string switch_inline_query_current_chat: type: string callback_game: $ref: '#/components/schemas/CallbackGame' type: object CallbackQuery: description: 'This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.' required: - Field - id - from - chat_instance properties: Field: $ref: '#/components/schemas/Type' id: type: string from: $ref: '#/components/schemas/User' message: $ref: '#/components/schemas/Message' inline_message_id: type: string chat_instance: type: string data: type: string game_short_name: type: string type: object ForceReply: description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode." required: - Field - force_reply properties: Field: $ref: '#/components/schemas/Type' force_reply: type: boolean default: true selective: type: boolean type: object ChatMember: description: 'This object contains information about one member of the chat.' required: - Field - user - status properties: Field: $ref: '#/components/schemas/Type' user: $ref: '#/components/schemas/User' status: type: string type: object ResponseParameters: description: 'Contains information about why a request was unsuccessfull.' required: - Field properties: Field: $ref: '#/components/schemas/Type' migrate_to_chat_id: type: integer retry_after: type: integer type: object InputFile: description: 'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.' type: object InlineQuery: description: 'This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.' required: - Field - id - from - query - offset properties: Field: $ref: '#/components/schemas/Type' id: type: string from: $ref: '#/components/schemas/User' location: $ref: '#/components/schemas/Location' query: type: string offset: type: string type: object InlineQueryResult: description: 'This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:' anyOf: - $ref: '#/components/schemas/InlineQueryResultCachedAudio' - $ref: '#/components/schemas/InlineQueryResultCachedDocument' - $ref: '#/components/schemas/InlineQueryResultCachedGif' - $ref: '#/components/schemas/InlineQueryResultCachedMpeg4Gif' - $ref: '#/components/schemas/InlineQueryResultCachedPhoto' - $ref: '#/components/schemas/InlineQueryResultCachedSticker' - $ref: '#/components/schemas/InlineQueryResultCachedVideo' - $ref: '#/components/schemas/InlineQueryResultCachedVoice' - $ref: '#/components/schemas/InlineQueryResultArticle' - $ref: '#/components/schemas/InlineQueryResultAudio' - $ref: '#/components/schemas/InlineQueryResultContact' - $ref: '#/components/schemas/InlineQueryResultGame' - $ref: '#/components/schemas/InlineQueryResultDocument' - $ref: '#/components/schemas/InlineQueryResultGif' - $ref: '#/components/schemas/InlineQueryResultLocation' - $ref: '#/components/schemas/InlineQueryResultMpeg4Gif' - $ref: '#/components/schemas/InlineQueryResultPhoto' - $ref: '#/components/schemas/InlineQueryResultVenue' - $ref: '#/components/schemas/InlineQueryResultVideo' - $ref: '#/components/schemas/InlineQueryResultVoice' InlineQueryResultArticle: description: 'Represents a link to an article or web page.' required: - Field - type - id - title - input_message_content properties: Field: $ref: '#/components/schemas/Type' type: type: string default: article id: type: string title: type: string input_message_content: $ref: '#/components/schemas/InputMessageContent' reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' url: type: string hide_url: type: boolean description: type: string thumb_url: type: string thumb_width: type: integer thumb_height: type: integer type: object InlineQueryResultPhoto: description: 'Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.' required: - Field - type - id - photo_url - thumb_url properties: Field: $ref: '#/components/schemas/Type' type: type: string default: photo id: type: string photo_url: type: string thumb_url: type: string photo_width: type: integer photo_height: type: integer title: type: string description: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultGif: description: 'Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.' required: - Field - type - id - gif_url - thumb_url properties: Field: $ref: '#/components/schemas/Type' type: type: string default: gif id: type: string gif_url: type: string gif_width: type: integer gif_height: type: integer thumb_url: type: string title: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultMpeg4Gif: description: 'Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.' required: - Field - type - id - mpeg4_url - thumb_url properties: Field: $ref: '#/components/schemas/Type' type: type: string default: mpeg4_gif id: type: string mpeg4_url: type: string mpeg4_width: type: integer mpeg4_height: type: integer thumb_url: type: string title: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultVideo: description: 'Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.' required: - Field - type - id - video_url - mime_type - thumb_url - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: video id: type: string video_url: type: string mime_type: type: string thumb_url: type: string title: type: string caption: type: string video_width: type: integer video_height: type: integer video_duration: type: integer description: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultAudio: description: 'Represents a link to an mp3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.' required: - Field - type - id - audio_url - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: audio id: type: string audio_url: type: string title: type: string caption: type: string performer: type: string audio_duration: type: integer reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultVoice: description: 'Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.' required: - Field - type - id - voice_url - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: voice id: type: string voice_url: type: string title: type: string caption: type: string voice_duration: type: integer reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultDocument: description: 'Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.' required: - Field - type - id - title - document_url - mime_type properties: Field: $ref: '#/components/schemas/Type' type: type: string default: document id: type: string title: type: string caption: type: string document_url: type: string mime_type: type: string description: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' thumb_url: type: string thumb_width: type: integer thumb_height: type: integer type: object InlineQueryResultLocation: description: 'Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.' required: - Field - type - id - latitude - longitude - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: location id: type: string latitude: type: number longitude: type: number title: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' thumb_url: type: string thumb_width: type: integer thumb_height: type: integer type: object InlineQueryResultVenue: description: 'Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.' required: - Field - type - id - latitude - longitude - title - address properties: Field: $ref: '#/components/schemas/Type' type: type: string default: venue id: type: string latitude: type: number longitude: type: number title: type: string address: type: string foursquare_id: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' thumb_url: type: string thumb_width: type: integer thumb_height: type: integer type: object InlineQueryResultContact: description: 'Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.' required: - Field - type - id - phone_number - first_name properties: Field: $ref: '#/components/schemas/Type' type: type: string default: contact id: type: string phone_number: type: string first_name: type: string last_name: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' thumb_url: type: string thumb_width: type: integer thumb_height: type: integer type: object InlineQueryResultGame: description: 'Represents a Game.' required: - Field - type - id - game_short_name properties: Field: $ref: '#/components/schemas/Type' type: type: string default: game id: type: string game_short_name: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' type: object InlineQueryResultCachedPhoto: description: 'Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.' required: - Field - type - id - photo_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: photo id: type: string photo_file_id: type: string title: type: string description: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedGif: description: 'Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.' required: - Field - type - id - gif_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: gif id: type: string gif_file_id: type: string title: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedMpeg4Gif: description: 'Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.' required: - Field - type - id - mpeg4_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: mpeg4_gif id: type: string mpeg4_file_id: type: string title: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedSticker: description: 'Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.' required: - Field - type - id - sticker_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: sticker id: type: string sticker_file_id: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedDocument: description: 'Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.' required: - Field - type - id - title - document_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: document id: type: string title: type: string document_file_id: type: string description: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedVideo: description: 'Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.' required: - Field - type - id - video_file_id - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: video id: type: string video_file_id: type: string title: type: string description: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedVoice: description: 'Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.' required: - Field - type - id - voice_file_id - title properties: Field: $ref: '#/components/schemas/Type' type: type: string default: voice id: type: string voice_file_id: type: string title: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InlineQueryResultCachedAudio: description: 'Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.' required: - Field - type - id - audio_file_id properties: Field: $ref: '#/components/schemas/Type' type: type: string default: audio id: type: string audio_file_id: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' input_message_content: $ref: '#/components/schemas/InputMessageContent' type: object InputMessageContent: description: 'This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types:' anyOf: - $ref: '#/components/schemas/InputTextMessageContent' - $ref: '#/components/schemas/InputLocationMessageContent' - $ref: '#/components/schemas/InputVenueMessageContent' - $ref: '#/components/schemas/InputContactMessageContent' InputTextMessageContent: description: 'Represents the content of a text message to be sent as the result of an inline query.' required: - Field - message_text properties: Field: $ref: '#/components/schemas/Type' message_text: type: string parse_mode: type: string disable_web_page_preview: type: boolean type: object InputLocationMessageContent: description: 'Represents the content of a location message to be sent as the result of an inline query.' required: - Field - latitude - longitude properties: Field: $ref: '#/components/schemas/Type' latitude: type: number longitude: type: number type: object InputVenueMessageContent: description: 'Represents the content of a venue message to be sent as the result of an inline query.' required: - Field - latitude - longitude - title - address properties: Field: $ref: '#/components/schemas/Type' latitude: type: number longitude: type: number title: type: string address: type: string foursquare_id: type: string type: object InputContactMessageContent: description: 'Represents the content of a contact message to be sent as the result of an inline query.' required: - Field - phone_number - first_name properties: Field: $ref: '#/components/schemas/Type' phone_number: type: string first_name: type: string last_name: type: string type: object ChosenInlineResult: description: 'Represents a result of an inline query that was chosen by the user and sent to their chat partner.' required: - Field - result_id - from - query properties: Field: $ref: '#/components/schemas/Type' result_id: type: string from: $ref: '#/components/schemas/User' location: $ref: '#/components/schemas/Location' inline_message_id: type: string query: type: string type: object Game: description: 'This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.' required: - Field - title - description - photo properties: Field: $ref: '#/components/schemas/Type' title: type: string description: type: string photo: type: array items: $ref: '#/components/schemas/PhotoSize' text: type: string text_entities: type: array items: $ref: '#/components/schemas/MessageEntity' animation: $ref: '#/components/schemas/Animation' type: object Animation: description: 'You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). This object represents an animation file to be displayed in the message containing a game.' required: - Field - file_id properties: Field: $ref: '#/components/schemas/Type' file_id: type: string thumb: $ref: '#/components/schemas/PhotoSize' file_name: type: string mime_type: type: string file_size: type: integer type: object CallbackGame: description: 'A placeholder, currently holds no information. Use BotFather to set up your game.' type: object GameHighScore: description: 'This object represents one row of the high scores table for a game.' required: - Field - position - user - score properties: Field: $ref: '#/components/schemas/Type' position: type: integer user: $ref: '#/components/schemas/User' score: type: integer type: object paths: /getUpdates: description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.' post: requestBody: content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' offset: type: integer limit: type: integer default: 100 timeout: type: integer allowed_updates: type: array items: type: string application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' offset: type: integer limit: type: integer default: 100 timeout: type: integer allowed_updates: type: array items: type: string multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' offset: type: integer limit: type: integer default: 100 timeout: type: integer allowed_updates: type: array items: type: string responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: array items: $ref: '#/components/schemas/Update' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /setWebhook: 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. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns true.\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/. Since nobody else knows your bot‘s token, you can be pretty sure it’s us." post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' url: type: string certificate: $ref: '#/components/schemas/InputFile' max_connections: type: integer default: 40 allowed_updates: type: array items: type: string required: - url application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' url: type: string certificate: $ref: '#/components/schemas/InputFile' max_connections: type: integer default: 40 allowed_updates: type: array items: type: string required: - url multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' url: type: string certificate: $ref: '#/components/schemas/InputFile' max_connections: type: integer default: 40 allowed_updates: type: array items: type: string required: - url responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: { } 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /deleteWebhook: description: 'Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.' post: requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object multipart/form-data: schema: type: object responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getWebhookInfo: description: 'Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.' post: requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object multipart/form-data: schema: type: object responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/WebhookInfo' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getMe: description: "A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object." post: requestBody: content: application/json: schema: type: object application/x-www-form-urlencoded: schema: type: object multipart/form-data: schema: type: object responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/User' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendMessage: description: 'Use this method to send text messages. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - text application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - text multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - text responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /forwardMessage: description: 'Use this method to forward messages of any kind. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string from_chat_id: anyOf: - type: integer - type: string disable_notification: type: boolean message_id: type: integer required: - chat_id - from_chat_id - message_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string from_chat_id: anyOf: - type: integer - type: string disable_notification: type: boolean message_id: type: integer required: - chat_id - from_chat_id - message_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string from_chat_id: anyOf: - type: integer - type: string disable_notification: type: boolean message_id: type: integer required: - chat_id - from_chat_id - message_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendPhoto: description: 'Use this method to send photos. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string photo: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - photo application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string photo: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - photo multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string photo: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - photo responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendAudio: 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 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the sendVoice method instead." post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string audio: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer performer: type: string title: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - audio application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string audio: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer performer: type: string title: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - audio multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string audio: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer performer: type: string title: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - audio responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendDocument: description: 'Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string document: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - document application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string document: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - document multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string document: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - document responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendSticker: description: 'Use this method to send .webp stickers. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string sticker: anyOf: - $ref: '#/components/schemas/InputFile' - type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - sticker application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string sticker: anyOf: - $ref: '#/components/schemas/InputFile' - type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - sticker multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string sticker: anyOf: - $ref: '#/components/schemas/InputFile' - type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - sticker responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendVideo: description: 'Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string video: anyOf: - $ref: '#/components/schemas/InputFile' - type: string duration: type: integer width: type: integer height: type: integer caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - video application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string video: anyOf: - $ref: '#/components/schemas/InputFile' - type: string duration: type: integer width: type: integer height: type: integer caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - video multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string video: anyOf: - $ref: '#/components/schemas/InputFile' - type: string duration: type: integer width: type: integer height: type: integer caption: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - video responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendVoice: description: 'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string voice: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - voice application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string voice: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - voice multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string voice: anyOf: - $ref: '#/components/schemas/InputFile' - type: string caption: type: string duration: type: integer disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - voice responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendLocation: description: 'Use this method to send point on the map. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendVenue: description: 'Use this method to send information about a venue. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number title: type: string address: type: string foursquare_id: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude - title - address application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number title: type: string address: type: string foursquare_id: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude - title - address multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string latitude: type: number longitude: type: number title: type: string address: type: string foursquare_id: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - latitude - longitude - title - address responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendContact: description: 'Use this method to send phone contacts. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string phone_number: type: string first_name: type: string last_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - phone_number - first_name application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string phone_number: type: string first_name: type: string last_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - phone_number - first_name multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string phone_number: type: string first_name: type: string last_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: anyOf: - $ref: '#/components/schemas/InlineKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardMarkup' - $ref: '#/components/schemas/ReplyKeyboardRemove' - $ref: '#/components/schemas/ForceReply' required: - chat_id - phone_number - first_name responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendChatAction: 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.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive." post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string action: type: string required: - chat_id - action application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string action: type: string required: - chat_id - action multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string action: type: string required: - chat_id - action responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getUserProfilePhotos: description: 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer offset: type: integer limit: type: integer default: 100 required: - user_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer offset: type: integer limit: type: integer default: 100 required: - user_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer offset: type: integer limit: type: integer default: 100 required: - user_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/UserProfilePhotos' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getFile: description: 'Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. 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 again.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' file_id: type: string required: - file_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' file_id: type: string required: - file_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' file_id: type: string required: - file_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/File' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /kickChatMember: description: 'Use this method to kick a user from a group or a supergroup. In the case of supergroups, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the group for this to work. Returns True on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /leaveChat: description: 'Use this method for your bot to leave a group, supergroup or channel. Returns True on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /unbanChatMember: description: 'Use this method to unban a previously kicked user in a supergroup. The user will not return to the group automatically, but will be able to join via link, etc. The bot must be an administrator in the group for this to work. Returns True on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getChat: description: 'Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Chat' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getChatAdministrators: description: 'Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: array items: $ref: '#/components/schemas/ChatMember' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getChatMembersCount: description: 'Use this method to get the number of members in a chat. Returns Int on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string required: - chat_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: integer 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getChatMember: description: 'Use this method to get information about a member of a chat. Returns a ChatMember object on success.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string user_id: type: integer required: - chat_id - user_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/ChatMember' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /answerCallbackQuery: description: 'Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' callback_query_id: type: string text: type: string show_alert: type: boolean url: type: string cache_time: type: integer required: - callback_query_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' callback_query_id: type: string text: type: string show_alert: type: boolean url: type: string cache_time: type: integer required: - callback_query_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' callback_query_id: type: string text: type: string show_alert: type: boolean url: type: string cache_time: type: integer required: - callback_query_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /editMessageText: description: 'Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - text application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - text multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string text: type: string parse_mode: type: string disable_web_page_preview: type: boolean reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - text responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: anyOf: - $ref: '#/components/schemas/Message' - type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /editMessageCaption: description: 'Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.' post: requestBody: content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string caption: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: anyOf: - $ref: '#/components/schemas/Message' - type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /editMessageReplyMarkup: description: 'Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.' post: requestBody: content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: anyOf: - type: integer - type: string message_id: type: integer inline_message_id: type: string reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: anyOf: - $ref: '#/components/schemas/Message' - type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /answerInlineQuery: description: 'Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' inline_query_id: type: string results: type: array items: $ref: '#/components/schemas/InlineQueryResult' cache_time: type: integer default: 300 is_personal: type: boolean next_offset: type: string switch_pm_text: type: string switch_pm_parameter: type: string required: - inline_query_id - results application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' inline_query_id: type: string results: type: array items: $ref: '#/components/schemas/InlineQueryResult' cache_time: type: integer default: 300 is_personal: type: boolean next_offset: type: string switch_pm_text: type: string switch_pm_parameter: type: string required: - inline_query_id - results multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' inline_query_id: type: string results: type: array items: $ref: '#/components/schemas/InlineQueryResult' cache_time: type: integer default: 300 is_personal: type: boolean next_offset: type: string switch_pm_text: type: string switch_pm_parameter: type: string required: - inline_query_id - results responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /sendGame: description: 'Use this method to send a game. On success, the sent Message is returned.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: type: integer game_short_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - chat_id - game_short_name application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: type: integer game_short_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - chat_id - game_short_name multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' chat_id: type: integer game_short_name: type: string disable_notification: type: boolean reply_to_message_id: type: integer reply_markup: $ref: '#/components/schemas/InlineKeyboardMarkup' required: - chat_id - game_short_name responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: $ref: '#/components/schemas/Message' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /setGameScore: description: "Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False." post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer score: type: integer force: type: boolean disable_edit_message: type: boolean chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id - score application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer score: type: integer force: type: boolean disable_edit_message: type: boolean chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id - score multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer score: type: integer force: type: boolean disable_edit_message: type: boolean chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id - score responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: anyOf: - $ref: '#/components/schemas/Message' - type: boolean 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError' /getGameHighScores: description: 'Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.' post: requestBody: required: true content: application/json: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id application/x-www-form-urlencoded: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id multipart/form-data: schema: type: object properties: Parameters: $ref: '#/components/schemas/Type' user_id: type: integer chat_id: type: integer message_id: type: integer inline_message_id: type: string required: - user_id responses: 200: description: 'Request was successful, the result is returned.' content: application/json: schema: allOf: - $ref: '#/components/schemas/Success' - type: object properties: result: type: array items: $ref: '#/components/schemas/GameHighScore' 400: $ref: '#/components/responses/BadRequest' 401: $ref: '#/components/responses/Unauthorized' 403: $ref: '#/components/responses/Forbidden' 404: $ref: '#/components/responses/NotFound' 409: $ref: '#/components/responses/Conflict' 429: $ref: '#/components/responses/TooManyRequests' 5XX: $ref: '#/components/responses/ServerError' default: $ref: '#/components/responses/UnknownError'