davtur19
/
telegram-bot-api-versions
mirror of https://github.com/sys-001/telegram-bot-api-versions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
telegram-bot-api-versions/files/postman/v460.json

3439 lines
166 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"info": {
"name": "Telegram Bot API",
"description": "Auto-generated Postman collection by TGScraper.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"version": "4.6.0"
},
"variable": {
"key": "token",
"description": "Bot's unique authentication token, given by @BotFather.",
"type": "string",
"value": "1234:AAbbcc"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"disabled": true,
"description": "Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.",
"type": "text"
},
{
"key": "limit",
"disabled": true,
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text",
"value": "100"
},
{
"key": "timeout",
"disabled": true,
"description": "Optional. 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.",
"type": "text"
},
{
"key": "allowed_updates",
"disabled": true,
"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 updates regardless of type (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.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getUpdates",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getUpdates"
]
},
"description": "Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned."
}
},
{
"name": "setWebhook",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "url",
"disabled": false,
"description": "Required. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"disabled": true,
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"type": "text"
},
{
"key": "max_connections",
"disabled": true,
"description": "Optional. 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.",
"type": "text",
"value": "40"
},
{
"key": "allowed_updates",
"disabled": true,
"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 updates regardless of type (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.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setWebhook",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setWebhook"
]
},
"description": "Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us."
}
},
{
"name": "deleteWebhook",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": []
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/deleteWebhook",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"deleteWebhook"
]
},
"description": "Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters."
}
},
{
"name": "getWebhookInfo",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": []
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getWebhookInfo",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getWebhookInfo"
]
},
"description": "Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty."
}
},
{
"name": "getMe",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": []
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getMe",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getMe"
]
},
"description": "A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object."
}
},
{
"name": "sendMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "text",
"disabled": false,
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"disabled": true,
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendMessage"
]
},
"description": "Use this method to send text messages. On success, the sent Message is returned."
}
},
{
"name": "forwardMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "from_chat_id",
"disabled": false,
"description": "Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "message_id",
"disabled": false,
"description": "Required. Message identifier in the chat specified in from_chat_id",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/forwardMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"forwardMessage"
]
},
"description": "Use this method to forward messages of any kind. On success, the sent Message is returned."
}
},
{
"name": "sendPhoto",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"disabled": false,
"description": "Required. 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. More info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendPhoto",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendPhoto"
]
},
"description": "Use this method to send photos. On success, the sent Message is returned."
}
},
{
"name": "sendAudio",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "audio",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Audio caption, 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "duration",
"disabled": true,
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"disabled": true,
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"disabled": true,
"description": "Optional. Track name",
"type": "text"
},
{
"key": "thumb",
"disabled": true,
"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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendAudio",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendAudio"
]
},
"description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "document",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "thumb",
"disabled": true,
"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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Document caption (may also be used when resending documents by file_id), 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendDocument",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendDocument"
]
},
"description": "Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendVideo",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "duration",
"disabled": true,
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "width",
"disabled": true,
"description": "Optional. Video width",
"type": "text"
},
{
"key": "height",
"disabled": true,
"description": "Optional. Video height",
"type": "text"
},
{
"key": "thumb",
"disabled": true,
"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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "supports_streaming",
"disabled": true,
"description": "Optional. Pass True, if the uploaded video is suitable for streaming",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendVideo",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVideo"
]
},
"description": "Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendAnimation",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "animation",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "duration",
"disabled": true,
"description": "Optional. Duration of sent animation in seconds",
"type": "text"
},
{
"key": "width",
"disabled": true,
"description": "Optional. Animation width",
"type": "text"
},
{
"key": "height",
"disabled": true,
"description": "Optional. Animation height",
"type": "text"
},
{
"key": "thumb",
"disabled": true,
"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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Animation caption (may also be used when resending animation by file_id), 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendAnimation",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendAnimation"
]
},
"description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "voice",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Voice message caption, 0-1024 characters",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "duration",
"disabled": true,
"description": "Optional. Duration of the voice message in seconds",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendVideoNote",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video_note",
"disabled": false,
"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 info on Sending Files ». Sending video notes by a URL is currently unsupported",
"type": "text"
},
{
"key": "duration",
"disabled": true,
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "length",
"disabled": true,
"description": "Optional. Video width and height, i.e. diameter of the video message",
"type": "text"
},
{
"key": "thumb",
"disabled": true,
"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://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendVideoNote",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVideoNote"
]
},
"description": "As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned."
}
},
{
"name": "sendMediaGroup",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "media",
"disabled": false,
"description": "Required. A JSON-serialized array describing photos and videos to be sent, must include 2–10 items",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the messages silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the messages are a reply, ID of the original message",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendMediaGroup",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendMediaGroup"
]
},
"description": "Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned."
}
},
{
"name": "sendLocation",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"disabled": false,
"description": "Required. Latitude of the location",
"type": "text"
},
{
"key": "longitude",
"disabled": false,
"description": "Required. Longitude of the location",
"type": "text"
},
{
"key": "live_period",
"disabled": true,
"description": "Optional. Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendLocation",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendLocation"
]
},
"description": "Use this method to send point on the map. On success, the sent Message is returned."
}
},
{
"name": "editMessageLiveLocation",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "latitude",
"disabled": false,
"description": "Required. Latitude of new location",
"type": "text"
},
{
"key": "longitude",
"disabled": false,
"description": "Required. Longitude of new location",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for a new inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/editMessageLiveLocation",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"editMessageLiveLocation"
]
},
"description": "Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned."
}
},
{
"name": "stopMessageLiveLocation",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message with live location to stop",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for a new inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/stopMessageLiveLocation",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"stopMessageLiveLocation"
]
},
"description": "Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned."
}
},
{
"name": "sendVenue",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"disabled": false,
"description": "Required. Latitude of the venue",
"type": "text"
},
{
"key": "longitude",
"disabled": false,
"description": "Required. Longitude of the venue",
"type": "text"
},
{
"key": "title",
"disabled": false,
"description": "Required. Name of the venue",
"type": "text"
},
{
"key": "address",
"disabled": false,
"description": "Required. Address of the venue",
"type": "text"
},
{
"key": "foursquare_id",
"disabled": true,
"description": "Optional. Foursquare identifier of the venue",
"type": "text"
},
{
"key": "foursquare_type",
"disabled": true,
"description": "Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendVenue",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVenue"
]
},
"description": "Use this method to send information about a venue. On success, the sent Message is returned."
}
},
{
"name": "sendContact",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "phone_number",
"disabled": false,
"description": "Required. Contact's phone number",
"type": "text"
},
{
"key": "first_name",
"disabled": false,
"description": "Required. Contact's first name",
"type": "text"
},
{
"key": "last_name",
"disabled": true,
"description": "Optional. Contact's last name",
"type": "text"
},
{
"key": "vcard",
"disabled": true,
"description": "Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendContact",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendContact"
]
},
"description": "Use this method to send phone contacts. On success, the sent Message is returned."
}
},
{
"name": "sendPoll",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "question",
"disabled": false,
"description": "Required. Poll question, 1-255 characters",
"type": "text"
},
{
"key": "options",
"disabled": false,
"description": "Required. A JSON-serialized list of answer options, 2-10 strings 1-100 characters each",
"type": "text"
},
{
"key": "is_anonymous",
"disabled": true,
"description": "Optional. True, if the poll needs to be anonymous, defaults to True",
"type": "text",
"value": "1"
},
{
"key": "type",
"disabled": true,
"description": "Optional. Poll type, “quiz” or “regular”, defaults to “regular”",
"type": "text",
"value": "regular"
},
{
"key": "allows_multiple_answers",
"disabled": true,
"description": "Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False",
"type": "text"
},
{
"key": "correct_option_id",
"disabled": true,
"description": "Optional. 0-based identifier of the correct answer option, required for polls in quiz mode",
"type": "text"
},
{
"key": "is_closed",
"disabled": true,
"description": "Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendPoll",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendPoll"
]
},
"description": "Use this method to send a native poll. On success, the sent Message is returned."
}
},
{
"name": "sendChatAction",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "action",
"disabled": false,
"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_audio or upload_audio for audio files, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendChatAction",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendChatAction"
]
},
"description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive."
}
},
{
"name": "getUserProfilePhotos",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"disabled": true,
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"disabled": true,
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text",
"value": "100"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getUserProfilePhotos",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getUserProfilePhotos"
]
},
"description": "Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"disabled": false,
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
},
{
"name": "kickChatMember",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "until_date",
"disabled": true,
"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",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/kickChatMember",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"kickChatMember"
]
},
"description": "Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success."
}
},
{
"name": "unbanChatMember",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target group or username of the target supergroup or channel (in the format @username)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/unbanChatMember",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"unbanChatMember"
]
},
"description": "Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success."
}
},
{
"name": "restrictChatMember",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "permissions",
"disabled": false,
"description": "Required. New user permissions",
"type": "text"
},
{
"key": "until_date",
"disabled": true,
"description": "Optional. Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/restrictChatMember",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"restrictChatMember"
]
},
"description": "Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success."
}
},
{
"name": "promoteChatMember",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "can_change_info",
"disabled": true,
"description": "Optional. Pass True, if the administrator can change chat title, photo and other settings",
"type": "text"
},
{
"key": "can_post_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can create channel posts, channels only",
"type": "text"
},
{
"key": "can_edit_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can edit messages of other users and can pin messages, channels only",
"type": "text"
},
{
"key": "can_delete_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can delete messages of other users",
"type": "text"
},
{
"key": "can_invite_users",
"disabled": true,
"description": "Optional. Pass True, if the administrator can invite new users to the chat",
"type": "text"
},
{
"key": "can_restrict_members",
"disabled": true,
"description": "Optional. Pass True, if the administrator can restrict, ban or unban chat members",
"type": "text"
},
{
"key": "can_pin_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can pin messages, supergroups only",
"type": "text"
},
{
"key": "can_promote_members",
"disabled": true,
"description": "Optional. Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/promoteChatMember",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"promoteChatMember"
]
},
"description": "Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success."
}
},
{
"name": "setChatAdministratorCustomTitle",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "custom_title",
"disabled": false,
"description": "Required. New custom title for the administrator; 0-16 characters, emoji are not allowed",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatAdministratorCustomTitle",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatAdministratorCustomTitle"
]
},
"description": "Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success."
}
},
{
"name": "setChatPermissions",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type": "text"
},
{
"key": "permissions",
"disabled": false,
"description": "Required. New default chat permissions",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatPermissions",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatPermissions"
]
},
"description": "Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. Returns True on success."
}
},
{
"name": "exportChatInviteLink",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/exportChatInviteLink",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"exportChatInviteLink"
]
},
"description": "Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success."
}
},
{
"name": "setChatPhoto",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"disabled": false,
"description": "Required. New chat photo, uploaded using multipart/form-data",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatPhoto",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatPhoto"
]
},
"description": "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success."
}
},
{
"name": "deleteChatPhoto",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/deleteChatPhoto",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"deleteChatPhoto"
]
},
"description": "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success."
}
},
{
"name": "setChatTitle",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "title",
"disabled": false,
"description": "Required. New chat title, 1-255 characters",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatTitle",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatTitle"
]
},
"description": "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success."
}
},
{
"name": "setChatDescription",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "description",
"disabled": true,
"description": "Optional. New chat description, 0-255 characters",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatDescription",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatDescription"
]
},
"description": "Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success."
}
},
{
"name": "pinChatMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": false,
"description": "Required. Identifier of a message to pin",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/pinChatMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"pinChatMessage"
]
},
"description": "Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success."
}
},
{
"name": "unpinChatMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/unpinChatMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"unpinChatMessage"
]
},
"description": "Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success."
}
},
{
"name": "leaveChat",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/leaveChat",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"leaveChat"
]
},
"description": "Use this method for your bot to leave a group, supergroup or channel. Returns True on success."
}
},
{
"name": "getChat",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getChat",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getChat"
]
},
"description": "Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success."
}
},
{
"name": "getChatAdministrators",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getChatAdministrators",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getChatAdministrators"
]
},
"description": "Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned."
}
},
{
"name": "getChatMembersCount",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getChatMembersCount",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getChatMembersCount"
]
},
"description": "Use this method to get the number of members in a chat. Returns Int on success."
}
},
{
"name": "getChatMember",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getChatMember",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getChatMember"
]
},
"description": "Use this method to get information about a member of a chat. Returns a ChatMember object on success."
}
},
{
"name": "setChatStickerSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type": "text"
},
{
"key": "sticker_set_name",
"disabled": false,
"description": "Required. Name of the sticker set to be set as the group sticker set",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setChatStickerSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setChatStickerSet"
]
},
"description": "Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success."
}
},
{
"name": "deleteChatStickerSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/deleteChatStickerSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"deleteChatStickerSet"
]
},
"description": "Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success."
}
},
{
"name": "answerCallbackQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "callback_query_id",
"disabled": false,
"description": "Required. Unique identifier for the query to be answered",
"type": "text"
},
{
"key": "text",
"disabled": true,
"description": "Optional. Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters",
"type": "text"
},
{
"key": "show_alert",
"disabled": true,
"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.",
"type": "text"
},
{
"key": "url",
"disabled": true,
"description": "Optional. URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.",
"type": "text"
},
{
"key": "cache_time",
"disabled": true,
"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.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerCallbackQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerCallbackQuery"
]
},
"description": "Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned."
}
},
{
"name": "editMessageText",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "text",
"disabled": false,
"description": "Required. New text of the message",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"disabled": true,
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for an inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/editMessageText",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"editMessageText"
]
},
"description": "Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned."
}
},
{
"name": "editMessageCaption",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. New caption of the message",
"type": "text"
},
{
"key": "parse_mode",
"disabled": true,
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for an inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/editMessageCaption",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"editMessageCaption"
]
},
"description": "Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned."
}
},
{
"name": "editMessageMedia",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "media",
"disabled": false,
"description": "Required. A JSON-serialized object for a new media content of the message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for a new inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/editMessageMedia",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"editMessageMedia"
]
},
"description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned."
}
},
{
"name": "editMessageReplyMarkup",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for an inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/editMessageReplyMarkup",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"editMessageReplyMarkup"
]
},
"description": "Use this method to edit only the reply markup of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned."
}
},
{
"name": "stopPoll",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": false,
"description": "Required. Identifier of the original message with the poll",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for a new message inline keyboard.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/stopPoll",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"stopPoll"
]
},
"description": "Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned."
}
},
{
"name": "deleteMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"disabled": false,
"description": "Required. Identifier of the message to delete",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/deleteMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"deleteMessage"
]
},
"description": "Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- Bots can delete outgoing messages in private chats, groups, and supergroups.- Bots can delete incoming messages in private chats.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.Returns True on success."
}
},
{
"name": "sendSticker",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "sticker",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendSticker",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendSticker"
]
},
"description": "Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned."
}
},
{
"name": "getStickerSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"disabled": false,
"description": "Required. Name of the sticker set",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getStickerSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getStickerSet"
]
},
"description": "Use this method to get a sticker set. On success, a StickerSet object is returned."
}
},
{
"name": "uploadStickerFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. User identifier of sticker file owner",
"type": "text"
},
{
"key": "png_sticker",
"disabled": false,
"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 info on Sending Files »",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/uploadStickerFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"uploadStickerFile"
]
},
"description": "Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success."
}
},
{
"name": "createNewStickerSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. User identifier of created sticker set owner",
"type": "text"
},
{
"key": "name",
"disabled": false,
"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.",
"type": "text"
},
{
"key": "title",
"disabled": false,
"description": "Required. Sticker set title, 1-64 characters",
"type": "text"
},
{
"key": "png_sticker",
"disabled": false,
"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. 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 info on Sending Files »",
"type": "text"
},
{
"key": "emojis",
"disabled": false,
"description": "Required. One or more emoji corresponding to the sticker",
"type": "text"
},
{
"key": "contains_masks",
"disabled": true,
"description": "Optional. Pass True, if a set of mask stickers should be created",
"type": "text"
},
{
"key": "mask_position",
"disabled": true,
"description": "Optional. A JSON-serialized object for position where the mask should be placed on faces",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/createNewStickerSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"createNewStickerSet"
]
},
"description": "Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success."
}
},
{
"name": "addStickerToSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. User identifier of sticker set owner",
"type": "text"
},
{
"key": "name",
"disabled": false,
"description": "Required. Sticker set name",
"type": "text"
},
{
"key": "png_sticker",
"disabled": false,
"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. 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 info on Sending Files »",
"type": "text"
},
{
"key": "emojis",
"disabled": false,
"description": "Required. One or more emoji corresponding to the sticker",
"type": "text"
},
{
"key": "mask_position",
"disabled": true,
"description": "Optional. A JSON-serialized object for position where the mask should be placed on faces",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/addStickerToSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"addStickerToSet"
]
},
"description": "Use this method to add a new sticker to a set created by the bot. Returns True on success."
}
},
{
"name": "setStickerPositionInSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sticker",
"disabled": false,
"description": "Required. File identifier of the sticker",
"type": "text"
},
{
"key": "position",
"disabled": false,
"description": "Required. New sticker position in the set, zero-based",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setStickerPositionInSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setStickerPositionInSet"
]
},
"description": "Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success."
}
},
{
"name": "deleteStickerFromSet",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "sticker",
"disabled": false,
"description": "Required. File identifier of the sticker",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/deleteStickerFromSet",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"deleteStickerFromSet"
]
},
"description": "Use this method to delete a sticker from a set created by the bot. Returns True on success."
}
},
{
"name": "answerInlineQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "inline_query_id",
"disabled": false,
"description": "Required. Unique identifier for the answered query",
"type": "text"
},
{
"key": "results",
"disabled": false,
"description": "Required. A JSON-serialized array of results for the inline query",
"type": "text"
},
{
"key": "cache_time",
"disabled": true,
"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.",
"type": "text",
"value": "300"
},
{
"key": "is_personal",
"disabled": true,
"description": "Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"type": "text"
},
{
"key": "next_offset",
"disabled": true,
"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.",
"type": "text"
},
{
"key": "switch_pm_text",
"disabled": true,
"description": "Optional. If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter",
"type": "text"
},
{
"key": "switch_pm_parameter",
"disabled": true,
"description": "Optional. Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerInlineQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerInlineQuery"
]
},
"description": "Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed."
}
},
{
"name": "sendInvoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target private chat",
"type": "text"
},
{
"key": "title",
"disabled": false,
"description": "Required. Product name, 1-32 characters",
"type": "text"
},
{
"key": "description",
"disabled": false,
"description": "Required. Product description, 1-255 characters",
"type": "text"
},
{
"key": "payload",
"disabled": false,
"description": "Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
"type": "text"
},
{
"key": "provider_token",
"disabled": false,
"description": "Required. Payments provider token, obtained via Botfather",
"type": "text"
},
{
"key": "start_parameter",
"disabled": false,
"description": "Required. Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter",
"type": "text"
},
{
"key": "currency",
"disabled": false,
"description": "Required. Three-letter ISO 4217 currency code, see more on currencies",
"type": "text"
},
{
"key": "prices",
"disabled": false,
"description": "Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
"type": "text"
},
{
"key": "provider_data",
"disabled": true,
"description": "Optional. JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.",
"type": "text"
},
{
"key": "photo_url",
"disabled": true,
"description": "Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.",
"type": "text"
},
{
"key": "photo_size",
"disabled": true,
"description": "Optional. Photo size",
"type": "text"
},
{
"key": "photo_width",
"disabled": true,
"description": "Optional. Photo width",
"type": "text"
},
{
"key": "photo_height",
"disabled": true,
"description": "Optional. Photo height",
"type": "text"
},
{
"key": "need_name",
"disabled": true,
"description": "Optional. Pass True, if you require the user's full name to complete the order",
"type": "text"
},
{
"key": "need_phone_number",
"disabled": true,
"description": "Optional. Pass True, if you require the user's phone number to complete the order",
"type": "text"
},
{
"key": "need_email",
"disabled": true,
"description": "Optional. Pass True, if you require the user's email address to complete the order",
"type": "text"
},
{
"key": "need_shipping_address",
"disabled": true,
"description": "Optional. Pass True, if you require the user's shipping address to complete the order",
"type": "text"
},
{
"key": "send_phone_number_to_provider",
"disabled": true,
"description": "Optional. Pass True, if user's phone number should be sent to provider",
"type": "text"
},
{
"key": "send_email_to_provider",
"disabled": true,
"description": "Optional. Pass True, if user's email address should be sent to provider",
"type": "text"
},
{
"key": "is_flexible",
"disabled": true,
"description": "Optional. Pass True, if the final price depends on the shipping method",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendInvoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendInvoice"
]
},
"description": "Use this method to send invoices. On success, the sent Message is returned."
}
},
{
"name": "answerShippingQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "shipping_query_id",
"disabled": false,
"description": "Required. Unique identifier for the query to be answered",
"type": "text"
},
{
"key": "ok",
"disabled": false,
"description": "Required. Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)",
"type": "text"
},
{
"key": "shipping_options",
"disabled": true,
"description": "Optional. Required if ok is True. A JSON-serialized array of available shipping options.",
"type": "text"
},
{
"key": "error_message",
"disabled": true,
"description": "Optional. Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. \"Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerShippingQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerShippingQuery"
]
},
"description": "If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned."
}
},
{
"name": "answerPreCheckoutQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "pre_checkout_query_id",
"disabled": false,
"description": "Required. Unique identifier for the query to be answered",
"type": "text"
},
{
"key": "ok",
"disabled": false,
"description": "Required. Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.",
"type": "text"
},
{
"key": "error_message",
"disabled": true,
"description": "Optional. Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. \"Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!\"). Telegram will display this message to the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerPreCheckoutQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerPreCheckoutQuery"
]
},
"description": "Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent."
}
},
{
"name": "setPassportDataErrors",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. User identifier",
"type": "text"
},
{
"key": "errors",
"disabled": false,
"description": "Required. A JSON-serialized array describing the errors",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setPassportDataErrors",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setPassportDataErrors"
]
},
"description": "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues."
}
},
{
"name": "sendGame",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the target chat",
"type": "text"
},
{
"key": "game_short_name",
"disabled": false,
"description": "Required. Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Sends the message silently. Users will receive a notification with no sound.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendGame",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendGame"
]
},
"description": "Use this method to send a game. On success, the sent Message is returned."
}
},
{
"name": "setGameScore",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. User identifier",
"type": "text"
},
{
"key": "score",
"disabled": false,
"description": "Required. New score, must be non-negative",
"type": "text"
},
{
"key": "force",
"disabled": true,
"description": "Optional. Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters",
"type": "text"
},
{
"key": "disable_edit_message",
"disabled": true,
"description": "Optional. Pass True, if the game message should not be automatically edited to include the current scoreboard",
"type": "text"
},
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the sent message",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setGameScore",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setGameScore"
]
},
"description": "Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False."
}
},
{
"name": "getGameHighScores",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. Target user id",
"type": "text"
},
{
"key": "chat_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Unique identifier for the target chat",
"type": "text"
},
{
"key": "message_id",
"disabled": true,
"description": "Optional. Required if inline_message_id is not specified. Identifier of the sent message",
"type": "text"
},
{
"key": "inline_message_id",
"disabled": true,
"description": "Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getGameHighScores",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getGameHighScores"
]
},
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects."
}
}
]
}
Reference in New Issue View Git Blame Copy Permalink