davtur19/tgscraper
1
0
Fork 0
mirror of https://github.com/Sysbot-org/tgscraper.git synced 2024-06-01 19:06:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

deploy: bcaa0f7f13

Browse Source
This commit is contained in:
sys-001 2022-06-21 09:31:09 +00:00
parent d86ddbd07e
commit d08b04c111
5 changed files with 1335 additions and 245 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

404
schemas/botapi.json
View File

@ -1,5 +1,5 @@
{
"version": "6.0.0",
"version": "6.1.0",
"types": [
{
"name": "Update",
@ -11,7 +11,7 @@
"int"
],
"optional": false,
"description": "The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially."
"description": "The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially."
},
{
"name": "message",
@ -19,7 +19,7 @@
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
"description": "Optional. New incoming message of any kind - text, photo, sticker, etc."
},
{
"name": "edited_message",
@ -35,7 +35,7 @@
"Message"
],
"optional": true,
"description": "Optional. New incoming channel post of any kind — text, photo, sticker, etc."
"description": "Optional. New incoming channel post of any kind - text, photo, sticker, etc."
},
{
"name": "edited_channel_post",
@ -130,7 +130,7 @@
},
{
"name": "WebhookInfo",
"description": "Contains information about the current status of a webhook.",
"description": "Describes the current status of a webhook.",
"fields": [
{
"name": "url",
@ -194,7 +194,7 @@
"int"
],
"optional": true,
"description": "Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery"
"description": "Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery"
},
{
"name": "allowed_updates",
@ -259,6 +259,24 @@
"optional": true,
"description": "Optional. IETF language tag of the user's language"
},
{
"name": "is_premium",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if this user is a Telegram Premium user",
"default": true
},
{
"name": "added_to_attachment_menu",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if this user added the bot to the attachment menu",
"default": true
},
{
"name": "can_join_groups",
"types": [
@ -363,6 +381,24 @@
"description": "Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.",
"default": true
},
{
"name": "join_to_send_messages",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.",
"default": true
},
{
"name": "join_by_request",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.",
"default": true
},
{
"name": "description",
"types": [
@ -482,7 +518,7 @@
"Chat"
],
"optional": true,
"description": "Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat."
"description": "Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat."
},
{
"name": "date",
@ -612,7 +648,7 @@
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters"
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
"name": "entities",
@ -692,7 +728,7 @@
"string"
],
"optional": true,
"description": "Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters"
"description": "Optional. Caption for the animation, audio, document, photo, video or voice"
},
{
"name": "caption_entities",
@ -990,7 +1026,7 @@
"string"
],
"optional": true,
"description": "Optional. For “text_link” only, url that will be opened after user taps on the text"
"description": "Optional. For “text_link” only, URL that will be opened after user taps on the text"
},
{
"name": "user",
@ -1132,7 +1168,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
}
],
"extended_by": []
@ -1203,7 +1239,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
},
{
"name": "thumb",
@ -1266,7 +1302,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
}
],
"extended_by": []
@ -1337,7 +1373,7 @@
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
"description": "Optional. MIME type of the file as defined by sender"
},
{
"name": "file_size",
@ -1345,7 +1381,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
}
],
"extended_by": []
@ -1447,7 +1483,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
}
],
"extended_by": []
@ -1737,7 +1773,7 @@
"int"
],
"optional": true,
"description": "Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only."
"description": "Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only."
}
],
"extended_by": []
@ -1807,7 +1843,7 @@
},
{
"name": "WebAppData",
"description": "Contains data sent from a Web App to the bot.",
"description": "Describes data sent from a Web App to the bot.",
"fields": [
{
"name": "data",
@ -1823,7 +1859,7 @@
"string"
],
"optional": false,
"description": "Text of the web_app keyboard button, from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field."
"description": "Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field."
}
],
"extended_by": []
@ -1974,7 +2010,7 @@
"int"
],
"optional": true,
"description": "Optional. File size in bytes, if known"
"description": "Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value."
},
{
"name": "file_path",
@ -1989,7 +2025,7 @@
},
{
"name": "WebAppInfo",
"description": "Contains information about a Web App.",
"description": "Describes a Web App.",
"fields": [
{
"name": "url",
@ -2029,7 +2065,7 @@
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.",
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.",
"default": false
},
{
@ -2170,7 +2206,7 @@
"string"
],
"optional": true,
"description": "Optional. HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings."
"description": "Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings."
},
{
"name": "callback_data",
@ -2194,7 +2230,7 @@
"LoginUrl"
],
"optional": true,
"description": "Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget."
"description": "Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget."
},
{
"name": "switch_inline_query",
@ -2202,7 +2238,7 @@
"string"
],
"optional": true,
"description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen."
"description": "Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen."
},
{
"name": "switch_inline_query_current_chat",
@ -2210,7 +2246,7 @@
"string"
],
"optional": true,
"description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options."
"description": "Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options."
},
{
"name": "callback_game",
@ -2320,7 +2356,7 @@
"string"
],
"optional": true,
"description": "Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field."
"description": "Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data."
},
{
"name": "game_short_name",
@ -2470,7 +2506,7 @@
"int"
],
"optional": true,
"description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
"description": "Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
},
{
"name": "pending_join_request_count",
@ -3393,7 +3429,7 @@
},
{
"name": "ResponseParameters",
"description": "Contains information about why a request was unsuccessful.",
"description": "Describes why a request was unsuccessful.",
"fields": [
{
"name": "migrate_to_chat_id",
@ -3445,7 +3481,7 @@
"string"
],
"optional": false,
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »"
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »"
},
{
"name": "caption",
@ -3493,7 +3529,7 @@
"string"
],
"optional": false,
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »"
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »"
},
{
"name": "thumb",
@ -3502,7 +3538,7 @@
"string"
],
"optional": 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 »"
"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 information on Sending Files »"
},
{
"name": "caption",
@ -3582,7 +3618,7 @@
"string"
],
"optional": false,
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »"
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »"
},
{
"name": "thumb",
@ -3591,7 +3627,7 @@
"string"
],
"optional": 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 »"
"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 information on Sending Files »"
},
{
"name": "caption",
@ -3663,7 +3699,7 @@
"string"
],
"optional": false,
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »"
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »"
},
{
"name": "thumb",
@ -3672,7 +3708,7 @@
"string"
],
"optional": 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 »"
"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 information on Sending Files »"
},
{
"name": "caption",
@ -3744,7 +3780,7 @@
"string"
],
"optional": false,
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »"
"description": "File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »"
},
{
"name": "thumb",
@ -3753,7 +3789,7 @@
"string"
],
"optional": 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 »"
"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 information on Sending Files »"
},
{
"name": "caption",
@ -3872,6 +3908,14 @@
"optional": true,
"description": "Optional. Name of the sticker set to which the sticker belongs"
},
{
"name": "premium_animation",
"types": [
"File"
],
"optional": true,
"description": "Optional. Premium animation for the sticker, if the sticker is premium"
},
{
"name": "mask_position",
"types": [
@ -4035,7 +4079,7 @@
"string"
],
"optional": true,
"description": "Optional. Type of the chat, from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat"
"description": "Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat"
},
{
"name": "location",
@ -4431,7 +4475,7 @@
"string"
],
"optional": false,
"description": "A valid URL for the MP4 file. File size must not exceed 1MB"
"description": "A valid URL for the MPEG4 file. File size must not exceed 1MB"
},
{
"name": "mpeg4_width",
@ -4560,7 +4604,7 @@
"string"
],
"optional": false,
"description": "Mime type of the content of video url, “text/html” or “video/mp4”"
"description": "MIME type of the content of the video URL, “text/html” or “video/mp4”"
},
{
"name": "thumb_url",
@ -4904,7 +4948,7 @@
"string"
],
"optional": false,
"description": "Mime type of the content of the file, either “application/pdf” or “application/zip”"
"description": "MIME type of the content of the file, either “application/pdf” or “application/zip”"
},
{
"name": "description",
@ -5536,7 +5580,7 @@
"string"
],
"optional": false,
"description": "A valid file identifier for the MP4 file"
"description": "A valid file identifier for the MPEG4 file"
},
{
"name": "title",
@ -6215,7 +6259,7 @@
"string"
],
"optional": false,
"description": "Payment provider token, obtained via Botfather"
"description": "Payment provider token, obtained via @BotFather"
},
{
"name": "currency",
@ -6264,7 +6308,7 @@
"string"
],
"optional": 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."
"description": "Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service."
},
{
"name": "photo_size",
@ -6272,7 +6316,7 @@
"int"
],
"optional": true,
"description": "Optional. Photo size"
"description": "Optional. Photo size in bytes"
},
{
"name": "photo_width",
@ -6328,7 +6372,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if user's phone number should be sent to provider"
"description": "Optional. Pass True, if the user's phone number should be sent to provider"
},
{
"name": "send_email_to_provider",
@ -6336,7 +6380,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if user's email address should be sent to provider"
"description": "Optional. Pass True, if the user's email address should be sent to provider"
},
{
"name": "is_flexible",
@ -6398,7 +6442,7 @@
},
{
"name": "SentWebAppMessage",
"description": "Contains information about an inline message sent by a Web App on behalf of a user.",
"description": "Describes an inline message sent by a Web App on behalf of a user.",
"fields": [
{
"name": "inline_message_id",
@ -6491,7 +6535,7 @@
"string"
],
"optional": false,
"description": "ISO 3166-1 alpha-2 country code"
"description": "Two-letter ISO 3166-1 alpha-2 country code"
},
{
"name": "state",
@ -6648,7 +6692,7 @@
"OrderInfo"
],
"optional": true,
"description": "Optional. Order info provided by the user"
"description": "Optional. Order information provided by the user"
},
{
"name": "telegram_payment_charge_id",
@ -6766,14 +6810,14 @@
"OrderInfo"
],
"optional": true,
"description": "Optional. Order info provided by the user"
"description": "Optional. Order information provided by the user"
}
],
"extended_by": []
},
{
"name": "PassportData",
"description": "Contains information about Telegram Passport data shared with the bot by the user.",
"description": "Describes Telegram Passport data shared with the bot by the user.",
"fields": [
{
"name": "data",
@ -6835,7 +6879,7 @@
},
{
"name": "EncryptedPassportElement",
"description": "Contains information about documents or other Telegram Passport elements shared with the bot by the user.",
"description": "Describes documents or other Telegram Passport elements shared with the bot by the user.",
"fields": [
{
"name": "type",
@ -6922,7 +6966,7 @@
},
{
"name": "EncryptedCredentials",
"description": "Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"description": "Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"fields": [
{
"name": "data",
@ -7474,7 +7518,7 @@
},
{
"name": "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.",
"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 was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.",
"fields": [
{
"name": "url",
@ -7482,7 +7526,7 @@
"string"
],
"optional": false,
"description": "HTTPS url to send updates to. Use an empty string to remove webhook integration"
"description": "HTTPS URL to send updates to. Use an empty string to remove webhook integration"
},
{
"name": "certificate",
@ -7506,7 +7550,7 @@
"int"
],
"optional": true,
"description": "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.",
"description": "The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.",
"default": 40
},
{
@ -7524,6 +7568,14 @@
],
"optional": true,
"description": "Pass True to drop all pending updates"
},
{
"name": "secret_token",
"types": [
"string"
],
"optional": true,
"description": "A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you."
}
],
"return_types": [
@ -7845,7 +7897,7 @@
"string"
],
"optional": false,
"description": "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More info on Sending Files »"
"description": "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »"
},
{
"name": "caption",
@ -7939,7 +7991,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "caption",
@ -7996,7 +8048,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "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 information on Sending Files »"
},
{
"name": "disable_notification",
@ -8066,7 +8118,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "thumb",
@ -8075,7 +8127,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "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 information on Sending Files »"
},
{
"name": "caption",
@ -8159,7 +8211,7 @@
},
{
"name": "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.",
"description": "Use this method to send video files, Telegram clients support MPEG4 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.",
"fields": [
{
"name": "chat_id",
@ -8177,7 +8229,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »"
},
{
"name": "duration",
@ -8210,7 +8262,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "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 information on Sending Files »"
},
{
"name": "caption",
@ -8312,7 +8364,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »"
},
{
"name": "duration",
@ -8345,7 +8397,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "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 information on Sending Files »"
},
{
"name": "caption",
@ -8439,7 +8491,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "caption",
@ -8523,7 +8575,7 @@
},
{
"name": "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.",
"description": "As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.",
"fields": [
{
"name": "chat_id",
@ -8541,7 +8593,7 @@
"string"
],
"optional": false,
"description": "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"
"description": "Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported"
},
{
"name": "duration",
@ -8566,7 +8618,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "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 information on Sending Files »"
},
{
"name": "disable_notification",
@ -8850,7 +8902,7 @@
"int"
],
"optional": true,
"description": "Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified."
"description": "The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified."
},
{
"name": "reply_markup",
@ -9419,7 +9471,7 @@
},
{
"name": "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.",
"description": "Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. 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.",
"fields": [
{
"name": "file_id",
@ -9427,7 +9479,7 @@
"string"
],
"optional": false,
"description": "File identifier to get info about"
"description": "File identifier to get information about"
}
],
"return_types": [
@ -9831,7 +9883,7 @@
"int"
],
"optional": true,
"description": "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
"description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
},
{
"name": "creates_join_request",
@ -9889,7 +9941,7 @@
"int"
],
"optional": true,
"description": "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
"description": "The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999"
},
{
"name": "creates_join_request",
@ -10333,7 +10385,7 @@
"string"
],
"optional": true,
"description": "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."
"description": "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."
},
{
"name": "cache_time",
@ -10453,7 +10505,7 @@
"MenuButton"
],
"optional": true,
"description": "A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault",
"description": "A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault",
"default": "MenuButtonDefault"
}
],
@ -10836,7 +10888,7 @@
"string"
],
"optional": false,
"description": "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 »"
"description": "Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "disable_notification",
@ -10921,7 +10973,7 @@
"InputFile"
],
"optional": false,
"description": "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 »"
"description": "PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files »"
}
],
"return_types": [
@ -10946,7 +10998,7 @@
"string"
],
"optional": false,
"description": "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."
"description": "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."
},
{
"name": "title",
@ -10963,7 +11015,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "tgs_sticker",
@ -11037,7 +11089,7 @@
"string"
],
"optional": true,
"description": "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 »"
"description": "PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »"
},
{
"name": "tgs_sticker",
@ -11145,7 +11197,7 @@
"string"
],
"optional": true,
"description": "A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. 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 ». Animated sticker set thumbnails can't be uploaded via HTTP URL."
"description": "A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL."
}
],
"return_types": [
@ -11286,7 +11338,7 @@
"string"
],
"optional": false,
"description": "Payments provider token, obtained via Botfather"
"description": "Payment provider token, obtained via @BotFather"
},
{
"name": "currency",
@ -11335,7 +11387,7 @@
"string"
],
"optional": true,
"description": "A JSON-serialized 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."
"description": "JSON-serialized 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."
},
{
"name": "photo_url",
@ -11351,7 +11403,7 @@
"int"
],
"optional": true,
"description": "Photo size"
"description": "Photo size in bytes"
},
{
"name": "photo_width",
@ -11407,7 +11459,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if user's phone number should be sent to provider"
"description": "Pass True, if the user's phone number should be sent to provider"
},
{
"name": "send_email_to_provider",
@ -11415,7 +11467,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if user's email address should be sent to provider"
"description": "Pass True, if the user's email address should be sent to provider"
},
{
"name": "is_flexible",
@ -11470,6 +11522,176 @@
"Message"
]
},
{
"name": "createInvoiceLink",
"description": "Use this method to create a link for an invoice. Returns the created invoice link as String on success.",
"fields": [
{
"name": "title",
"types": [
"string"
],
"optional": false,
"description": "Product name, 1-32 characters"
},
{
"name": "description",
"types": [
"string"
],
"optional": false,
"description": "Product description, 1-255 characters"
},
{
"name": "payload",
"types": [
"string"
],
"optional": false,
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."
},
{
"name": "provider_token",
"types": [
"string"
],
"optional": false,
"description": "Payment provider token, obtained via BotFather"
},
{
"name": "currency",
"types": [
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code, see more on currencies"
},
{
"name": "prices",
"types": [
"Array<LabeledPrice>"
],
"optional": false,
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)"
},
{
"name": "max_tip_amount",
"types": [
"int"
],
"optional": true,
"description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
"default": 0
},
{
"name": "suggested_tip_amounts",
"types": [
"Array<int>"
],
"optional": true,
"description": "A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount."
},
{
"name": "provider_data",
"types": [
"string"
],
"optional": true,
"description": "JSON-serialized 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."
},
{
"name": "photo_url",
"types": [
"string"
],
"optional": true,
"description": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service."
},
{
"name": "photo_size",
"types": [
"int"
],
"optional": true,
"description": "Photo size in bytes"
},
{
"name": "photo_width",
"types": [
"int"
],
"optional": true,
"description": "Photo width"
},
{
"name": "photo_height",
"types": [
"int"
],
"optional": true,
"description": "Photo height"
},
{
"name": "need_name",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's full name to complete the order"
},
{
"name": "need_phone_number",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's phone number to complete the order"
},
{
"name": "need_email",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's email address to complete the order"
},
{
"name": "need_shipping_address",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's shipping address to complete the order"
},
{
"name": "send_phone_number_to_provider",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the user's phone number should be sent to the provider"
},
{
"name": "send_email_to_provider",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the user's email address should be sent to the provider"
},
{
"name": "is_flexible",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the final price depends on the shipping method"
}
],
"return_types": [
"string"
]
},
{
"name": "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.",
@ -11587,7 +11809,7 @@
"string"
],
"optional": false,
"description": "Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather."
"description": "Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather."
},
{
"name": "disable_notification",

349
schemas/botapi.yaml
View File

@ -1,4 +1,4 @@
version: 6.0.0
version: 6.1.0
types:
-
name: Update
@ -9,13 +9,13 @@ types:
types:
- int
optional: false
description: 'The update''s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you''re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.'
description: 'The update''s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you''re using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.'
-
name: message
types:
- Message
optional: true
description: 'Optional. New incoming message of any kind — text, photo, sticker, etc.'
description: 'Optional. New incoming message of any kind - text, photo, sticker, etc.'
-
name: edited_message
types:
@ -27,7 +27,7 @@ types:
types:
- Message
optional: true
description: 'Optional. New incoming channel post of any kind — text, photo, sticker, etc.'
description: 'Optional. New incoming channel post of any kind - text, photo, sticker, etc.'
-
name: edited_channel_post
types:
@ -97,7 +97,7 @@ types:
extended_by: { }
-
name: WebhookInfo
description: 'Contains information about the current status of a webhook.'
description: 'Describes the current status of a webhook.'
fields:
-
name: url
@ -146,7 +146,7 @@ types:
types:
- int
optional: true
description: 'Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery'
description: 'Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery'
-
name: allowed_updates
types:
@ -194,6 +194,20 @@ types:
- string
optional: true
description: 'Optional. IETF language tag of the user''s language'
-
name: is_premium
types:
- bool
optional: true
description: 'Optional. True, if this user is a Telegram Premium user'
default: true
-
name: added_to_attachment_menu
types:
- bool
optional: true
description: 'Optional. True, if this user added the bot to the attachment menu'
default: true
-
name: can_join_groups
types:
@ -272,6 +286,20 @@ types:
optional: true
description: 'Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.'
default: true
-
name: join_to_send_messages
types:
- bool
optional: true
description: 'Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.'
default: true
-
name: join_by_request
types:
- bool
optional: true
description: 'Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.'
default: true
-
name: description
types:
@ -362,7 +390,7 @@ types:
types:
- Chat
optional: true
description: 'Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
description: 'Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
-
name: date
types:
@ -460,7 +488,7 @@ types:
types:
- string
optional: true
description: 'Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters'
description: 'Optional. For text messages, the actual UTF-8 text of the message'
-
name: entities
types:
@ -520,7 +548,7 @@ types:
types:
- string
optional: true
description: 'Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters'
description: 'Optional. Caption for the animation, audio, document, photo, video or voice'
-
name: caption_entities
types:
@ -744,7 +772,7 @@ types:
types:
- string
optional: true
description: 'Optional. For “text_link” only, url that will be opened after user taps on the text'
description: 'Optional. For “text_link” only, URL that will be opened after user taps on the text'
-
name: user
types:
@ -850,7 +878,7 @@ types:
types:
- int
optional: true
description: 'Optional. File size in bytes'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
extended_by: { }
-
name: Audio
@ -903,7 +931,7 @@ types:
types:
- int
optional: true
description: 'Optional. File size in bytes'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
-
name: thumb
types:
@ -950,7 +978,7 @@ types:
types:
- int
optional: true
description: 'Optional. File size in bytes'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
extended_by: { }
-
name: Video
@ -1003,13 +1031,13 @@ types:
types:
- string
optional: true
description: 'Optional. Mime type of a file as defined by sender'
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
extended_by: { }
-
name: VideoNote
@ -1085,7 +1113,7 @@ types:
types:
- int
optional: true
description: 'Optional. File size in bytes'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
extended_by: { }
-
name: Contact
@ -1301,7 +1329,7 @@ types:
types:
- int
optional: true
description: 'Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.'
description: 'Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.'
extended_by: { }
-
name: Venue
@ -1352,7 +1380,7 @@ types:
extended_by: { }
-
name: WebAppData
description: 'Contains data sent from a Web App to the bot.'
description: 'Describes data sent from a Web App to the bot.'
fields:
-
name: data
@ -1365,7 +1393,7 @@ types:
types:
- string
optional: false
description: 'Text of the web_app keyboard button, from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.'
description: 'Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.'
extended_by: { }
-
name: ProximityAlertTriggered
@ -1477,7 +1505,7 @@ types:
types:
- int
optional: true
description: 'Optional. File size in bytes, if known'
description: 'Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.'
-
name: file_path
types:
@ -1487,7 +1515,7 @@ types:
extended_by: { }
-
name: WebAppInfo
description: 'Contains information about a Web App.'
description: 'Describes a Web App.'
fields:
-
name: url
@ -1518,7 +1546,7 @@ types:
types:
- bool
optional: true
description: 'Optional. Requests clients to hide the keyboard as soon as it''s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.'
description: 'Optional. Requests clients to hide the keyboard as soon as it''s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.'
default: false
-
name: input_field_placeholder
@ -1623,7 +1651,7 @@ types:
types:
- string
optional: true
description: 'Optional. HTTP or tg:// url to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.'
description: 'Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.'
-
name: callback_data
types:
@ -1641,19 +1669,19 @@ types:
types:
- LoginUrl
optional: true
description: 'Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.'
description: 'Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.'
-
name: switch_inline_query
types:
- string
optional: true
description: 'Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot''s username and the specified inline query in the input field. Can be empty, in which case just the bot''s username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.'
description: 'Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot''s username and the specified inline query in the input field. May be empty, in which case just the bot''s username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.'
-
name: switch_inline_query_current_chat
types:
- string
optional: true
description: 'Optional. If set, pressing the button will insert the bot''s username and the specified inline query in the current chat''s input field. Can be empty, in which case only the bot''s username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options.'
description: 'Optional. If set, pressing the button will insert the bot''s username and the specified inline query in the current chat''s input field. May be empty, in which case only the bot''s username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.'
-
name: callback_game
types:
@ -1735,7 +1763,7 @@ types:
types:
- string
optional: true
description: 'Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.'
description: 'Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.'
-
name: game_short_name
types:
@ -1847,7 +1875,7 @@ types:
types:
- int
optional: true
description: 'Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
description: 'Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
-
name: pending_join_request_count
types:
@ -2539,7 +2567,7 @@ types:
extended_by: { }
-
name: ResponseParameters
description: 'Contains information about why a request was unsuccessful.'
description: 'Describes why a request was unsuccessful.'
fields:
-
name: migrate_to_chat_id
@ -2580,7 +2608,7 @@ types:
types:
- string
optional: false
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »'
-
name: caption
types:
@ -2616,14 +2644,14 @@ types:
types:
- string
optional: false
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »'
-
name: thumb
types:
- InputFile
- string
optional: 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 »'
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 information on Sending Files »'
-
name: caption
types:
@ -2683,14 +2711,14 @@ types:
types:
- string
optional: false
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »'
-
name: thumb
types:
- InputFile
- string
optional: 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 »'
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 information on Sending Files »'
-
name: caption
types:
@ -2744,14 +2772,14 @@ types:
types:
- string
optional: false
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »'
-
name: thumb
types:
- InputFile
- string
optional: 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 »'
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 information on Sending Files »'
-
name: caption
types:
@ -2805,14 +2833,14 @@ types:
types:
- string
optional: false
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
description: 'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »'
-
name: thumb
types:
- InputFile
- string
optional: 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 »'
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 information on Sending Files »'
-
name: caption
types:
@ -2901,6 +2929,12 @@ types:
- string
optional: true
description: 'Optional. Name of the sticker set to which the sticker belongs'
-
name: premium_animation
types:
- File
optional: true
description: 'Optional. Premium animation for the sticker, if the sticker is premium'
-
name: mask_position
types:
@ -3023,7 +3057,7 @@ types:
types:
- string
optional: true
description: 'Optional. Type of the chat, from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat'
description: 'Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat'
-
name: location
types:
@ -3325,7 +3359,7 @@ types:
types:
- string
optional: false
description: 'A valid URL for the MP4 file. File size must not exceed 1MB'
description: 'A valid URL for the MPEG4 file. File size must not exceed 1MB'
-
name: mpeg4_width
types:
@ -3422,7 +3456,7 @@ types:
types:
- string
optional: false
description: 'Mime type of the content of video url, “text/html” or “video/mp4”'
description: 'MIME type of the content of the video URL, “text/html” or “video/mp4”'
-
name: thumb_url
types:
@ -3680,7 +3714,7 @@ types:
types:
- string
optional: false
description: 'Mime type of the content of the file, either “application/pdf” or “application/zip”'
description: 'MIME type of the content of the file, either “application/pdf” or “application/zip”'
-
name: description
types:
@ -4154,7 +4188,7 @@ types:
types:
- string
optional: false
description: 'A valid file identifier for the MP4 file'
description: 'A valid file identifier for the MPEG4 file'
-
name: title
types:
@ -4663,7 +4697,7 @@ types:
types:
- string
optional: false
description: 'Payment provider token, obtained via Botfather'
description: 'Payment provider token, obtained via @BotFather'
-
name: currency
types:
@ -4700,13 +4734,13 @@ types:
types:
- string
optional: 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.'
description: 'Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.'
-
name: photo_size
types:
- int
optional: true
description: 'Optional. Photo size'
description: 'Optional. Photo size in bytes'
-
name: photo_width
types:
@ -4748,13 +4782,13 @@ types:
types:
- bool
optional: true
description: 'Optional. Pass True, if user''s phone number should be sent to provider'
description: 'Optional. Pass True, if the user''s phone number should be sent to provider'
-
name: send_email_to_provider
types:
- bool
optional: true
description: 'Optional. Pass True, if user''s email address should be sent to provider'
description: 'Optional. Pass True, if the user''s email address should be sent to provider'
-
name: is_flexible
types:
@ -4799,7 +4833,7 @@ types:
extended_by: { }
-
name: SentWebAppMessage
description: 'Contains information about an inline message sent by a Web App on behalf of a user.'
description: 'Describes an inline message sent by a Web App on behalf of a user.'
fields:
-
name: inline_message_id
@ -4869,7 +4903,7 @@ types:
types:
- string
optional: false
description: 'ISO 3166-1 alpha-2 country code'
description: 'Two-letter ISO 3166-1 alpha-2 country code'
-
name: state
types:
@ -4986,7 +5020,7 @@ types:
types:
- OrderInfo
optional: true
description: 'Optional. Order info provided by the user'
description: 'Optional. Order information provided by the user'
-
name: telegram_payment_charge_id
types:
@ -5074,11 +5108,11 @@ types:
types:
- OrderInfo
optional: true
description: 'Optional. Order info provided by the user'
description: 'Optional. Order information provided by the user'
extended_by: { }
-
name: PassportData
description: 'Contains information about Telegram Passport data shared with the bot by the user.'
description: 'Describes Telegram Passport data shared with the bot by the user.'
fields:
-
name: data
@ -5124,7 +5158,7 @@ types:
extended_by: { }
-
name: EncryptedPassportElement
description: 'Contains information about documents or other Telegram Passport elements shared with the bot by the user.'
description: 'Describes documents or other Telegram Passport elements shared with the bot by the user.'
fields:
-
name: type
@ -5189,7 +5223,7 @@ types:
extended_by: { }
-
name: EncryptedCredentials
description: 'Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
description: 'Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
fields:
-
name: data
@ -5604,14 +5638,14 @@ methods:
- Array<Update>
-
name: 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."
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 was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content."
fields:
-
name: url
types:
- string
optional: false
description: 'HTTPS url to send updates to. Use an empty string to remove webhook integration'
description: 'HTTPS URL to send updates to. Use an empty string to remove webhook integration'
-
name: certificate
types:
@ -5629,7 +5663,7 @@ methods:
types:
- int
optional: true
description: '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.'
description: 'The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot''s server, and higher values to increase your bot''s throughput.'
default: 40
-
name: allowed_updates
@ -5643,6 +5677,12 @@ methods:
- bool
optional: true
description: 'Pass True to drop all pending updates'
-
name: secret_token
types:
- string
optional: true
description: 'A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.'
return_types:
- bool
-
@ -5883,7 +5923,7 @@ methods:
- InputFile
- string
optional: false
description: 'Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo''s width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More info on Sending Files »'
description: 'Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo''s width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »'
-
name: caption
types:
@ -5954,7 +5994,7 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: caption
types:
@ -5997,7 +6037,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: '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 information on Sending Files »'
-
name: disable_notification
types:
@ -6050,14 +6090,14 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: thumb
types:
- InputFile
- string
optional: true
description: '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 »'
description: '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 information on Sending Files »'
-
name: caption
types:
@ -6119,7 +6159,7 @@ methods:
- Message
-
name: 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.'
description: 'Use this method to send video files, Telegram clients support MPEG4 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.'
fields:
-
name: chat_id
@ -6134,7 +6174,7 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »'
-
name: duration
types:
@ -6159,7 +6199,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: '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 information on Sending Files »'
-
name: caption
types:
@ -6236,7 +6276,7 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »'
-
name: duration
types:
@ -6261,7 +6301,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: '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 information on Sending Files »'
-
name: caption
types:
@ -6332,7 +6372,7 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: caption
types:
@ -6394,7 +6434,7 @@ methods:
- Message
-
name: 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.'
description: 'As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.'
fields:
-
name: chat_id
@ -6409,7 +6449,7 @@ methods:
- InputFile
- string
optional: false
description: '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'
description: 'Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported'
-
name: duration
types:
@ -6428,7 +6468,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: '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 information on Sending Files »'
-
name: disable_notification
types:
@ -6641,7 +6681,7 @@ methods:
types:
- int
optional: true
description: 'Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.'
description: 'The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.'
-
name: reply_markup
types:
@ -7067,14 +7107,14 @@ methods:
- UserProfilePhotos
-
name: 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.'
description: 'Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. 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.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'File identifier to get info about'
description: 'File identifier to get information about'
return_types:
- File
-
@ -7372,7 +7412,7 @@ methods:
types:
- int
optional: true
description: 'Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
description: 'The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
-
name: creates_join_request
types:
@ -7415,7 +7455,7 @@ methods:
types:
- int
optional: true
description: 'Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
description: 'The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
-
name: creates_join_request
types:
@ -7739,7 +7779,7 @@ methods:
types:
- string
optional: true
description: '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.'
description: '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.'
-
name: cache_time
types:
@ -7827,7 +7867,7 @@ methods:
types:
- MenuButton
optional: true
description: 'A JSON-serialized object for the new bot''s menu button. Defaults to MenuButtonDefault'
description: 'A JSON-serialized object for the bot''s new menu button. Defaults to MenuButtonDefault'
default: MenuButtonDefault
return_types:
- bool
@ -8110,7 +8150,7 @@ methods:
- InputFile
- string
optional: false
description: '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 »'
description: 'Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: disable_notification
types:
@ -8173,7 +8213,7 @@ methods:
types:
- InputFile
optional: false
description: '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 »'
description: 'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files »'
return_types:
- File
-
@ -8191,7 +8231,7 @@ methods:
types:
- string
optional: false
description: '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.'
description: '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.'
-
name: title
types:
@ -8204,7 +8244,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: 'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: tgs_sticker
types:
@ -8259,7 +8299,7 @@ methods:
- InputFile
- string
optional: true
description: '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 »'
description: 'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
-
name: tgs_sticker
types:
@ -8338,7 +8378,7 @@ methods:
- InputFile
- string
optional: true
description: 'A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. 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 ». Animated sticker set thumbnails can''t be uploaded via HTTP URL.'
description: 'A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated sticker set thumbnails can''t be uploaded via HTTP URL.'
return_types:
- bool
-
@ -8442,7 +8482,7 @@ methods:
types:
- string
optional: false
description: 'Payments provider token, obtained via Botfather'
description: 'Payment provider token, obtained via @BotFather'
-
name: currency
types:
@ -8479,7 +8519,7 @@ methods:
types:
- string
optional: true
description: 'A JSON-serialized 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.'
description: 'JSON-serialized 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.'
-
name: photo_url
types:
@ -8491,7 +8531,7 @@ methods:
types:
- int
optional: true
description: 'Photo size'
description: 'Photo size in bytes'
-
name: photo_width
types:
@ -8533,13 +8573,13 @@ methods:
types:
- bool
optional: true
description: 'Pass True, if user''s phone number should be sent to provider'
description: 'Pass True, if the user''s phone number should be sent to provider'
-
name: send_email_to_provider
types:
- bool
optional: true
description: 'Pass True, if user''s email address should be sent to provider'
description: 'Pass True, if the user''s email address should be sent to provider'
-
name: is_flexible
types:
@ -8578,6 +8618,133 @@ methods:
description: '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.'
return_types:
- Message
-
name: createInvoiceLink
description: 'Use this method to create a link for an invoice. Returns the created invoice link as String on success.'
fields:
-
name: title
types:
- string
optional: false
description: 'Product name, 1-32 characters'
-
name: description
types:
- string
optional: false
description: 'Product description, 1-255 characters'
-
name: payload
types:
- string
optional: false
description: 'Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.'
-
name: provider_token
types:
- string
optional: false
description: 'Payment provider token, obtained via BotFather'
-
name: currency
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code, see more on currencies'
-
name: prices
types:
- Array<LabeledPrice>
optional: false
description: 'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)'
-
name: max_tip_amount
types:
- int
optional: true
description: 'The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0'
default: 0
-
name: suggested_tip_amounts
types:
- Array<int>
optional: true
description: 'A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.'
-
name: provider_data
types:
- string
optional: true
description: 'JSON-serialized 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.'
-
name: photo_url
types:
- string
optional: true
description: 'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.'
-
name: photo_size
types:
- int
optional: true
description: 'Photo size in bytes'
-
name: photo_width
types:
- int
optional: true
description: 'Photo width'
-
name: photo_height
types:
- int
optional: true
description: 'Photo height'
-
name: need_name
types:
- bool
optional: true
description: 'Pass True, if you require the user''s full name to complete the order'
-
name: need_phone_number
types:
- bool
optional: true
description: 'Pass True, if you require the user''s phone number to complete the order'
-
name: need_email
types:
- bool
optional: true
description: 'Pass True, if you require the user''s email address to complete the order'
-
name: need_shipping_address
types:
- bool
optional: true
description: 'Pass True, if you require the user''s shipping address to complete the order'
-
name: send_phone_number_to_provider
types:
- bool
optional: true
description: 'Pass True, if the user''s phone number should be sent to the provider'
-
name: send_email_to_provider
types:
- bool
optional: true
description: 'Pass True, if the user''s email address should be sent to the provider'
-
name: is_flexible
types:
- bool
optional: true
description: 'Pass True, if the final price depends on the shipping method'
return_types:
- string
-
name: 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.'
@ -8665,7 +8832,7 @@ methods:
types:
- string
optional: false
description: 'Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.'
description: 'Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.'
-
name: disable_notification
types:

355
schemas/botapi_openapi.json
View File

@ -3,7 +3,7 @@
"info": {
"title": "Telegram Bot API",
"description": "Auto-generated OpenAPI schema by TGScraper.",
"version": "6.0.0"
"version": "6.1.0"
},
"servers": [
{
@ -216,7 +216,7 @@
"type": "object"
},
"WebhookInfo": {
"description": "Contains information about the current status of a webhook.",
"description": "Describes the current status of a webhook.",
"required": [
"url",
"has_custom_certificate",
@ -282,6 +282,14 @@
"language_code": {
"type": "string"
},
"is_premium": {
"type": "boolean",
"default": true
},
"added_to_attachment_menu": {
"type": "boolean",
"default": true
},
"can_join_groups": {
"type": "boolean"
},
@ -329,6 +337,14 @@
"type": "boolean",
"default": true
},
"join_to_send_messages": {
"type": "boolean",
"default": true
},
"join_by_request": {
"type": "boolean",
"default": true
},
"description": {
"type": "string"
},
@ -1048,7 +1064,7 @@
"type": "object"
},
"WebAppData": {
"description": "Contains data sent from a Web App to the bot.",
"description": "Describes data sent from a Web App to the bot.",
"required": [
"data",
"button_text"
@ -1183,7 +1199,7 @@
"type": "object"
},
"WebAppInfo": {
"description": "Contains information about a Web App.",
"description": "Describes a Web App.",
"required": [
"url"
],
@ -2065,7 +2081,7 @@
"type": "object"
},
"ResponseParameters": {
"description": "Contains information about why a request was unsuccessful.",
"description": "Describes why a request was unsuccessful.",
"properties": {
"migrate_to_chat_id": {
"type": "integer"
@ -2356,6 +2372,9 @@
"set_name": {
"type": "string"
},
"premium_animation": {
"$ref": "#/components/schemas/File"
},
"mask_position": {
"$ref": "#/components/schemas/MaskPosition"
},
@ -3711,7 +3730,7 @@
"type": "object"
},
"SentWebAppMessage": {
"description": "Contains information about an inline message sent by a Web App on behalf of a user.",
"description": "Describes an inline message sent by a Web App on behalf of a user.",
"properties": {
"inline_message_id": {
"type": "string"
@ -3929,7 +3948,7 @@
"type": "object"
},
"PassportData": {
"description": "Contains information about Telegram Passport data shared with the bot by the user.",
"description": "Describes Telegram Passport data shared with the bot by the user.",
"required": [
"data",
"credentials"
@ -3972,7 +3991,7 @@
"type": "object"
},
"EncryptedPassportElement": {
"description": "Contains information about documents or other Telegram Passport elements shared with the bot by the user.",
"description": "Describes documents or other Telegram Passport elements shared with the bot by the user.",
"required": [
"type",
"hash"
@ -4018,7 +4037,7 @@
"type": "object"
},
"EncryptedCredentials": {
"description": "Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"description": "Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.",
"required": [
"data",
"hash",
@ -4496,7 +4515,7 @@
}
},
"/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.",
"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 was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.",
"post": {
"requestBody": {
"required": true,
@ -4529,6 +4548,9 @@
},
"drop_pending_updates": {
"type": "boolean"
},
"secret_token": {
"type": "string"
}
}
}
@ -4561,6 +4583,9 @@
},
"drop_pending_updates": {
"type": "boolean"
},
"secret_token": {
"type": "string"
}
}
}
@ -4593,6 +4618,9 @@
},
"drop_pending_updates": {
"type": "boolean"
},
"secret_token": {
"type": "string"
}
}
}
@ -6648,7 +6676,7 @@
}
},
"/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.",
"description": "Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.",
"post": {
"requestBody": {
"required": true,
@ -7593,7 +7621,7 @@
}
},
"/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.",
"description": "As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.",
"post": {
"requestBody": {
"required": true,
@ -10029,7 +10057,7 @@
}
},
"/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.",
"description": "Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. 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.",
"post": {
"requestBody": {
"required": true,
@ -17497,6 +17525,307 @@
}
}
},
"/createInvoiceLink": {
"description": "Use this method to create a link for an invoice. Returns the created invoice link as String on success.",
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"payload": {
"type": "string"
},
"provider_token": {
"type": "string"
},
"currency": {
"type": "string"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabeledPrice"
}
},
"max_tip_amount": {
"type": "integer"
},
"suggested_tip_amounts": {
"type": "array",
"items": {
"type": "integer"
}
},
"provider_data": {
"type": "string"
},
"photo_url": {
"type": "string"
},
"photo_size": {
"type": "integer"
},
"photo_width": {
"type": "integer"
},
"photo_height": {
"type": "integer"
},
"need_name": {
"type": "boolean"
},
"need_phone_number": {
"type": "boolean"
},
"need_email": {
"type": "boolean"
},
"need_shipping_address": {
"type": "boolean"
},
"send_phone_number_to_provider": {
"type": "boolean"
},
"send_email_to_provider": {
"type": "boolean"
},
"is_flexible": {
"type": "boolean"
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"payload": {
"type": "string"
},
"provider_token": {
"type": "string"
},
"currency": {
"type": "string"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabeledPrice"
}
},
"max_tip_amount": {
"type": "integer"
},
"suggested_tip_amounts": {
"type": "array",
"items": {
"type": "integer"
}
},
"provider_data": {
"type": "string"
},
"photo_url": {
"type": "string"
},
"photo_size": {
"type": "integer"
},
"photo_width": {
"type": "integer"
},
"photo_height": {
"type": "integer"
},
"need_name": {
"type": "boolean"
},
"need_phone_number": {
"type": "boolean"
},
"need_email": {
"type": "boolean"
},
"need_shipping_address": {
"type": "boolean"
},
"send_phone_number_to_provider": {
"type": "boolean"
},
"send_email_to_provider": {
"type": "boolean"
},
"is_flexible": {
"type": "boolean"
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"payload": {
"type": "string"
},
"provider_token": {
"type": "string"
},
"currency": {
"type": "string"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabeledPrice"
}
},
"max_tip_amount": {
"type": "integer"
},
"suggested_tip_amounts": {
"type": "array",
"items": {
"type": "integer"
}
},
"provider_data": {
"type": "string"
},
"photo_url": {
"type": "string"
},
"photo_size": {
"type": "integer"
},
"photo_width": {
"type": "integer"
},
"photo_height": {
"type": "integer"
},
"need_name": {
"type": "boolean"
},
"need_phone_number": {
"type": "boolean"
},
"need_email": {
"type": "boolean"
},
"need_shipping_address": {
"type": "boolean"
},
"send_phone_number_to_provider": {
"type": "boolean"
},
"send_email_to_provider": {
"type": "boolean"
},
"is_flexible": {
"type": "boolean"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Request was successful, the result is returned.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Success"
},
{
"type": "object",
"properties": {
"result": {
"type": "string"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
},
"default": {
"$ref": "#/components/responses/UnknownError"
}
}
}
},
"/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.",
"post": {

247
schemas/botapi_openapi.yaml
View File

@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: 'Telegram Bot API'
description: 'Auto-generated OpenAPI schema by TGScraper.'
version: 6.0.0
version: 6.1.0
servers:
-
url: 'https://api.telegram.org/bot{token}'
@ -138,7 +138,7 @@ components:
$ref: '#/components/schemas/ChatJoinRequest'
type: object
WebhookInfo:
description: 'Contains information about the current status of a webhook.'
description: 'Describes the current status of a webhook.'
required:
- url
- has_custom_certificate
@ -184,6 +184,12 @@ components:
type: string
language_code:
type: string
is_premium:
type: boolean
default: true
added_to_attachment_menu:
type: boolean
default: true
can_join_groups:
type: boolean
can_read_all_group_messages:
@ -216,6 +222,12 @@ components:
has_private_forwards:
type: boolean
default: true
join_to_send_messages:
type: boolean
default: true
join_by_request:
type: boolean
default: true
description:
type: string
invite_link:
@ -710,7 +722,7 @@ components:
type: string
type: object
WebAppData:
description: 'Contains data sent from a Web App to the bot.'
description: 'Describes data sent from a Web App to the bot.'
required:
- data
- button_text
@ -802,7 +814,7 @@ components:
type: string
type: object
WebAppInfo:
description: 'Contains information about a Web App.'
description: 'Describes a Web App.'
required:
- url
properties:
@ -1410,7 +1422,7 @@ components:
default: default
type: object
ResponseParameters:
description: 'Contains information about why a request was unsuccessful.'
description: 'Describes why a request was unsuccessful.'
properties:
migrate_to_chat_id:
type: integer
@ -1607,6 +1619,8 @@ components:
type: string
set_name:
type: string
premium_animation:
$ref: '#/components/schemas/File'
mask_position:
$ref: '#/components/schemas/MaskPosition'
file_size:
@ -2544,7 +2558,7 @@ components:
type: string
type: object
SentWebAppMessage:
description: 'Contains information about an inline message sent by a Web App on behalf of a user.'
description: 'Describes an inline message sent by a Web App on behalf of a user.'
properties:
inline_message_id:
type: string
@ -2697,7 +2711,7 @@ components:
$ref: '#/components/schemas/OrderInfo'
type: object
PassportData:
description: 'Contains information about Telegram Passport data shared with the bot by the user.'
description: 'Describes Telegram Passport data shared with the bot by the user.'
required:
- data
- credentials
@ -2727,7 +2741,7 @@ components:
type: integer
type: object
EncryptedPassportElement:
description: 'Contains information about documents or other Telegram Passport elements shared with the bot by the user.'
description: 'Describes documents or other Telegram Passport elements shared with the bot by the user.'
required:
- type
- hash
@ -2758,7 +2772,7 @@ components:
type: string
type: object
EncryptedCredentials:
description: 'Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
description: 'Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
required:
- data
- hash
@ -3086,7 +3100,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setWebhook:
description: "Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True 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."
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 was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content."
post:
requestBody:
required: true
@ -3112,6 +3126,8 @@ paths:
type: string
drop_pending_updates:
type: boolean
secret_token:
type: string
application/x-www-form-urlencoded:
schema:
type: object
@ -3133,6 +3149,8 @@ paths:
type: string
drop_pending_updates:
type: boolean
secret_token:
type: string
multipart/form-data:
schema:
type: object
@ -3154,6 +3172,8 @@ paths:
type: string
drop_pending_updates:
type: boolean
secret_token:
type: string
responses:
200:
description: 'Request was successful, the result is returned.'
@ -4440,7 +4460,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/sendVideo:
description: 'Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.'
description: 'Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.'
post:
requestBody:
required: true
@ -5037,7 +5057,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/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.'
description: 'As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.'
post:
requestBody:
required: true
@ -6588,7 +6608,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getFile:
description: 'Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<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.'
description: 'Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. 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.'
post:
requestBody:
required: true
@ -11270,6 +11290,207 @@ paths:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/createInvoiceLink:
description: 'Use this method to create a link for an invoice. Returns the created invoice link as String on success.'
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
title:
type: string
description:
type: string
payload:
type: string
provider_token:
type: string
currency:
type: string
prices:
type: array
items:
$ref: '#/components/schemas/LabeledPrice'
max_tip_amount:
type: integer
suggested_tip_amounts:
type: array
items:
type: integer
provider_data:
type: string
photo_url:
type: string
photo_size:
type: integer
photo_width:
type: integer
photo_height:
type: integer
need_name:
type: boolean
need_phone_number:
type: boolean
need_email:
type: boolean
need_shipping_address:
type: boolean
send_phone_number_to_provider:
type: boolean
send_email_to_provider:
type: boolean
is_flexible:
type: boolean
application/x-www-form-urlencoded:
schema:
type: object
required:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
title:
type: string
description:
type: string
payload:
type: string
provider_token:
type: string
currency:
type: string
prices:
type: array
items:
$ref: '#/components/schemas/LabeledPrice'
max_tip_amount:
type: integer
suggested_tip_amounts:
type: array
items:
type: integer
provider_data:
type: string
photo_url:
type: string
photo_size:
type: integer
photo_width:
type: integer
photo_height:
type: integer
need_name:
type: boolean
need_phone_number:
type: boolean
need_email:
type: boolean
need_shipping_address:
type: boolean
send_phone_number_to_provider:
type: boolean
send_email_to_provider:
type: boolean
is_flexible:
type: boolean
multipart/form-data:
schema:
type: object
required:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
title:
type: string
description:
type: string
payload:
type: string
provider_token:
type: string
currency:
type: string
prices:
type: array
items:
$ref: '#/components/schemas/LabeledPrice'
max_tip_amount:
type: integer
suggested_tip_amounts:
type: array
items:
type: integer
provider_data:
type: string
photo_url:
type: string
photo_size:
type: integer
photo_width:
type: integer
photo_height:
type: integer
need_name:
type: boolean
need_phone_number:
type: boolean
need_email:
type: boolean
need_shipping_address:
type: boolean
send_phone_number_to_provider:
type: boolean
send_email_to_provider:
type: boolean
is_flexible:
type: boolean
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result:
type: string
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
$ref: '#/components/responses/TooManyRequests'
5XX:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/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.'
post:

225
schemas/botapi_postman.json
View File

@ -3,7 +3,7 @@
"name": "Telegram Bot API",
"description": "Auto-generated Postman collection by TGScraper.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"version": "6.0.0"
"version": "6.1.0"
},
"variable": {
"key": "token",
@ -72,7 +72,7 @@
{
"key": "url",
"disabled": false,
"description": "Required. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"description": "Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
@ -90,7 +90,7 @@
{
"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.",
"description": "Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.",
"type": "text",
"value": "40"
},
@ -105,6 +105,12 @@
"disabled": true,
"description": "Optional. Pass True to drop all pending updates",
"type": "text"
},
{
"key": "secret_token",
"disabled": true,
"description": "Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.",
"type": "text"
}
]
},
@ -121,7 +127,7 @@
"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."
"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 was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content."
}
},
{
@ -498,7 +504,7 @@
{
"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. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More info on Sending Files »",
"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. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »",
"type": "text"
},
{
@ -583,7 +589,7 @@
{
"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 »",
"description": "Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -625,7 +631,7 @@
{
"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 »",
"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 information on Sending Files »",
"type": "text"
},
{
@ -692,13 +698,13 @@
{
"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 »",
"description": "Required. File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"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 »",
"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 information on Sending Files »",
"type": "text"
},
{
@ -789,7 +795,7 @@
{
"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 »",
"description": "Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -813,7 +819,7 @@
{
"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 »",
"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 information on Sending Files »",
"type": "text"
},
{
@ -885,7 +891,7 @@
"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."
"description": "Use this method to send video files, Telegram clients support MPEG4 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."
}
},
{
@ -904,7 +910,7 @@
{
"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 »",
"description": "Required. Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -928,7 +934,7 @@
{
"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 »",
"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 information on Sending Files »",
"type": "text"
},
{
@ -1013,7 +1019,7 @@
{
"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 »",
"description": "Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -1104,7 +1110,7 @@
{
"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",
"description": "Required. Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported",
"type": "text"
},
{
@ -1122,7 +1128,7 @@
{
"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 »",
"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 information on Sending Files »",
"type": "text"
},
{
@ -1170,7 +1176,7 @@
"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."
"description": "As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned."
}
},
{
@ -1383,7 +1389,7 @@
{
"key": "proximity_alert_radius",
"disabled": true,
"description": "Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"description": "Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"type": "text"
},
{
@ -1947,7 +1953,7 @@
{
"key": "file_id",
"disabled": false,
"description": "Required. File identifier to get info about",
"description": "Required. File identifier to get information about",
"type": "text"
}
]
@ -1965,7 +1971,7 @@
"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."
"description": "Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. 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."
}
},
{
@ -2425,7 +2431,7 @@
{
"key": "member_limit",
"disabled": true,
"description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"description": "Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"type": "text"
},
{
@ -2486,7 +2492,7 @@
{
"key": "member_limit",
"disabled": true,
"description": "Optional. Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"description": "Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"type": "text"
},
{
@ -3134,7 +3140,7 @@
{
"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.",
"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"
},
{
@ -3297,7 +3303,7 @@
{
"key": "menu_button",
"disabled": true,
"description": "Optional. A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault",
"description": "Optional. A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault",
"type": "text",
"value": "MenuButtonDefault"
}
@ -3758,7 +3764,7 @@
{
"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 »",
"description": "Required. Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -3856,7 +3862,7 @@
{
"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 »",
"description": "Required. PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files »",
"type": "text"
}
]
@ -3893,7 +3899,7 @@
{
"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.",
"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"
},
{
@ -3905,7 +3911,7 @@
{
"key": "png_sticker",
"disabled": true,
"description": "Optional. PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »",
"description": "Optional. PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -3978,7 +3984,7 @@
{
"key": "png_sticker",
"disabled": true,
"description": "Optional. PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »",
"description": "Optional. PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"type": "text"
},
{
@ -4113,7 +4119,7 @@
{
"key": "thumb",
"disabled": true,
"description": "Optional. A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. 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 ». Animated sticker set thumbnails can't be uploaded via HTTP URL.",
"description": "Optional. A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.",
"type": "text"
}
]
@ -4273,7 +4279,7 @@
{
"key": "provider_token",
"disabled": false,
"description": "Required. Payments provider token, obtained via Botfather",
"description": "Required. Payment provider token, obtained via @BotFather",
"type": "text"
},
{
@ -4309,7 +4315,7 @@
{
"key": "provider_data",
"disabled": true,
"description": "Optional. A JSON-serialized 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.",
"description": "Optional. JSON-serialized 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"
},
{
@ -4321,7 +4327,7 @@
{
"key": "photo_size",
"disabled": true,
"description": "Optional. Photo size",
"description": "Optional. Photo size in bytes",
"type": "text"
},
{
@ -4363,13 +4369,13 @@
{
"key": "send_phone_number_to_provider",
"disabled": true,
"description": "Optional. Pass True, if user's phone number should be sent to provider",
"description": "Optional. Pass True, if the 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",
"description": "Optional. Pass True, if the user's email address should be sent to provider",
"type": "text"
},
{
@ -4426,6 +4432,151 @@
"description": "Use this method to send invoices. On success, the sent Message is returned."
}
},
{
"name": "createInvoiceLink",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"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. Payment provider token, obtained via BotFather",
"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": "max_tip_amount",
"disabled": true,
"description": "Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
"type": "text"
},
{
"key": "suggested_tip_amounts",
"disabled": true,
"description": "Optional. A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.",
"type": "text"
},
{
"key": "provider_data",
"disabled": true,
"description": "Optional. JSON-serialized 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.",
"type": "text"
},
{
"key": "photo_size",
"disabled": true,
"description": "Optional. Photo size in bytes",
"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 the user's phone number should be sent to the provider",
"type": "text"
},
{
"key": "send_email_to_provider",
"disabled": true,
"description": "Optional. Pass True, if the user's email address should be sent to the provider",
"type": "text"
},
{
"key": "is_flexible",
"disabled": true,
"description": "Optional. Pass True, if the final price depends on the shipping method",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/createInvoiceLink",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"createInvoiceLink"
]
},
"description": "Use this method to create a link for an invoice. Returns the created invoice link as String on success."
}
},
{
"name": "answerShippingQuery",
"request": {
@ -4571,7 +4722,7 @@
{
"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.",
"description": "Required. Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.",
"type": "text"
},
{