{"openapi":"3.0.0","info":{"description":"Telegram","version":[]},"servers":[{"description":"Telegram","url":"https://api.apirails.com/telegram"}],"paths":{"/bot{token}/sendMessage":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendmessage","api_endpoint":"https://api.telegram.org/bot{token}/sendMessage"},"summary":"Send message","description":"Send text messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Text of the message to be sent 1-4096 characters after entities parsing","required":true},"allow_sending_without_reply":{"type":"boolean","description":"Pass True if the message should be sent even if the specified replied-to message is not found"},"business_connection_id":{"type":"string","description":"Unique identifier of the business connection on behalf of which the message will be sent"},"chat_id":{"type":"string","description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"boolean","description":"Sends the message silently. Users will receive a notification with no sound."},"disable_web_page_preview":{"type":"string","description":"Disables link previews for links in this message"},"entities":{"type":"array","description":"A JSON-serialized list of special entities that appear in message text which can be specified instead of parse_mode","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the entity. Currently, can be 'mention', 'hashtag', 'cashtag', 'bot_command', 'url', 'email', 'phone_number', 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'blockquote', 'expandable_blockquote', 'code', 'pre', 'text_link', 'text_mention', 'custom_emoji', 'date_time'","required":true,"enum":["mention","hashtag","cashtag","bot_command","url","email","phone_number","bold","italic","underline","strikethrough","spoiler","blockquote","expandable_blockquote","code","pre","text_link","text_mention","custom_emoji","date_time"]},"offset":{"type":"number","description":"Offset in UTF-16 code units to the start of the entity","required":true},"length":{"type":"number","description":"Length of the entity in UTF-16 code units","required":true},"url":{"type":"string","description":"Optional. For 'text_link' only, URL that will be opened after user taps on the text"},"user":{"type":"object","description":"Optional. For 'text_mention' only, the mentioned user"},"language":{"type":"string","description":"Optional. For 'pre' only, the programming language of the entity text"},"custom_emoji_id":{"type":"string","description":"Optional. For 'custom_emoji' only, unique identifier of the custom emoji"}}}},"message_effect_id":{"type":"string","description":"Unique identifier of the message effect to be added to the message; for private chats only"},"message_thread_id":{"type":"string","description":"Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Mode for parsing entities in the message text. Values: MarkdownV2, Markdown, HTML"},"protect_content":{"type":"boolean","description":"Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_parameters":{"type":"string","description":"Description of the message to reply to"},"reply_to_message_id":{"type":"string","description":"If the message is a reply ID of the original message"}}},"example":{"text":"","allow_sending_without_reply":"","business_connection_id":"","chat_id":"","disable_notification":"","disable_web_page_preview":"","entities":[],"message_effect_id":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_parameters":"","reply_to_message_id":""}}}}}},"/bot{token}/getUpdates":{"get":{"tags":["Activity"],"parameters":[{"name":"allowed_updates","in":"query","description":"A JSON-serialized list of the update types you want your bot to receive. For example specify [“message” “edited_channel_post” “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the getUpdates so unwanted updates may be received for a short period of time.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.","schema":{"type":"string","example":""}},{"name":"timeout","in":"query","description":"Timeout in seconds for long polling. Defaults to 0 i.e. usual short polling. Should be positive short polling should be used for testing purposes only.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getupdates","api_endpoint":"https://api.telegram.org/bot{token}/getUpdates"},"summary":"Get incoming updates","description":"Fetch mesage updates","security":[{"bearerAuth":[]}]}},"/bot{token}/forwardMessage":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#forwardmessage","api_endpoint":"https://api.telegram.org/bot{token}/forwardMessage"},"summary":"Forward message","description":"Forward various messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"boolean","description":"Sends the message silently. Users will receive a notification with no sound."},"from_chat_id":{"type":"string","description":"Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)","required":true},"message_id":{"type":"string","description":"Message identifier in the chat specified in from_chat_id","required":true},"message_thread_id":{"type":"string","description":"Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"string","description":"Protects the contents of the forwarded message from forwarding and saving"}}},"example":{"chat_id":"","disable_notification":"","from_chat_id":"","message_id":"","message_thread_id":"","protect_content":""}}}}}},"/bot{token}/setWebhook":{"post":{"tags":["Webhook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setwebhook","api_endpoint":"https://api.telegram.org/bot{token}/setWebhook"},"summary":"Set or update webhook","description":"Set webhook URL, receive updates, ensure security","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_updates":{"type":"string","description":"Optional. A JSON-serialized list of the update types you want your bot to receive. For example specify [“message” “edited_channel_post” “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook so unwanted updates may be received for a short period of time."},"certificate":{"type":"string","description":"Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details."},"drop_pending_updates":{"type":"string","description":"Optional. Pass True to drop all pending updates"},"ip_address":{"type":"string","description":"Optional. The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS"},"max_connections":{"type":"string","description":"Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery 1-100. Defaults to 40. Use lower values to limit the load on your bot's server and higher values to increase your bot's throughput."},"secret_token":{"type":"string","description":"Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request 1-256 characters. Only characters A-Z a-z 0-9 _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you."},"url":{"type":"string","description":"Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration","required":true}}},"example":{"allowed_updates":"","certificate":"","drop_pending_updates":"","ip_address":"","max_connections":"","secret_token":"","url":""}}}}}},"/bot{token}/deleteWebhook":{"post":{"tags":["Webhook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#deletewebhook","api_endpoint":"https://api.telegram.org/bot{token}/deleteWebhook"},"summary":"Remove webhook","description":"Remove webhook integration, switch to getUpdates","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"drop_pending_updates":{"type":"string","description":"Optional. Pass True to drop all pending updates"}}},"example":{"drop_pending_updates":""}}}}}},"/bot{token}/copyMessage":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#copymessage","api_endpoint":"https://api.telegram.org/bot{token}/copyMessage"},"summary":"Copy message","description":"Copy various messages, excluding some types. No link provided","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"caption":{"type":"string","description":"Optional. New caption for media 0-1024 characters after entities parsing. If not specified the original caption is kept"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the new caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"from_chat_id":{"type":"string","description":"Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)","required":true},"message_id":{"type":"string","description":"Required. Message identifier in the chat specified in from_chat_id","required":true},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the new caption. See formatting options for more details."},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"}}},"example":{"allow_sending_without_reply":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","from_chat_id":"","message_id":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_to_message_id":""}}}}}},"/bot{token}/getWebhookInfo":{"get":{"tags":["Webhook"],"parameters":[{"name":"allowed_updates","in":"query","description":"A list of update types the bot is subscribed to. Defaults to all update types except chat_member","schema":{"type":"array","example":""}},{"name":"has_custom_certificate","in":"query","description":"True, if a custom certificate was provided for webhook certificate checks","required":true,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"ip_address","in":"query","description":"Currently used webhook IP address","schema":{"type":"string","example":""}},{"name":"last_error_date","in":"query","description":"Unix time for the most recent error that happened when trying to deliver an update via webhook","schema":{"type":"number","example":""}},{"name":"last_error_message","in":"query","description":"Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook","schema":{"type":"string","example":""}},{"name":"last_synchronization_error_date","in":"query","description":"Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters","schema":{"type":"number","example":""}},{"name":"max_connections","in":"query","description":"The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery","schema":{"type":"number","example":""}},{"name":"pending_update_count","in":"query","description":"Number of updates awaiting delivery","required":true,"schema":{"type":"number","example":""}},{"name":"url","in":"query","description":"Webhook URL, may be empty if webhook is not set up","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getwebhookinfo","api_endpoint":"https://api.telegram.org/bot{token}/getWebhookInfo"},"summary":"Get current webhook status","description":"Get current webhook status","security":[{"bearerAuth":[]}]}},"/bot{token}/sendPhoto":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendphoto","api_endpoint":"https://api.telegram.org/bot{token}/sendPhoto"},"summary":"Send photo","description":"Send photos","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"boolean","description":"Pass True if the message should be sent even if the specified replied-to message is not found"},"caption":{"type":"string","description":"Photo caption (may also be used when resending photos by file_id) 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Sends the message silently. Users will receive a notification with no sound."},"has_spoiler":{"type":"boolean","description":"Set true if the photo needs to be covered with a spoiler animation"},"message_thread_id":{"type":"string","description":"Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Mode for parsing entities in the photo caption. See formatting options for more details."},"photo":{"type":"string","description":"Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a photo from the Internet or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files","required":true},"protect_content":{"type":"string","description":"Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"If the message is a reply ID of the original message"},"show_caption_above_media":{"type":"boolean","description":"Pass True, if the caption must be shown above the message media"}}},"example":{"allow_sending_without_reply":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","has_spoiler":"","message_thread_id":"","parse_mode":"","photo":"","protect_content":"","reply_markup":"","reply_to_message_id":"","show_caption_above_media":""}}}}}},"/bot{token}/sendVideo":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendvideo","api_endpoint":"https://api.telegram.org/bot{token}/sendVideo"},"summary":"Send video","description":"Send video files, supported format MPEG4, file limit 50MB","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"caption":{"type":"string","description":"Optional. Video caption (may also be used when resending videos by file_id) 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"duration":{"type":"string","description":"Optional. Duration of sent video in seconds"},"height":{"type":"string","description":"Optional. Video height"},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the video caption. See formatting options for more details."},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"},"supports_streaming":{"type":"string","description":"Optional. Pass True if the uploaded video is suitable for streaming"},"thumb":{"type":"string","description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach","enum":["","","<file_attach_name>” if the thumbnail was uploaded using multipart","form-data under <file_attach_name>. More information on Sending Files »"]},"video":{"type":"string","description":"Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a video from the Internet or upload a new video using multipart/form-data. More information on Sending Files »","required":true},"width":{"type":"string","description":"Optional. Video width"}}},"example":{"allow_sending_without_reply":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","duration":"","height":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_to_message_id":"","supports_streaming":"","thumb":"","video":"","width":""}}}}}},"/bot{token}/sendVideoNote":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendvideonote","api_endpoint":"https://api.telegram.org/bot{token}/sendVideoNote"},"summary":"Send video note","description":"Send video messages, format MPEG4, upto 1 minute","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional.Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional.Sends the message silently.Users will receive a notification with no sound."},"duration":{"type":"string","description":"Optional.Duration of sent video in seconds"},"length":{"type":"string","description":"Optional.Video width and height i.e. diameter of the video message"},"message_thread_id":{"type":"string","description":"Optional.Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"string","description":"Optional.Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional.Additional interface options.A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional.If the message is a reply ID of the original message"},"thumb":{"type":"string","description":"Optional.Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.The thumbnail should be in JPEG format and less than 200 kB in size.A thumbnail's width and height should not exceed 320.Ignored if the file is not uploaded using multipart/form-data.Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach","enum":["","","<file_attach_name>” if the thumbnail was uploaded using multipart","form-data under <file_attach_name>.More information on Sending Files »"]},"video_note":{"type":"string","description":"Required.Video note to send.Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files.Sending video notes by a URL is currently unsupported","required":true}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","duration":"","length":"","message_thread_id":"","protect_content":"","reply_markup":"","reply_to_message_id":"","thumb":"","video_note":""}}}}}},"/bot{token}/sendDocument":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#senddocument","api_endpoint":"https://api.telegram.org/bot{token}/sendDocument"},"summary":"Send general files","description":"Send general files, supported any type of file, file limit 50MB","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"caption":{"type":"string","description":"Optional. Document caption (may also be used when resending documents by file_id) 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_content_type_detection":{"type":"string","description":"Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data"},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"document":{"type":"string","description":"Required. File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data. More information on Sending Files »","required":true},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the document caption. See formatting options for more details."},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"},"thumb":{"type":"string","description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach","enum":["","","<file_attach_name>” if the thumbnail was uploaded using multipart","form-data under <file_attach_name>. More information on Sending Files »"]}}},"example":{"allow_sending_without_reply":"","caption":"","caption_entities":"","chat_id":"","disable_content_type_detection":"","disable_notification":"","document":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_to_message_id":"","thumb":""}}}}}},"/bot{token}/sendAnimation":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendanimation","api_endpoint":"https://api.telegram.org/bot{token}/sendAnimation"},"summary":"Send animated file","description":"Send animation files, file limit 50 MB in size","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"animation":{"type":"string","description":"Required. Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get an animation from the Internet or upload a new animation using multipart/form-data. More information on Sending Files »","required":true},"caption":{"type":"string","description":"Optional. Animation caption (may also be used when resending animation by file_id) 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"duration":{"type":"string","description":"Optional. Duration of sent animation in seconds"},"height":{"type":"string","description":"Optional. Animation height"},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the animation caption. See formatting options for more details."},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"},"thumb":{"type":"string","description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach","enum":["","","<file_attach_name>” if the thumbnail was uploaded using multipart","form-data under <file_attach_name>. More information on Sending Files »"]},"width":{"type":"string","description":"Optional. Animation width"}}},"example":{"allow_sending_without_reply":"","animation":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","duration":"","height":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_to_message_id":"","thumb":"","width":""}}}}}},"/bot{token}/sendVoice":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendvoice","api_endpoint":"https://api.telegram.org/bot{token}/sendVoice"},"summary":"Send voice message","description":"Send Telegram voice messages: OGG, OPUS, 50MB limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"caption":{"type":"string","description":"Optional. Voice message caption 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"duration":{"type":"string","description":"Optional. Duration of the voice message in seconds"},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the voice message caption. See formatting options for more details."},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"},"voice":{"type":"string","description":"Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data. More information on Sending Files »","required":true}}},"example":{"allow_sending_without_reply":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","duration":"","message_thread_id":"","parse_mode":"","protect_content":"","reply_markup":"","reply_to_message_id":"","voice":""}}}}}},"/bot{token}/sendDice":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#senddice","api_endpoint":"https://api.telegram.org/bot{token}/sendDice"},"summary":"Send a random animated emoji","description":"Send animated emoji with random value on Telegram","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Sends the message silently.Users will receive a notification with no sound."},"emoji":{"type":"string","description":"Emoji on which the dice throw animation is based. Currently must be one of “🎲” “🎯” “🏀” “⚽” “🎳” or “🎰”.Dice can have values 1-6 for “🎲” “🎯” and “🎳” values 1-5 for “🏀” and “⚽” and values 1-64 for “🎰”. Defaults to “🎲”"},"message_thread_id":{"type":"string","description":"Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"string","description":"Protects the contents of the sent message from forwarding"},"reply_markup":{"type":"string","description":"Additional interface options.A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"If the message is a reply ID of the original message"}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","emoji":"","message_thread_id":"","protect_content":"","reply_markup":"","reply_to_message_id":""}}}}}},"/bot{token}/sendContact":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendcontact","api_endpoint":"https://api.telegram.org/bot{token}/sendContact"},"summary":"Send phone contact","description":"Send phone contacts seamlessly; receive the sent message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional.Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional.Sends the message silently.Users will receive a notification with no sound."},"first_name":{"type":"string","description":"Required.Contact's first name","required":true},"last_name":{"type":"string","description":"Optional.Contact's last name"},"message_thread_id":{"type":"string","description":"Optional.Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"phone_number":{"type":"string","description":"Required.Contact's phone number","required":true},"protect_content":{"type":"string","description":"Optional.Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional.Additional interface options.A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional.If the message is a reply ID of the original message"},"vcard":{"type":"string","description":"Optional.Additional data about the contact in the form of a vCard 0-2048 bytes"}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","first_name":"","last_name":"","message_thread_id":"","phone_number":"","protect_content":"","reply_markup":"","reply_to_message_id":"","vcard":""}}}}}},"/bot{token}/sendLocation":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendlocation","api_endpoint":"https://api.telegram.org/bot{token}/sendLocation"},"summary":"Send location","description":"Send a point on the map","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"boolean","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"boolean","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"heading":{"type":"number","description":"Optional. For live locations, a direction in which the user is moving, in degrees; 1-360"},"horizontal_accuracy":{"type":"number","description":"Optional. The radius of uncertainty for the location, measured in meters; 0-1500"},"latitude":{"type":"number","description":"Required. Latitude of the location","required":true},"live_period":{"type":"number","description":"Optional. Period in seconds during which the location can be updated, should be between 60 and 86400"},"longitude":{"type":"number","description":"Required. Longitude of the location","required":true},"message_thread_id":{"type":"number","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"boolean","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"proximity_alert_radius":{"type":"number","description":"Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters; 1-100000"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"number","description":"Optional. If the message is a reply, ID of the original message"}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","heading":"","horizontal_accuracy":"","latitude":"","live_period":"","longitude":"","message_thread_id":"","protect_content":"","proximity_alert_radius":"","reply_markup":"","reply_to_message_id":""}}}}}},"/bot{token}/sendVenue":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendvenue","api_endpoint":"https://api.telegram.org/bot{token}/sendVenue"},"summary":"Send venue","description":"Send information about a venue","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"address":{"type":"string","description":"Required. Address of the venue","required":true},"allow_sending_without_reply":{"type":"boolean","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"boolean","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"foursquare_id":{"type":"string","description":"Optional. Foursquare identifier of the venue"},"foursquare_type":{"type":"string","description":"Optional. Foursquare type of the venue"},"google_place_id":{"type":"string","description":"Optional. Google Places identifier of the venue"},"google_place_type":{"type":"string","description":"Optional. Google Places type of the venue"},"latitude":{"type":"number","description":"Required. Latitude of the venue","required":true},"longitude":{"type":"number","description":"Required. Longitude of the venue","required":true},"message_thread_id":{"type":"number","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"boolean","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"number","description":"Optional. If the message is a reply, ID of the original message"},"title":{"type":"string","description":"Required. Name of the venue","required":true}}},"example":{"address":"","allow_sending_without_reply":"","chat_id":"","disable_notification":"","foursquare_id":"","foursquare_type":"","google_place_id":"","google_place_type":"","latitude":"","longitude":"","message_thread_id":"","protect_content":"","reply_markup":"","reply_to_message_id":"","title":""}}}}}},"/bot{token}/sendPoll":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendpoll","api_endpoint":"https://api.telegram.org/bot{token}/sendPoll"},"summary":"Send poll","description":"Send a native poll","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"Optional. Poll type, \"quiz\" or \"regular\", defaults to \"regular\"","enum":["quiz","regular"]},"allow_sending_without_reply":{"type":"boolean","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"allows_multiple_answers":{"type":"boolean","description":"Optional. True if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"close_date":{"type":"number","description":"Optional. Point in time (Unix timestamp) when the poll will be automatically closed"},"correct_option_id":{"type":"number","description":"Optional. 0-based identifier of the correct answer option, required for polls in quiz mode"},"disable_notification":{"type":"boolean","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"explanation":{"type":"string","description":"Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters"},"explanation_parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the explanation"},"is_anonymous":{"type":"boolean","description":"Optional. True if the poll needs to be anonymous, defaults to True"},"is_closed":{"type":"boolean","description":"Optional. Pass True if the poll needs to be immediately closed"},"message_thread_id":{"type":"number","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"open_period":{"type":"number","description":"Optional. Amount of time in seconds the poll will be active after creation, 5-600"},"options":{"type":"array","description":"Required. A JSON-serialized list of answer options, 2-10 strings 1-100 characters each","required":true,"items":{"type":"object","properties":{"text":{"type":"string","description":"Option text, 1-100 characters","required":true},"text_parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the option text","enum":["MarkdownV2","HTML"]},"text_entities":{"type":"array","description":"Optional. A JSON-serialized list of special entities in the option text"},"media":{"type":"object","description":"Optional. An object with media for the poll option"}}}},"protect_content":{"type":"boolean","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"question":{"type":"string","description":"Required. Poll question, 1-300 characters","required":true},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"number","description":"Optional. If the message is a reply, ID of the original message"}}},"example":{"type":"","allow_sending_without_reply":"","allows_multiple_answers":"","chat_id":"","close_date":"","correct_option_id":"","disable_notification":"","explanation":"","explanation_parse_mode":"","is_anonymous":"","is_closed":"","message_thread_id":"","open_period":"","options":[],"protect_content":"","question":"","reply_markup":"","reply_to_message_id":""}}}}}},"/bot{token}/sendChatAction":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendchataction","api_endpoint":"https://api.telegram.org/bot{token}/sendChatAction"},"summary":"Send chat action","description":"Send a chat action to indicate to the user that something is happening on the bot's side","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes","required":true,"enum":["typing","upload_photo","record_video","upload_video","record_voice","upload_voice","upload_document","find_location","record_video_note","upload_video_note"]},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"message_thread_id":{"type":"number","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"}}},"example":{"action":"","chat_id":"","message_thread_id":""}}}}}},"/bot{token}/deleteMessage":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#deletemessage","api_endpoint":"https://api.telegram.org/bot{token}/deleteMessage"},"summary":"Delete messages, including service messages","description":"Delete messages with specific constraints: 48-hour limit, permissions-based","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"message_id":{"type":"string","description":"Required.Identifier of the message to delete","required":true}}},"example":{"chat_id":"","message_id":""}}}}}},"/bot{token}/editMessageText":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#editmessagetext","api_endpoint":"https://api.telegram.org/bot{token}/editMessageText"},"summary":"Edit message text","description":"Edit text and game messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Required. New text of the message, 1-4096 characters after entities parsing","required":true},"chat_id":{"type":"string","description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"},"disable_web_page_preview":{"type":"boolean","description":"Optional. Disables link previews for links in this message"},"entities":{"type":"array","description":"Optional. A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the entity. Currently, can be 'mention', 'hashtag', 'cashtag', 'bot_command', 'url', 'email', 'phone_number', 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'blockquote', 'expandable_blockquote', 'code', 'pre', 'text_link', 'text_mention', 'custom_emoji', 'date_time'","required":true,"enum":["mention","hashtag","cashtag","bot_command","url","email","phone_number","bold","italic","underline","strikethrough","spoiler","blockquote","expandable_blockquote","code","pre","text_link","text_mention","custom_emoji","date_time"]},"offset":{"type":"number","description":"Offset in UTF-16 code units to the start of the entity","required":true},"length":{"type":"number","description":"Length of the entity in UTF-16 code units","required":true},"url":{"type":"string","description":"Optional. For 'text_link' only, URL that will be opened after user taps on the text"},"user":{"type":"object","description":"Optional. For 'text_mention' only, the mentioned user"},"language":{"type":"string","description":"Optional. For 'pre' only, the programming language of the entity text"},"custom_emoji_id":{"type":"string","description":"Optional. For 'custom_emoji' only, unique identifier of the custom emoji"}}}},"inline_message_id":{"type":"string","description":"Required if chat_id and message_id are not specified. Identifier of the inline message"},"message_id":{"type":"number","description":"Required if inline_message_id is not specified. Identifier of the message to edit"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the message text"},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for an inline keyboard"}}},"example":{"text":"","chat_id":"","disable_web_page_preview":"","entities":[],"inline_message_id":"","message_id":"","parse_mode":"","reply_markup":""}}}}}},"/bot{token}/editMessageCaption":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#editmessagecaption","api_endpoint":"https://api.telegram.org/bot{token}/editMessageCaption"},"summary":"Edit message caption","description":"Edit captions of messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"caption":{"type":"string","description":"Optional. New caption of the message, 0-1024 characters after entities parsing"},"caption_entities":{"type":"array","description":"Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of the entity. Currently, can be 'mention', 'hashtag', 'cashtag', 'bot_command', 'url', 'email', 'phone_number', 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'blockquote', 'expandable_blockquote', 'code', 'pre', 'text_link', 'text_mention', 'custom_emoji', 'date_time'","required":true,"enum":["mention","hashtag","cashtag","bot_command","url","email","phone_number","bold","italic","underline","strikethrough","spoiler","blockquote","expandable_blockquote","code","pre","text_link","text_mention","custom_emoji","date_time"]},"offset":{"type":"number","description":"Offset in UTF-16 code units to the start of the entity","required":true},"length":{"type":"number","description":"Length of the entity in UTF-16 code units","required":true},"url":{"type":"string","description":"Optional. For 'text_link' only, URL that will be opened after user taps on the text"},"user":{"type":"object","description":"Optional. For 'text_mention' only, the mentioned user"},"language":{"type":"string","description":"Optional. For 'pre' only, the programming language of the entity text"},"custom_emoji_id":{"type":"string","description":"Optional. For 'custom_emoji' only, unique identifier of the custom emoji"}}}},"chat_id":{"type":"string","description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"},"inline_message_id":{"type":"string","description":"Required if chat_id and message_id are not specified. Identifier of the inline message"},"message_id":{"type":"number","description":"Required if inline_message_id is not specified. Identifier of the message to edit"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the message caption"},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for an inline keyboard"}}},"example":{"caption":"","caption_entities":[],"chat_id":"","inline_message_id":"","message_id":"","parse_mode":"","reply_markup":""}}}}}},"/bot{token}/editMessageMedia":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#editmessagemedia","api_endpoint":"https://api.telegram.org/bot{token}/editMessageMedia"},"summary":"Edit message media","description":"Edit animation, audio, document, photo, or video messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"},"inline_message_id":{"type":"string","description":"Required if chat_id and message_id are not specified. Identifier of the inline message"},"media":{"type":"object","description":"Required. A JSON-serialized object for a new media content of the message","required":true,"properties":{"type":{"type":"string","description":"Type of the result. Must be 'animation', 'audio', 'document', 'photo', 'video', 'video_note', 'sticker', 'location', 'venue', or 'live_photo'","required":true,"enum":["animation","audio","document","photo","video","video_note","sticker","location","venue","live_photo"]},"media":{"type":"string","description":"File to send. Pass a file_id to send a file that exists on the Telegram servers, or an HTTP URL for Telegram to get a file from the Internet","required":true},"caption":{"type":"string","description":"Optional. Caption of the media to be sent, 0-1024 characters"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the media caption","enum":["MarkdownV2","HTML"]},"caption_entities":{"type":"array","description":"Optional. A JSON-serialized list of special entities in the caption"},"show_caption_above_media":{"type":"boolean","description":"Optional. Pass True if the caption must be shown above the message media"}}},"message_id":{"type":"number","description":"Required if inline_message_id is not specified. Identifier of the message to edit"},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for a new inline keyboard"}}},"example":{"chat_id":"","inline_message_id":"","media":{},"message_id":"","reply_markup":""}}}}}},"/bot{token}/editMessageReplyMarkup":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#editmessagereplymarkup","api_endpoint":"https://api.telegram.org/bot{token}/editMessageReplyMarkup"},"summary":"Edit message reply markup","description":"Edit only the reply markup of messages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"},"inline_message_id":{"type":"string","description":"Required if chat_id and message_id are not specified. Identifier of the inline message"},"message_id":{"type":"number","description":"Required if inline_message_id is not specified. Identifier of the message to edit"},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for an inline keyboard"}}},"example":{"chat_id":"","inline_message_id":"","message_id":"","reply_markup":""}}}}}},"/bot{token}/stopPoll":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#stoppoll","api_endpoint":"https://api.telegram.org/bot{token}/stopPoll"},"summary":"Stop poll","description":"Stop a poll which was sent by the bot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"message_id":{"type":"number","description":"Required. Identifier of the original message with the poll","required":true},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for a new message inline keyboard"}}},"example":{"chat_id":"","message_id":"","reply_markup":""}}}}}},"/bot{token}/answerInlineQuery":{"post":{"tags":["Inline Mode"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#answerinlinequery","api_endpoint":"https://api.telegram.org/bot{token}/answerInlineQuery"},"summary":"Answer inline query","description":"Send answers to an inline query","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"button":{"type":"object","description":"Optional. A JSON-serialized object describing a button to be shown above inline query results","properties":{"text":{"type":"string","description":"Label text on the button","required":true},"web_app":{"type":"object","description":"Optional. Description of the Web App that will be launched when the user presses the button"},"start_parameter":{"type":"string","description":"Optional. Deep-linking parameter for the /start message sent to the bot when the button is pressed"}}},"cache_time":{"type":"number","description":"Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300"},"inline_query_id":{"type":"string","description":"Required. Unique identifier for the answered query","required":true},"is_personal":{"type":"boolean","description":"Optional. Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query"},"next_offset":{"type":"string","description":"Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes"},"results":{"type":"array","description":"Required. A JSON-serialized array of results for the inline query. No more than 50 results per query are allowed","required":true,"items":{"type":"object"}}}},"example":{"button":{},"cache_time":"","inline_query_id":"","is_personal":"","next_offset":"","results":[]}}}}}},"/bot{token}/answerCallbackQuery":{"post":{"tags":["Inline Mode"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#answercallbackquery","api_endpoint":"https://api.telegram.org/bot{token}/answerCallbackQuery"},"summary":"Answer callback query","description":"Send answers to callback queries sent from inline keyboards","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters"},"cache_time":{"type":"number","description":"Optional. The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0"},"callback_query_id":{"type":"string","description":"Required. Unique identifier for the query to be answered","required":true},"show_alert":{"type":"boolean","description":"Optional. If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to False"},"url":{"type":"string","description":"Optional. URL that will be opened by the user's client"}}},"example":{"text":"","cache_time":"","callback_query_id":"","show_alert":"","url":""}}}}}},"/bot{token}/sendMediaGroup":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendmediagroup","api_endpoint":"https://api.telegram.org/bot{token}/sendMediaGroup"},"summary":"Send multiple media files as an album.","description":"Send album: photos, videos, documents, audio files","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional.Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional.Sends messages silently. Users will receive a notification with no sound."},"media":{"type":"string","description":"Required.A JSON-serialized array describing messages to be sent must include 2-10 items","required":true},"message_thread_id":{"type":"string","description":"Optional.Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"string","description":"Optional.Protects the contents of the sent messages from forwarding and saving"},"reply_to_message_id":{"type":"string","description":"Optional.If the messages are a reply ID of the original message"}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","media":"","message_thread_id":"","protect_content":"","reply_to_message_id":""}}}}}},"/bot{token}/getFile":{"get":{"tags":["Message"],"parameters":[{"name":"file_id","in":"query","description":"Required.File identifier to get information about","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getfile","api_endpoint":"https://api.telegram.org/bot{token}/getFile"},"summary":"Get file info","description":"Get file information, prepare for download: 20MB limit","security":[{"bearerAuth":[]}]}},"/bot{token}/getStickerSet":{"get":{"tags":["Stickers"],"parameters":[{"name":"name","in":"query","description":"Required.Name of the sticker set","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getstickerset","api_endpoint":"https://api.telegram.org/bot{token}/getStickerSet"},"summary":"Get a sticker set","description":"Retrieve sticker set; return StickerSet object","security":[{"bearerAuth":[]}]}},"/bot{token}/sendSticker":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendsticker","api_endpoint":"https://api.telegram.org/bot{token}/sendSticker"},"summary":"Send static WEBP, animated TGS, or video WEBM stickers","description":"Send stickers: .WEBP, .TGS, .WEBM; get returned Message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional.Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional.Sends the message silently.Users will receive a notification with no sound."},"message_thread_id":{"type":"string","description":"Optional.Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"protect_content":{"type":"string","description":"Optional.Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional.Additional interface options.A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional.If the message is a reply ID of the original message"},"sticker":{"type":"string","description":"Required.Sticker to send.Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a.WEBP file from the Internet or upload a new one using multipart/form-data.More information on Sending Files »","required":true}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","message_thread_id":"","protect_content":"","reply_markup":"","reply_to_message_id":"","sticker":""}}}}}},"/bot{token}/sendAudio":{"post":{"tags":["Message"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendaudio","api_endpoint":"https://api.telegram.org/bot{token}/sendAudio"},"summary":"Send audio file","description":"Send music files on Telegram: MP3, M4A, 50MB limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"string","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"audio":{"type":"string","description":"Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get an audio file from the Internet or upload a new one using multipart/form-data. More information on Sending Files","required":true},"caption":{"type":"string","description":"Optional. Audio caption 0-1024 characters after entities parsing"},"caption_entities":{"type":"string","description":"Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"string","description":"Optional. Sends the message silently. Users will receive a notification with no sound."},"duration":{"type":"string","description":"Optional. Duration of the audio in seconds"},"message_thread_id":{"type":"string","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"parse_mode":{"type":"string","description":"Optional. Mode for parsing entities in the audio caption. See formatting options for more details."},"performer":{"type":"string","description":"Optional. Performer"},"protect_content":{"type":"string","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user."},"reply_to_message_id":{"type":"string","description":"Optional. If the message is a reply ID of the original message"},"thumb":{"type":"string","description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach","enum":["","","<file_attach_name>” if the thumbnail was uploaded using multipart","form-data under <file_attach_name>. More information on Sending Files"]},"title":{"type":"string","description":"Optional. Track name"}}},"example":{"allow_sending_without_reply":"","audio":"","caption":"","caption_entities":"","chat_id":"","disable_notification":"","duration":"","message_thread_id":"","parse_mode":"","performer":"","protect_content":"","reply_markup":"","reply_to_message_id":"","thumb":"","title":""}}}}}},"/bot{token}/getCustomEmojiStickers":{"get":{"tags":["Stickers"],"parameters":[{"name":"custom_emoji_ids","in":"query","description":"Required.List of custom emoji identifiers.At most 200 custom emoji identifiers can be specified.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getcustomemojistickers","api_endpoint":"https://api.telegram.org/bot{token}/getCustomEmojiStickers"},"summary":"Get custom emoji sticker info by their identifiers","description":"Retrieve custom emoji sticker information with identifiers","security":[{"bearerAuth":[]}]}},"/bot{token}/uploadStickerFile":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#uploadstickerfile","api_endpoint":"https://api.telegram.org/bot{token}/uploadStickerFile"},"summary":"Upload sticker PNG for future use in sticker sets","description":"Upload PNG sticker for Telegram sticker sets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"png_sticker":{"type":"string","description":"Required.PNG image with the sticker must be up to 512 kilobytes in size dimensions must not exceed 512px and either width or height must be exactly 512px.More information on Sending Files","required":true},"user_id":{"type":"string","description":"Required.User identifier of sticker file owner","required":true}}},"example":{"png_sticker":"","user_id":""}}}}}},"/bot{token}/createNewStickerSet":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#createnewstickerset","api_endpoint":"https://api.telegram.org/bot{token}/createNewStickerSet"},"summary":"Make a user's new sticker set","description":"Create user-owned sticker set for bot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emojis":{"type":"string","description":"Required.One or more emoji corresponding to the sticker","required":true},"mask_position":{"type":"string","description":"Optional.A JSON-serialized object for position where the mask should be placed on faces"},"name":{"type":"string","description":"Required.Short name of sticker set to be used in t.me/addstickers/ URLs (e.g.animals).Can contain only English letters digits and underscores.Must begin with a letter can't contain consecutive underscores and must end in \"_by_<bot_username>\".<bot_username> is case insensitive.1-64 characters.","required":true},"png_sticker":{"type":"string","description":"Optional.PNG image with the sticker must be up to 512 kilobytes in size dimensions must not exceed 512px and either width or height must be exactly 512px.Pass a file_id as a String to send a file that already exists on the Telegram servers pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data.More information on Sending Files »"},"sticker_type":{"type":"string","description":"Optional.Type of stickers in the set pass “regular” or “mask”.Custom emoji sticker sets can't be created via the Bot API at the moment.By default a regular sticker set is created."},"tgs_sticker":{"type":"string","description":"Optional.TGS animation with the sticker uploaded using multipart/form-data.See https","enum":["","","core.telegram.org","stickers#animated-sticker-requirements for technical requirements"]},"title":{"type":"string","description":"Required. Sticker set title 1-64 characters","required":true},"user_id":{"type":"string","description":"Required.User identifier of created sticker set owner","required":true},"webm_sticker":{"type":"string","description":"Optional.WEBM video with the sticker uploaded using multipart/form-data. See https","enum":["","","core.telegram.org","stickers#video-sticker-requirements for technical requirements"]}}},"example":{"emojis":"","mask_position":"","name":"","png_sticker":"","sticker_type":"","tgs_sticker":"","title":"","user_id":"","webm_sticker":""}}}}}},"/bot{token}/addStickerToSet":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#addstickertoset","api_endpoint":"https://api.telegram.org/bot{token}/addStickerToSet"},"summary":"Bot creates set. Add new sticker","description":"Add new sticker to bot's set: animated/static, 50/120 limit","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emojis":{"type":"string","description":"Required.One or more emoji corresponding to the sticker","required":true},"mask_position":{"type":"string","description":"Optional.A JSON-serialized object for position where the mask should be placed on faces"},"name":{"type":"string","description":"Required.Sticker set name","required":true},"png_sticker":{"type":"string","description":"Optional.PNG image with the sticker must be up to 512 kilobytes in size dimensions must not exceed 512px and either width or height must be exactly 512px.\nPass a file_id as a String to send a file that already exists on the Telegram servers pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data.More information on Sending Files"},"tgs_sticker":{"type":"string","description":"Optional.TGS animation with the sticker uploaded using multipart/form-data.See https","enum":["","","core.telegram.org","stickers#animated-sticker-requirements for technical requirements"]},"user_id":{"type":"string","description":"Required.User identifier of sticker set owner","required":true},"webm_sticker":{"type":"string","description":"Optional. WEBM video with the sticker uploaded using multipart/form-data. See https","enum":["","","core.telegram.org","stickers#video-sticker-requirements for technical requirements"]}}},"example":{"emojis":"","mask_position":"","name":"","png_sticker":"","tgs_sticker":"","user_id":"","webm_sticker":""}}}}}},"/bot{token}/setStickerPositionInSet":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setstickerpositioninset","api_endpoint":"https://api.telegram.org/bot{token}/setStickerPositionInSet"},"summary":"Bot moves sticker to specific position in set","description":"Move bot-created sticker in set to position","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"position":{"type":"string","description":"Required.New sticker position in the set zero-based","required":true},"sticker":{"type":"string","description":"Required.File identifier of the sticker","required":true}}},"example":{"position":"","sticker":""}}}}}},"/bot{token}/deleteStickerFromSet":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#deletestickerfromset","api_endpoint":"https://api.telegram.org/bot{token}/deleteStickerFromSet"},"summary":"Remove bot-created set sticker","description":"Delete bot-created sticker","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"sticker":{"type":"string","description":"Required.File identifier of the sticker","required":true}}},"example":{"sticker":""}}}}}},"/bot{token}/setStickerSetThumb":{"post":{"tags":["Stickers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setstickersetthumbnail","api_endpoint":"https://api.telegram.org/bot{token}/setStickerSetThumb"},"summary":"Set sticker set thumbnail: animated for animations","description":"Set animated or video sticker set thumbnails easily.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Required.Sticker set name","required":true},"thumb":{"type":"string","description":"Optional.A PNG image with the thumbnail must be up to 128 kilobytes in size and have width and height exactly 100px or a TGS animation with the thumbnail up to 32 kilobytes in size; see https","enum":["","","core.telegram.org","stickers#animated-sticker-requirements for animated sticker technical requirements or a WEBM video with the thumbnail up to 32 kilobytes in size; see https"]},"user_id":{"type":"string","description":"Required.User identifier of the sticker set owner","required":true}}},"example":{"name":"","thumb":"","user_id":""}}}}}},"/bot{token}/getMe":{"get":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getme","api_endpoint":"https://api.telegram.org/bot{token}/getMe"},"summary":"Get bot details","description":"Bot authentication token test","security":[{"bearerAuth":[]}]}},"/bot{token}/logOut":{"post":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#logout","api_endpoint":"https://api.telegram.org/bot{token}/logOut"},"summary":"Logout from Cloud Bot API before running locally","description":"Logout from cloud Bot API server before launching locally","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/bot{token}/close":{"post":{"tags":["User"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#close","api_endpoint":"https://api.telegram.org/bot{token}/close"},"summary":"Close bot instance","description":"Close bot instance safely before server migration","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/bot{token}/getUserProfilePhotos":{"get":{"tags":["User"],"parameters":[{"name":"limit","in":"query","description":"Optional.Limits the number of photos to be retrieved.Values between 1-100 are accepted.Defaults to 100.","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Optional.Sequential number of the first photo to be returned.By default all photos are returned.","schema":{"type":"string","example":""}},{"name":"user_id","in":"query","description":"Required.Unique identifier of the target user","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getuserprofilephotos","api_endpoint":"https://api.telegram.org/bot{token}/getUserProfilePhotos"},"summary":"Get user profile pictures","description":"Get a list of profile pictures for a user","security":[{"bearerAuth":[]}]}},"/bot{token}/getChat":{"get":{"tags":["Chat"],"parameters":[{"name":"chat_id","in":"query","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getchat","api_endpoint":"https://api.telegram.org/bot{token}/getChat"},"summary":"Get chat","description":"Get up-to-date information about a chat","security":[{"bearerAuth":[]}]}},"/bot{token}/getChatAdministrators":{"get":{"tags":["Chat"],"parameters":[{"name":"chat_id","in":"query","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getchatadministrators","api_endpoint":"https://api.telegram.org/bot{token}/getChatAdministrators"},"summary":"Get chat administrators","description":"Get a list of administrators in a chat, excluding other bots","security":[{"bearerAuth":[]}]}},"/bot{token}/getChatMemberCount":{"get":{"tags":["Chat"],"parameters":[{"name":"chat_id","in":"query","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getchatmembercount","api_endpoint":"https://api.telegram.org/bot{token}/getChatMemberCount"},"summary":"Get chat member count","description":"Get the number of members in a chat","security":[{"bearerAuth":[]}]}},"/bot{token}/getChatMember":{"get":{"tags":["Chat"],"parameters":[{"name":"chat_id","in":"query","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)","required":true,"schema":{"type":"string","example":""}},{"name":"user_id","in":"query","description":"Required. Unique identifier of the target user","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getchatmember","api_endpoint":"https://api.telegram.org/bot{token}/getChatMember"},"summary":"Get chat member","description":"Get information about a member of a chat","security":[{"bearerAuth":[]}]}},"/bot{token}/setChatStickerSet":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setchatstickerset","api_endpoint":"https://api.telegram.org/bot{token}/setChatStickerSet"},"summary":"Set chat sticker set","description":"Set a new group sticker set for a supergroup. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)","required":true},"sticker_set_name":{"type":"string","description":"Required. Name of the sticker set to be set as the group sticker set","required":true}}},"example":{"chat_id":"","sticker_set_name":""}}}}}},"/bot{token}/deleteChatStickerSet":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#deletechatstickerset","api_endpoint":"https://api.telegram.org/bot{token}/deleteChatStickerSet"},"summary":"Delete chat sticker set","description":"Delete a group sticker set from a supergroup. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)","required":true}}},"example":{"chat_id":""}}}}}},"/bot{token}/restrictChatMember":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#restrictchatmember","api_endpoint":"https://api.telegram.org/bot{token}/restrictChatMember"},"summary":"Restrict chat member","description":"Restrict a user in a supergroup. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)","required":true},"permissions":{"type":"object","description":"Required. A JSON-serialized object for new user permissions","required":true,"properties":{"is_anonymous":{"type":"boolean","description":"Optional. True, if the user's presence in the chat is anonymous"},"has_aggressive_anti_spam_enabled":{"type":"boolean","description":"Optional. True, if the user has aggressive anti-spam enabled"},"can_manage_chat":{"type":"boolean","description":"Optional. True, if the user can manage the chat"},"can_change_info":{"type":"boolean","description":"Optional. True, if the user is allowed to change the chat title, photo and other settings"},"can_post_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to post messages in the channel"},"can_edit_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to edit messages of other users"},"can_delete_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to delete messages of other users"},"can_invite_users":{"type":"boolean","description":"Optional. True, if the user is allowed to invite new users to the chat"},"can_manage_video_chats":{"type":"boolean","description":"Optional. True, if the user is allowed to manage video chats"},"can_pin_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to pin messages"},"can_manage_topics":{"type":"boolean","description":"Optional. True, if the user is allowed to manage topics"},"can_send_polls":{"type":"boolean","description":"Optional. True, if the user is allowed to send polls"},"can_send_audios":{"type":"boolean","description":"Optional. True, if the user is allowed to send audios"},"can_send_documents":{"type":"boolean","description":"Optional. True, if the user is allowed to send documents"},"can_send_photos":{"type":"boolean","description":"Optional. True, if the user is allowed to send photos"},"can_send_videos":{"type":"boolean","description":"Optional. True, if the user is allowed to send videos"},"can_send_video_notes":{"type":"boolean","description":"Optional. True, if the user is allowed to send video notes"},"can_send_voice_notes":{"type":"boolean","description":"Optional. True, if the user is allowed to send voice notes"},"can_send_stickers":{"type":"boolean","description":"Optional. True, if the user is allowed to send stickers"},"can_send_animations":{"type":"boolean","description":"Optional. True, if the user is allowed to send animations"},"can_send_games":{"type":"boolean","description":"Optional. True, if the user is allowed to send games"},"can_use_inline_bots":{"type":"boolean","description":"Optional. True, if the user is allowed to use inline bots"},"can_add_web_page_previews":{"type":"boolean","description":"Optional. True, if the user is allowed to add web page previews"},"can_manage_tags":{"type":"boolean","description":"Optional. True, if the user is allowed to manage tags"},"can_react_to_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to react to messages"},"can_edit_tag":{"type":"boolean","description":"Optional. True, if the user can edit their own tag"}}},"until_date":{"type":"number","description":"Optional. Date when restrictions will be lifted for the user; Unix time"},"use_independent_chat_permissions":{"type":"boolean","description":"Optional. Pass True if chat permissions are set independently"},"user_id":{"type":"number","description":"Required. Unique identifier of the target user","required":true}}},"example":{"chat_id":"","permissions":{},"until_date":"","use_independent_chat_permissions":"","user_id":""}}}}}},"/bot{token}/promoteChatMember":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#promotechatmember","api_endpoint":"https://api.telegram.org/bot{token}/promoteChatMember"},"summary":"Promote chat member","description":"Promote or demote a user in a supergroup or channel. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"can_delete_stories":{"type":"boolean","description":"Optional. Pass True if the administrator can delete stories posted by other users"},"can_edit_messages":{"type":"boolean","description":"Optional. Pass True if the administrator can edit messages of other users and can pin messages; for channels only"},"can_manage_chat":{"type":"boolean","description":"Optional. Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars"},"can_manage_direct_messages":{"type":"boolean","description":"Optional. Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only"},"can_manage_topics":{"type":"boolean","description":"Optional. Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only"},"can_pin_messages":{"type":"boolean","description":"Optional. Pass True if the administrator can pin messages; for supergroups only"},"can_post_messages":{"type":"boolean","description":"Optional. Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"is_anonymous":{"type":"boolean","description":"Optional. Pass True if the administrator's presence in the chat is hidden"},"user_id":{"type":"number","description":"Required. Unique identifier of the target user","required":true}}},"example":{"can_delete_stories":"","can_edit_messages":"","can_manage_chat":"","can_manage_direct_messages":"","can_manage_topics":"","can_pin_messages":"","can_post_messages":"","chat_id":"","is_anonymous":"","user_id":""}}}}}},"/bot{token}/setChatAdministratorCustomTitle":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setchatadministratorcustomtitle","api_endpoint":"https://api.telegram.org/bot{token}/setChatAdministratorCustomTitle"},"summary":"Set chat administrator custom title","description":"Set a custom title for an administrator in a supergroup promoted by the bot","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)","required":true},"custom_title":{"type":"string","description":"Required. New custom title for the administrator; 0-16 characters, emoji are not allowed","required":true},"user_id":{"type":"number","description":"Required. Unique identifier of the target user","required":true}}},"example":{"chat_id":"","custom_title":"","user_id":""}}}}}},"/bot{token}/banChatMember":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#banchatmember","api_endpoint":"https://api.telegram.org/bot{token}/banChatMember"},"summary":"Ban chat member","description":"Ban a user in a supergroup or channel. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @supergroupusername or @channelusername)","required":true},"revoke_messages":{"type":"boolean","description":"Optional. Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before they were removed. Always True for supergroups and channels"},"until_date":{"type":"number","description":"Optional. Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time, they are considered to be banned forever"},"user_id":{"type":"number","description":"Required. Unique identifier of the target user","required":true}}},"example":{"chat_id":"","revoke_messages":"","until_date":"","user_id":""}}}}}},"/bot{token}/unbanChatMember":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#unbanchatmember","api_endpoint":"https://api.telegram.org/bot{token}/unbanChatMember"},"summary":"Unban chat member","description":"Unban a previously banned user in a supergroup or channel. The bot must be an administrator with the appropriate rights","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @supergroupusername or @channelusername)","required":true},"only_if_banned":{"type":"boolean","description":"Optional. Do nothing if the user is not banned"},"user_id":{"type":"number","description":"Required. Unique identifier of the target user","required":true}}},"example":{"chat_id":"","only_if_banned":"","user_id":""}}}}}},"/bot{token}/setChatPermissions":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setchatpermissions","api_endpoint":"https://api.telegram.org/bot{token}/setChatPermissions"},"summary":"Set chat permissions","description":"Set default chat permissions for all members. The bot must be an administrator with the can_restrict_members right","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)","required":true},"permissions":{"type":"object","description":"Required. A JSON-serialized object for new default chat permissions","required":true,"properties":{"is_anonymous":{"type":"boolean","description":"Optional. True, if the user's presence in the chat is anonymous"},"has_aggressive_anti_spam_enabled":{"type":"boolean","description":"Optional. True, if the user has aggressive anti-spam enabled"},"can_manage_chat":{"type":"boolean","description":"Optional. True, if the user can manage the chat"},"can_change_info":{"type":"boolean","description":"Optional. True, if the user is allowed to change the chat title, photo and other settings"},"can_post_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to post messages in the channel"},"can_edit_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to edit messages of other users"},"can_delete_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to delete messages of other users"},"can_invite_users":{"type":"boolean","description":"Optional. True, if the user is allowed to invite new users to the chat"},"can_manage_video_chats":{"type":"boolean","description":"Optional. True, if the user is allowed to manage video chats"},"can_pin_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to pin messages"},"can_manage_topics":{"type":"boolean","description":"Optional. True, if the user is allowed to manage topics"},"can_send_polls":{"type":"boolean","description":"Optional. True, if the user is allowed to send polls"},"can_send_audios":{"type":"boolean","description":"Optional. True, if the user is allowed to send audios"},"can_send_documents":{"type":"boolean","description":"Optional. True, if the user is allowed to send documents"},"can_send_photos":{"type":"boolean","description":"Optional. True, if the user is allowed to send photos"},"can_send_videos":{"type":"boolean","description":"Optional. True, if the user is allowed to send videos"},"can_send_video_notes":{"type":"boolean","description":"Optional. True, if the user is allowed to send video notes"},"can_send_voice_notes":{"type":"boolean","description":"Optional. True, if the user is allowed to send voice notes"},"can_send_stickers":{"type":"boolean","description":"Optional. True, if the user is allowed to send stickers"},"can_send_animations":{"type":"boolean","description":"Optional. True, if the user is allowed to send animations"},"can_send_games":{"type":"boolean","description":"Optional. True, if the user is allowed to send games"},"can_use_inline_bots":{"type":"boolean","description":"Optional. True, if the user is allowed to use inline bots"},"can_add_web_page_previews":{"type":"boolean","description":"Optional. True, if the user is allowed to add web page previews"},"can_manage_tags":{"type":"boolean","description":"Optional. True, if the user is allowed to manage tags"},"can_react_to_messages":{"type":"boolean","description":"Optional. True, if the user is allowed to react to messages"},"can_edit_tag":{"type":"boolean","description":"Optional. True, if the user can edit their own tag"}}},"use_independent_chat_permissions":{"type":"boolean","description":"Optional. Pass True if chat permissions are set independently"}}},"example":{"chat_id":"","permissions":{},"use_independent_chat_permissions":""}}}}}},"/bot{token}/setChatTitle":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setchattitle","api_endpoint":"https://api.telegram.org/bot{token}/setChatTitle"},"summary":"Set chat title","description":"Change the title of a chat","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"title":{"type":"string","description":"Required. New chat title, 1-255 characters","required":true}}},"example":{"chat_id":"","title":""}}}}}},"/bot{token}/setChatDescription":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setchatdescription","api_endpoint":"https://api.telegram.org/bot{token}/setChatDescription"},"summary":"Set chat description","description":"Update the description of a group, supergroup, or channel","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel","required":true},"description":{"type":"string","description":"Optional. New chat description, 0-255 characters"}}},"example":{"chat_id":"","description":""}}}}}},"/bot{token}/pinChatMessage":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#pinchatmessage","api_endpoint":"https://api.telegram.org/bot{token}/pinChatMessage"},"summary":"Pin chat message","description":"Pin a message in a chat","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"disable_notification":{"type":"boolean","description":"Optional. Pass True to avoid sending a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats"},"message_id":{"type":"number","description":"Required. Identifier of the message to pin","required":true}}},"example":{"chat_id":"","disable_notification":"","message_id":""}}}}}},"/bot{token}/unpinChatMessage":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#unpinchatmessage","api_endpoint":"https://api.telegram.org/bot{token}/unpinChatMessage"},"summary":"Unpin chat message","description":"Remove a message from the list of pinned messages in a chat","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"message_id":{"type":"number","description":"Optional. Identifier of the message to unpin. If not specified, the most recent pinned message will be unpinned"}}},"example":{"chat_id":"","message_id":""}}}}}},"/bot{token}/unpinAllChatMessages":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#unpinallchatmessages","api_endpoint":"https://api.telegram.org/bot{token}/unpinAllChatMessages"},"summary":"Unpin all chat messages","description":"Clear the list of pinned messages in a chat","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true}}},"example":{"chat_id":""}}}}}},"/bot{token}/leaveChat":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#leavechat","api_endpoint":"https://api.telegram.org/bot{token}/leaveChat"},"summary":"Leave chat","description":"Instruct the bot to leave a group, supergroup, or channel","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @supergroupusername or @channelusername)","required":true}}},"example":{"chat_id":""}}}}}},"/bot{token}/sendInvoice":{"post":{"tags":["Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendinvoice","api_endpoint":"https://api.telegram.org/bot{token}/sendInvoice"},"summary":"Send invoice","description":"Send invoices to users","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"boolean","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"string","description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)","required":true},"currency":{"type":"string","description":"Required. Three-letter ISO 4217 currency code","required":true},"description":{"type":"string","description":"Required. Product description, 1-255 characters","required":true},"disable_notification":{"type":"boolean","description":"Optional. Sends the message silently. Users will receive a notification with no sound"},"is_flexible":{"type":"boolean","description":"Optional. Pass True if the final price depends on the shipping method"},"max_tip_amount":{"type":"number","description":"Optional. The maximum accepted amount for tips in the smallest units of the currency"},"message_thread_id":{"type":"number","description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"},"need_email":{"type":"boolean","description":"Optional. Pass True if you require the user's email address to complete the order"},"need_name":{"type":"boolean","description":"Optional. Pass True if you require the user's full name to complete the order"},"need_phone_number":{"type":"boolean","description":"Optional. Pass True if you require the user's phone number to complete the order"},"need_shipping_address":{"type":"boolean","description":"Optional. Pass True if you require the user's shipping address to complete the order"},"payload":{"type":"string","description":"Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes","required":true},"photo_height":{"type":"number","description":"Optional. Photo height"},"photo_size":{"type":"number","description":"Optional. Photo size in bytes"},"photo_url":{"type":"string","description":"Optional. URL of the product photo for the invoice"},"photo_width":{"type":"number","description":"Optional. Photo width"},"prices":{"type":"array","description":"Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)","required":true,"items":{"type":"object","properties":{"label":{"type":"string","description":"Portion label","required":true},"amount":{"type":"number","description":"Price of the product in the smallest units of the currency","required":true}}}},"protect_content":{"type":"boolean","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"provider_data":{"type":"string","description":"Optional. JSON-encoded data about the invoice, which will be shared with the payment provider"},"provider_token":{"type":"string","description":"Required. Payments provider token, obtained via BotFather","required":true},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for an inline keyboard"},"reply_to_message_id":{"type":"number","description":"Optional. If the message is a reply, ID of the original message"},"send_email_to_provider":{"type":"boolean","description":"Optional. Pass True if the user's email address should be sent to the provider"},"send_phone_number_to_provider":{"type":"boolean","description":"Optional. Pass True if the user's phone number should be sent to the provider"},"start_parameter":{"type":"string","description":"Optional. Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice"},"suggested_tip_amounts":{"type":"array","description":"Optional. A JSON-serialized array of suggested amounts of tips in the smallest units of the currency","items":{"type":"number"}},"title":{"type":"string","description":"Required. Product name, 1-32 characters","required":true}}},"example":{"allow_sending_without_reply":"","chat_id":"","currency":"","description":"","disable_notification":"","is_flexible":"","max_tip_amount":"","message_thread_id":"","need_email":"","need_name":"","need_phone_number":"","need_shipping_address":"","payload":"","photo_height":"","photo_size":"","photo_url":"","photo_width":"","prices":[],"protect_content":"","provider_data":"","provider_token":"","reply_markup":"","reply_to_message_id":"","send_email_to_provider":"","send_phone_number_to_provider":"","start_parameter":"","suggested_tip_amounts":[],"title":""}}}}}},"/bot{token}/answerShippingQuery":{"post":{"tags":["Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#answershippingquery","api_endpoint":"https://api.telegram.org/bot{token}/answerShippingQuery"},"summary":"Answer shipping query","description":"Respond to shipping queries sent by Telegram when the user enters their shipping address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"error_message":{"type":"string","description":"Required if ok is False. Error message in human-readable form explaining why delivery is not possible"},"ok":{"type":"boolean","description":"Required. Pass True if delivery to the specified address is possible; otherwise, pass False","required":true},"shipping_options":{"type":"array","description":"Required if ok is True. A JSON-serialized array of available shipping options","items":{"type":"object","properties":{"id":{"type":"string","description":"Shipping option identifier","required":true},"title":{"type":"string","description":"Option title","required":true},"prices":{"type":"array","description":"List of price portions","required":true}}}},"shipping_query_id":{"type":"string","description":"Required. Unique identifier for the query to be answered","required":true}}},"example":{"error_message":"","ok":"","shipping_options":[],"shipping_query_id":""}}}}}},"/bot{token}/answerPreCheckoutQuery":{"post":{"tags":["Payments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#answerprecheckoutquery","api_endpoint":"https://api.telegram.org/bot{token}/answerPreCheckoutQuery"},"summary":"Answer pre-checkout query","description":"Respond to pre-checkout queries sent by Telegram after the user confirms their payment and shipping details","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"error_message":{"type":"string","description":"Required if ok is False. Error message in human-readable form explaining the reason for failure to proceed with the checkout"},"ok":{"type":"boolean","description":"Required. Specify True if everything is alright and the bot is ready to proceed with the order; otherwise, specify False","required":true},"pre_checkout_query_id":{"type":"string","description":"Required. Unique identifier for the query to be answered","required":true}}},"example":{"error_message":"","ok":"","pre_checkout_query_id":""}}}}}},"/bot{token}/sendGame":{"post":{"tags":["Games"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#sendgame","api_endpoint":"https://api.telegram.org/bot{token}/sendGame"},"summary":"Send game","description":"Send a game to a user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allow_sending_without_reply":{"type":"boolean","description":"Optional. Pass True if the message should be sent even if the specified replied-to message is not found"},"chat_id":{"type":"number","description":"Required. Unique identifier for the target chat","required":true},"disable_notification":{"type":"boolean","description":"Optional. Sends the message silently. Users will receive a notification with no sound"},"game_short_name":{"type":"string","description":"Required. Short name of the game, serves as the unique identifier for the game","required":true},"protect_content":{"type":"boolean","description":"Optional. Protects the contents of the sent message from forwarding and saving"},"reply_markup":{"type":"string","description":"Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game"},"reply_to_message_id":{"type":"number","description":"Optional. If the message is a reply, ID of the original message"}}},"example":{"allow_sending_without_reply":"","chat_id":"","disable_notification":"","game_short_name":"","protect_content":"","reply_markup":"","reply_to_message_id":""}}}}}},"/bot{token}/setGameScore":{"post":{"tags":["Games"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setgamescore","api_endpoint":"https://api.telegram.org/bot{token}/setGameScore"},"summary":"Set game score","description":"Set the score of the specified user in a game","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"chat_id":{"type":"number","description":"Required if inline_message_id is not specified. Unique identifier for the target chat"},"disable_edit_message":{"type":"boolean","description":"Optional. Pass True if the game message should not be automatically edited to include the current scoreboard"},"force":{"type":"boolean","description":"Optional. Pass True if the high score is allowed to decrease"},"inline_message_id":{"type":"string","description":"Required if chat_id and message_id are not specified. Identifier of the inline message"},"message_id":{"type":"number","description":"Required if inline_message_id is not specified. Identifier of the sent message"},"score":{"type":"number","description":"Required. New score, must be non-negative","required":true},"user_id":{"type":"number","description":"Required. User identifier","required":true}}},"example":{"chat_id":"","disable_edit_message":"","force":"","inline_message_id":"","message_id":"","score":"","user_id":""}}}}}},"/bot{token}/getGameHighScores":{"get":{"tags":["Games"],"parameters":[{"name":"chat_id","in":"query","description":"Required if inline_message_id is not specified. Unique identifier for the target chat","schema":{"type":"number","example":""}},{"name":"inline_message_id","in":"query","description":"Required if chat_id and message_id are not specified. Identifier of the inline message","schema":{"type":"string","example":""}},{"name":"message_id","in":"query","description":"Required if inline_message_id is not specified. Identifier of the sent message","schema":{"type":"number","example":""}},{"name":"user_id","in":"query","description":"Required. Target user id","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#getgamehighscores","api_endpoint":"https://api.telegram.org/bot{token}/getGameHighScores"},"summary":"Get game high scores","description":"Get data for high score tables","security":[{"bearerAuth":[]}]}},"/bot{token}/setPassportDataErrors":{"post":{"tags":["Telegram Passport"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://core.telegram.org/bots/api#setpassportdataerrors","api_endpoint":"https://api.telegram.org/bot{token}/setPassportDataErrors"},"summary":"Set passport data errors","description":"Inform a user that some of the Telegram Passport elements they provided contain errors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"errors":{"type":"array","description":"Required. A JSON-serialized array describing the errors","required":true,"items":{"type":"object","properties":{"source":{"type":"string","description":"Error source, one of 'data', 'front_side', 'reverse_side', 'selfie', 'file', 'files', 'translation_file', 'translation_files', 'unspecified'","required":true,"enum":["data","front_side","reverse_side","selfie","file","files","translation_file","translation_files","unspecified"]},"type":{"type":"string","description":"The section of the user's Telegram Passport which has the error","required":true},"message":{"type":"string","description":"Error message","required":true},"field_name":{"type":"string","description":"Optional. For 'data' source only, name of the field with error"},"file_hash":{"type":"string","description":"Optional. For 'file'/'front_side'/'reverse_side'/'selfie'/'translation_file' source only, base64-encoded file hash"},"file_hashes":{"type":"array","description":"Optional. For 'files'/'translation_files' source only, list of base64-encoded file hashes"}}}},"user_id":{"type":"number","description":"Required. User identifier","required":true}}},"example":{"errors":[],"user_id":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}