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: 91a5162c56

Browse Source
This commit is contained in:
sys-001 2022-08-12 14:32:07 +00:00
parent d08b04c111
commit 56b967acd5
5 changed files with 739 additions and 420 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

222
schemas/botapi.json
View File

@ -1,5 +1,5 @@
{
"version": "6.1.0",
"version": "6.2.0",
"types": [
{
"name": "Update",
@ -381,6 +381,15 @@
"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": "has_restricted_voice_and_video_messages",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.",
"default": true
},
{
"name": "join_to_send_messages",
"types": [
@ -1002,7 +1011,7 @@
"string"
],
"optional": false,
"description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)"
"description": "Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers)"
},
{
"name": "offset",
@ -1043,6 +1052,14 @@
],
"optional": true,
"description": "Optional. For “pre” only, the programming language of the entity text"
},
{
"name": "custom_emoji_id",
"types": [
"string"
],
"optional": true,
"description": "Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker"
}
],
"extended_by": []
@ -1553,7 +1570,7 @@
"int"
],
"optional": false,
"description": "Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji"
"description": "____simple_html_dom__voku__html_wrapper____>Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji"
}
],
"extended_by": []
@ -2277,7 +2294,7 @@
"string"
],
"optional": false,
"description": "An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization."
"description": "An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization."
},
{
"name": "forward_text",
@ -3594,7 +3611,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the uploaded video is suitable for streaming"
"description": "Optional. Pass True if the uploaded video is suitable for streaming"
}
],
"extended_by": []
@ -3852,6 +3869,14 @@
"optional": false,
"description": "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
},
{
"name": "type",
"types": [
"string"
],
"optional": false,
"description": "Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video."
},
{
"name": "width",
"types": [
@ -3914,7 +3939,7 @@
"File"
],
"optional": true,
"description": "Optional. Premium animation for the sticker, if the sticker is premium"
"description": "Optional. For premium regular stickers, premium animation for the sticker"
},
{
"name": "mask_position",
@ -3924,6 +3949,14 @@
"optional": true,
"description": "Optional. For mask stickers, the position where the mask should be placed"
},
{
"name": "custom_emoji_id",
"types": [
"string"
],
"optional": true,
"description": "Optional. For custom emoji stickers, unique identifier of the custom emoji"
},
{
"name": "file_size",
"types": [
@ -3955,6 +3988,14 @@
"optional": false,
"description": "Sticker set title"
},
{
"name": "sticker_type",
"types": [
"string"
],
"optional": false,
"description": "Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”"
},
{
"name": "is_animated",
"types": [
@ -3971,14 +4012,6 @@
"optional": false,
"description": "True, if the sticker set contains video stickers"
},
{
"name": "contains_masks",
"types": [
"bool"
],
"optional": false,
"description": "True, if the sticker set contains masks"
},
{
"name": "stickers",
"types": [
@ -4178,7 +4211,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if you don't want the URL to be shown in the message"
"description": "Optional. Pass True if you don't want the URL to be shown in the message"
},
{
"name": "description",
@ -6340,7 +6373,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if you require the user's full name to complete the order"
"description": "Optional. Pass True if you require the user's full name to complete the order"
},
{
"name": "need_phone_number",
@ -6348,7 +6381,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if you require the user's phone number to complete the order"
"description": "Optional. Pass True if you require the user's phone number to complete the order"
},
{
"name": "need_email",
@ -6356,7 +6389,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if you require the user's email address to complete the order"
"description": "Optional. Pass True if you require the user's email address to complete the order"
},
{
"name": "need_shipping_address",
@ -6364,7 +6397,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if you require the user's shipping address to complete the order"
"description": "Optional. Pass True if you require the user's shipping address to complete the order"
},
{
"name": "send_phone_number_to_provider",
@ -6372,7 +6405,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the 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",
@ -6380,7 +6413,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the 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",
@ -6388,7 +6421,7 @@
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the final price depends on the shipping method"
"description": "Optional. Pass True if the final price depends on the shipping method"
}
],
"extended_by": []
@ -7475,7 +7508,7 @@
"methods": [
{
"name": "getUpdates",
"description": "Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.",
"description": "Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.",
"fields": [
{
"name": "offset",
@ -7706,7 +7739,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -7777,7 +7810,7 @@
},
{
"name": "copyMessage",
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
"fields": [
{
"name": "chat_id",
@ -7859,7 +7892,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -7953,7 +7986,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8080,7 +8113,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8191,7 +8224,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8294,7 +8327,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the uploaded video is suitable for streaming"
"description": "Pass True if the uploaded video is suitable for streaming"
},
{
"name": "disable_notification",
@ -8326,7 +8359,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8453,7 +8486,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8555,7 +8588,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8650,7 +8683,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -8719,7 +8752,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
}
],
"return_types": [
@ -8817,7 +8850,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -9068,7 +9101,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -9161,7 +9194,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -9289,7 +9322,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the poll needs to be immediately closed. This can be useful for poll preview."
"description": "Pass True if the poll needs to be immediately closed. This can be useful for poll preview."
},
{
"name": "disable_notification",
@ -9321,7 +9354,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -9358,7 +9391,7 @@
"string"
],
"optional": true,
"description": "Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”",
"description": "____simple_html_dom__voku__html_wrapper____>Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”",
"default": "🎲"
},
{
@ -9391,7 +9424,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -9631,7 +9664,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator's presence in the chat is hidden"
"description": "Pass True if the administrator's presence in the chat is hidden"
},
{
"name": "can_manage_chat",
@ -9639,7 +9672,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege"
"description": "Pass True if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege"
},
{
"name": "can_post_messages",
@ -9647,7 +9680,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can create channel posts, channels only"
"description": "Pass True if the administrator can create channel posts, channels only"
},
{
"name": "can_edit_messages",
@ -9655,7 +9688,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can edit messages of other users and can pin messages, channels only"
"description": "Pass True if the administrator can edit messages of other users and can pin messages, channels only"
},
{
"name": "can_delete_messages",
@ -9663,7 +9696,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can delete messages of other users"
"description": "Pass True if the administrator can delete messages of other users"
},
{
"name": "can_manage_video_chats",
@ -9671,7 +9704,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can manage video chats"
"description": "Pass True if the administrator can manage video chats"
},
{
"name": "can_restrict_members",
@ -9679,7 +9712,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can restrict, ban or unban chat members"
"description": "Pass True if the administrator can restrict, ban or unban chat members"
},
{
"name": "can_promote_members",
@ -9687,7 +9720,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)"
"description": "Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)"
},
{
"name": "can_change_info",
@ -9695,7 +9728,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can change chat title, photo and other settings"
"description": "Pass True if the administrator can change chat title, photo and other settings"
},
{
"name": "can_invite_users",
@ -9703,7 +9736,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can invite new users to the chat"
"description": "Pass True if the administrator can invite new users to the chat"
},
{
"name": "can_pin_messages",
@ -9711,7 +9744,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the administrator can pin messages, supergroups only"
"description": "Pass True if the administrator can pin messages, supergroups only"
}
],
"return_types": [
@ -10157,7 +10190,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats."
"description": "Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats."
}
],
"return_types": [
@ -10246,7 +10279,7 @@
},
{
"name": "getChatAdministrators",
"description": "Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.",
"description": "Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.",
"fields": [
{
"name": "chat_id",
@ -10463,7 +10496,7 @@
},
{
"name": "getMyCommands",
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.",
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.",
"fields": [
{
"name": "scope",
@ -10920,7 +10953,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -10955,6 +10988,23 @@
"StickerSet"
]
},
{
"name": "getCustomEmojiStickers",
"description": "Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.",
"fields": [
{
"name": "custom_emoji_ids",
"types": [
"Array<string>"
],
"optional": false,
"description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified."
}
],
"return_types": [
"Array<Sticker>"
]
},
{
"name": "uploadStickerFile",
"description": "Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.",
@ -11033,6 +11083,14 @@
"optional": true,
"description": "WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements"
},
{
"name": "sticker_type",
"types": [
"string"
],
"optional": true,
"description": "Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created."
},
{
"name": "emojis",
"types": [
@ -11041,14 +11099,6 @@
"optional": false,
"description": "One or more emoji corresponding to the sticker"
},
{
"name": "contains_masks",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if a set of mask stickers should be created"
},
{
"name": "mask_position",
"types": [
@ -11239,7 +11289,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query"
"description": "Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query"
},
{
"name": "next_offset",
@ -11427,7 +11477,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's full name to complete the order"
"description": "Pass True if you require the user's full name to complete the order"
},
{
"name": "need_phone_number",
@ -11435,7 +11485,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's phone number to complete the order"
"description": "Pass True if you require the user's phone number to complete the order"
},
{
"name": "need_email",
@ -11443,7 +11493,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's email address to complete the order"
"description": "Pass True if you require the user's email address to complete the order"
},
{
"name": "need_shipping_address",
@ -11451,7 +11501,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's shipping address to complete the order"
"description": "Pass True if you require the user's shipping address to complete the order"
},
{
"name": "send_phone_number_to_provider",
@ -11459,7 +11509,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the 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",
@ -11467,7 +11517,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the 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",
@ -11475,7 +11525,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the final price depends on the shipping method"
"description": "Pass True if the final price depends on the shipping method"
},
{
"name": "disable_notification",
@ -11507,7 +11557,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -11637,7 +11687,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's full name to complete the order"
"description": "Pass True if you require the user's full name to complete the order"
},
{
"name": "need_phone_number",
@ -11645,7 +11695,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's phone number to complete the order"
"description": "Pass True if you require the user's phone number to complete the order"
},
{
"name": "need_email",
@ -11653,7 +11703,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's email address to complete the order"
"description": "Pass True if you require the user's email address to complete the order"
},
{
"name": "need_shipping_address",
@ -11661,7 +11711,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if you require the user's shipping address to complete the order"
"description": "Pass True if you require the user's shipping address to complete the order"
},
{
"name": "send_phone_number_to_provider",
@ -11669,7 +11719,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the user's phone number should be sent to the provider"
"description": "Pass True if the user's phone number should be sent to the provider"
},
{
"name": "send_email_to_provider",
@ -11677,7 +11727,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the user's email address should be sent to the provider"
"description": "Pass True if the user's email address should be sent to the provider"
},
{
"name": "is_flexible",
@ -11685,7 +11735,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the final price depends on the shipping method"
"description": "Pass True if the final price depends on the shipping method"
}
],
"return_types": [
@ -11710,7 +11760,7 @@
"bool"
],
"optional": false,
"description": "Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)"
"description": "Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)"
},
{
"name": "shipping_options",
@ -11841,7 +11891,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the message should be sent even if the specified replied-to message is not found"
"description": "Pass True if the message should be sent even if the specified replied-to message is not found"
},
{
"name": "reply_markup",
@ -11882,7 +11932,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"
"description": "Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"
},
{
"name": "disable_edit_message",
@ -11890,7 +11940,7 @@
"bool"
],
"optional": true,
"description": "Pass True, if the game message should not be automatically edited to include the current scoreboard"
"description": "Pass True if the game message should not be automatically edited to include the current scoreboard"
},
{
"name": "chat_id",
@ -11924,7 +11974,7 @@
},
{
"name": "getGameHighScores",
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.",
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.",
"fields": [
{
"name": "user_id",

455
schemas/botapi.yaml
View File

File diff suppressed because it is too large Load Diff

161
schemas/botapi_openapi.json
View File

@ -3,7 +3,7 @@
"info": {
"title": "Telegram Bot API",
"description": "Auto-generated OpenAPI schema by TGScraper.",
"version": "6.1.0"
"version": "6.2.0"
},
"servers": [
{
@ -337,6 +337,10 @@
"type": "boolean",
"default": true
},
"has_restricted_voice_and_video_messages": {
"type": "boolean",
"default": true
},
"join_to_send_messages": {
"type": "boolean",
"default": true
@ -629,6 +633,9 @@
},
"language": {
"type": "string"
},
"custom_emoji_id": {
"type": "string"
}
},
"type": "object"
@ -2339,6 +2346,7 @@
"required": [
"file_id",
"file_unique_id",
"type",
"width",
"height",
"is_animated",
@ -2351,6 +2359,9 @@
"file_unique_id": {
"type": "string"
},
"type": {
"type": "string"
},
"width": {
"type": "integer"
},
@ -2378,6 +2389,9 @@
"mask_position": {
"$ref": "#/components/schemas/MaskPosition"
},
"custom_emoji_id": {
"type": "string"
},
"file_size": {
"type": "integer"
}
@ -2389,9 +2403,9 @@
"required": [
"name",
"title",
"sticker_type",
"is_animated",
"is_video",
"contains_masks",
"stickers"
],
"properties": {
@ -2401,15 +2415,15 @@
"title": {
"type": "string"
},
"sticker_type": {
"type": "string"
},
"is_animated": {
"type": "boolean"
},
"is_video": {
"type": "boolean"
},
"contains_masks": {
"type": "boolean"
},
"stickers": {
"type": "array",
"items": {
@ -4386,7 +4400,7 @@
},
"paths": {
"/getUpdates": {
"description": "Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.",
"description": "Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.",
"post": {
"requestBody": {
"content": {
@ -5484,7 +5498,7 @@
}
},
"/copyMessage": {
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
"post": {
"requestBody": {
"required": true,
@ -13306,7 +13320,7 @@
}
},
"/getChatAdministrators": {
"description": "Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.",
"description": "Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.",
"post": {
"requestBody": {
"required": true,
@ -14282,7 +14296,7 @@
}
},
"/getMyCommands": {
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.",
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.",
"post": {
"requestBody": {
"content": {
@ -16031,6 +16045,115 @@
}
}
},
"/getCustomEmojiStickers": {
"description": "Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.",
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"custom_emoji_ids"
],
"properties": {
"custom_emoji_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"custom_emoji_ids"
],
"properties": {
"custom_emoji_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"custom_emoji_ids"
],
"properties": {
"custom_emoji_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Request was successful, the result is returned.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Success"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Sticker"
}
}
}
}
]
}
}
}
},
"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"
}
}
}
},
"/uploadStickerFile": {
"description": "Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.",
"post": {
@ -16181,11 +16304,11 @@
"webm_sticker": {
"$ref": "#/components/schemas/InputFile"
},
"emojis": {
"sticker_type": {
"type": "string"
},
"contains_masks": {
"type": "boolean"
"emojis": {
"type": "string"
},
"mask_position": {
"$ref": "#/components/schemas/MaskPosition"
@ -16228,11 +16351,11 @@
"webm_sticker": {
"$ref": "#/components/schemas/InputFile"
},
"emojis": {
"sticker_type": {
"type": "string"
},
"contains_masks": {
"type": "boolean"
"emojis": {
"type": "string"
},
"mask_position": {
"$ref": "#/components/schemas/MaskPosition"
@ -16275,11 +16398,11 @@
"webm_sticker": {
"$ref": "#/components/schemas/InputFile"
},
"emojis": {
"sticker_type": {
"type": "string"
},
"contains_masks": {
"type": "boolean"
"emojis": {
"type": "string"
},
"mask_position": {
"$ref": "#/components/schemas/MaskPosition"
@ -18514,7 +18637,7 @@
}
},
"/getGameHighScores": {
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.",
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.",
"post": {
"requestBody": {
"required": true,

164
schemas/botapi_openapi.yaml
View File

@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: 'Telegram Bot API'
description: 'Auto-generated OpenAPI schema by TGScraper.'
version: 6.1.0
version: 6.2.0
servers:
-
url: 'https://api.telegram.org/bot{token}'
variables:
token:
default: '1234:AAbbcc'
description: 'Bot''s unique authentication token, given by @BotFather.'
description: "Bot's unique authentication token, given by @BotFather."
externalDocs:
description: 'Official Telegram Bot API documentation.'
url: 'https://core.telegram.org/bots/api'
@ -46,7 +46,7 @@ components:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: 'You''re doing too many requests, retry after a while.'
description: "You're doing too many requests, retry after a while."
content:
application/json:
schema:
@ -222,6 +222,9 @@ components:
has_private_forwards:
type: boolean
default: true
has_restricted_voice_and_video_messages:
type: boolean
default: true
join_to_send_messages:
type: boolean
default: true
@ -422,6 +425,8 @@ components:
$ref: '#/components/schemas/User'
language:
type: string
custom_emoji_id:
type: string
type: object
PhotoSize:
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
@ -784,7 +789,7 @@ components:
$ref: '#/components/schemas/User'
type: object
UserProfilePhotos:
description: 'This object represent a user''s profile pictures.'
description: "This object represent a user's profile pictures."
required:
- total_count
- photos
@ -947,7 +952,7 @@ components:
type: string
type: object
ForceReply:
description: 'Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot''s message and tapped ''Reply''). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.'
description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode."
required:
- force_reply
properties:
@ -1169,7 +1174,7 @@ components:
type: integer
type: object
ChatMemberLeft:
description: 'Represents a chat member that isn''t currently a member of the chat, but may join it themselves.'
description: "Represents a chat member that isn't currently a member of the chat, but may join it themselves."
required:
- status
- user
@ -1180,7 +1185,7 @@ components:
$ref: '#/components/schemas/User'
type: object
ChatMemberBanned:
description: 'Represents a chat member that was banned in the chat and can''t return to the chat or view chat messages.'
description: "Represents a chat member that was banned in the chat and can't return to the chat or view chat messages."
required:
- status
- user
@ -1380,7 +1385,7 @@ components:
type: integer
type: object
MenuButton:
description: 'This object describes the bot''s menu button in a private chat. It should be one of'
description: "This object describes the bot's menu button in a private chat. It should be one of"
anyOf:
-
$ref: '#/components/schemas/MenuButtonCommands'
@ -1389,7 +1394,7 @@ components:
-
$ref: '#/components/schemas/MenuButtonDefault'
MenuButtonCommands:
description: 'Represents a menu button, which opens the bot''s list of commands.'
description: "Represents a menu button, which opens the bot's list of commands."
required:
- type
properties:
@ -1596,6 +1601,7 @@ components:
required:
- file_id
- file_unique_id
- type
- width
- height
- is_animated
@ -1605,6 +1611,8 @@ components:
type: string
file_unique_id:
type: string
type:
type: string
width:
type: integer
height:
@ -1623,6 +1631,8 @@ components:
$ref: '#/components/schemas/File'
mask_position:
$ref: '#/components/schemas/MaskPosition'
custom_emoji_id:
type: string
file_size:
type: integer
type: object
@ -1631,21 +1641,21 @@ components:
required:
- name
- title
- sticker_type
- is_animated
- is_video
- contains_masks
- stickers
properties:
name:
type: string
title:
type: string
sticker_type:
type: string
is_animated:
type: boolean
is_video:
type: boolean
contains_masks:
type: boolean
stickers:
type: array
items:
@ -2724,7 +2734,7 @@ components:
$ref: '#/components/schemas/EncryptedCredentials'
type: object
PassportFile:
description: 'This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don''t exceed 10MB.'
description: "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB."
required:
- file_id
- file_unique_id
@ -2807,7 +2817,7 @@ components:
-
$ref: '#/components/schemas/PassportElementErrorUnspecified'
PassportElementErrorDataField:
description: 'Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field''s value changes.'
description: "Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes."
required:
- source
- type
@ -3018,7 +3028,7 @@ components:
type: object
paths:
/getUpdates:
description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.'
description: 'Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.'
post:
requestBody:
content:
@ -3302,7 +3312,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getMe:
description: 'A simple method for testing your bot''s authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.'
description: "A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object."
post:
requestBody:
content:
@ -3390,7 +3400,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/close:
description: 'Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn''t launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.'
description: "Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters."
post:
requestBody:
content:
@ -3593,7 +3603,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/forwardMessage:
description: 'Use this method to forward messages of any kind. Service messages can''t be forwarded. On success, the sent Message is returned.'
description: "Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned."
post:
requestBody:
required: true
@ -3707,7 +3717,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/copyMessage:
description: 'Use this method to copy messages of any kind. Service messages and invoice messages can''t be copied. The method is analogous to the method forwardMessage, but the copied message doesn''t have a link to the original message. Returns the MessageId of the sent message on success.'
description: "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success."
post:
requestBody:
required: true
@ -6761,7 +6771,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/unbanChatMember:
description: 'Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don''t want this, use the parameter only_if_banned. Returns True on success.'
description: "Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success."
post:
requestBody:
required: true
@ -7181,7 +7191,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/banChatSenderChat:
description: 'Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won''t be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.'
description: "Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success."
post:
requestBody:
required: true
@ -7940,7 +7950,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setChatPhoto:
description: 'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.'
description: "Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
post:
requestBody:
required: true
@ -8021,7 +8031,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/deleteChatPhoto:
description: 'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.'
description: "Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
post:
requestBody:
required: true
@ -8093,7 +8103,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setChatTitle:
description: 'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.'
description: "Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
post:
requestBody:
required: true
@ -8252,7 +8262,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/pinChatMessage:
description: 'Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.'
description: "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
post:
requestBody:
required: true
@ -8339,7 +8349,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/unpinChatMessage:
description: 'Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.'
description: "Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
post:
requestBody:
required: true
@ -8417,7 +8427,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/unpinAllChatMessages:
description: 'Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the ''can_pin_messages'' administrator right in a supergroup or ''can_edit_messages'' administrator right in a channel. Returns True on success.'
description: "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
post:
requestBody:
required: true
@ -8633,7 +8643,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getChatAdministrators:
description: 'Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.'
description: "Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects."
post:
requestBody:
required: true
@ -9097,7 +9107,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setMyCommands:
description: 'Use this method to change the list of the bot''s commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success.'
description: "Use this method to change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. Returns True on success."
post:
requestBody:
required: true
@ -9178,7 +9188,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/deleteMyCommands:
description: 'Use this method to delete the list of the bot''s commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.'
description: "Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success."
post:
requestBody:
content:
@ -9240,7 +9250,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getMyCommands:
description: 'Use this method to get the current list of the bot''s commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren''t set, an empty list is returned.'
description: "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned."
post:
requestBody:
content:
@ -9304,7 +9314,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setChatMenuButton:
description: 'Use this method to change the bot''s menu button in a private chat, or the default menu button. Returns True on success.'
description: "Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success."
post:
requestBody:
content:
@ -9366,7 +9376,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getChatMenuButton:
description: 'Use this method to get the current value of the bot''s menu button in a private chat, or the default menu button. Returns MenuButton on success.'
description: "Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success."
post:
requestBody:
content:
@ -9419,7 +9429,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setMyDefaultAdministratorRights:
description: 'Use this method to change the default administrator rights requested by the bot when it''s added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.'
description: "Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success."
post:
requestBody:
content:
@ -9766,7 +9776,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/editMessageMedia:
description: 'Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can''t be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.'
description: "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
post:
requestBody:
required: true
@ -10327,6 +10337,74 @@ paths:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/getCustomEmojiStickers:
description: 'Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.'
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- custom_emoji_ids
properties:
custom_emoji_ids:
type: array
items:
type: string
application/x-www-form-urlencoded:
schema:
type: object
required:
- custom_emoji_ids
properties:
custom_emoji_ids:
type: array
items:
type: string
multipart/form-data:
schema:
type: object
required:
- custom_emoji_ids
properties:
custom_emoji_ids:
type: array
items:
type: string
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/Sticker'
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'
/uploadStickerFile:
description: 'Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.'
post:
@ -10427,10 +10505,10 @@ paths:
$ref: '#/components/schemas/InputFile'
webm_sticker:
$ref: '#/components/schemas/InputFile'
sticker_type:
type: string
emojis:
type: string
contains_masks:
type: boolean
mask_position:
$ref: '#/components/schemas/MaskPosition'
application/x-www-form-urlencoded:
@ -10458,10 +10536,10 @@ paths:
$ref: '#/components/schemas/InputFile'
webm_sticker:
$ref: '#/components/schemas/InputFile'
sticker_type:
type: string
emojis:
type: string
contains_masks:
type: boolean
mask_position:
$ref: '#/components/schemas/MaskPosition'
multipart/form-data:
@ -10489,10 +10567,10 @@ paths:
$ref: '#/components/schemas/InputFile'
webm_sticker:
$ref: '#/components/schemas/InputFile'
sticker_type:
type: string
emojis:
type: string
contains_masks:
type: boolean
mask_position:
$ref: '#/components/schemas/MaskPosition'
responses:
@ -11828,7 +11906,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/setGameScore:
description: 'Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user''s current score in the chat and force is False.'
description: "Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False."
post:
requestBody:
required: true
@ -11931,7 +12009,7 @@ paths:
default:
$ref: '#/components/responses/UnknownError'
/getGameHighScores:
description: 'Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.'
description: 'Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.'
post:
requestBody:
required: true

157
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.1.0"
"version": "6.2.0"
},
"variable": {
"key": "token",
@ -59,7 +59,7 @@
"getUpdates"
]
},
"description": "Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned."
"description": "Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects."
}
},
{
@ -315,7 +315,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -461,7 +461,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -485,7 +485,7 @@
"copyMessage"
]
},
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success."
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success."
}
},
{
@ -546,7 +546,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -655,7 +655,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -752,7 +752,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -843,7 +843,7 @@
{
"key": "supports_streaming",
"disabled": true,
"description": "Optional. Pass True, if the uploaded video is suitable for streaming",
"description": "Optional. Pass True if the uploaded video is suitable for streaming",
"type": "text"
},
{
@ -867,7 +867,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -976,7 +976,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1067,7 +1067,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1152,7 +1152,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1219,7 +1219,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
}
]
@ -1310,7 +1310,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1547,7 +1547,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1632,7 +1632,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1743,7 +1743,7 @@
{
"key": "is_closed",
"disabled": true,
"description": "Optional. Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.",
"description": "Optional. Pass True if the poll needs to be immediately closed. This can be useful for poll preview.",
"type": "text"
},
{
@ -1767,7 +1767,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -1810,7 +1810,7 @@
{
"key": "emoji",
"disabled": true,
"description": "Optional. Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”",
"description": "Optional. ____simple_html_dom__voku__html_wrapper____>Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”",
"type": "text",
"value": "🎲"
},
@ -1835,7 +1835,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -2137,67 +2137,67 @@
{
"key": "is_anonymous",
"disabled": true,
"description": "Optional. Pass True, if the administrator's presence in the chat is hidden",
"description": "Optional. Pass True if the administrator's presence in the chat is hidden",
"type": "text"
},
{
"key": "can_manage_chat",
"disabled": true,
"description": "Optional. Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"description": "Optional. Pass True if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"type": "text"
},
{
"key": "can_post_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can create channel posts, channels only",
"description": "Optional. Pass True if the administrator can create channel posts, channels only",
"type": "text"
},
{
"key": "can_edit_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can edit messages of other users and can pin messages, channels only",
"description": "Optional. Pass True if the administrator can edit messages of other users and can pin messages, channels only",
"type": "text"
},
{
"key": "can_delete_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can delete messages of other users",
"description": "Optional. Pass True if the administrator can delete messages of other users",
"type": "text"
},
{
"key": "can_manage_video_chats",
"disabled": true,
"description": "Optional. Pass True, if the administrator can manage video chats",
"description": "Optional. Pass True if the administrator can manage video chats",
"type": "text"
},
{
"key": "can_restrict_members",
"disabled": true,
"description": "Optional. Pass True, if the administrator can restrict, ban or unban chat members",
"description": "Optional. Pass True if the administrator can restrict, ban or unban chat members",
"type": "text"
},
{
"key": "can_promote_members",
"disabled": true,
"description": "Optional. Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)",
"description": "Optional. Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)",
"type": "text"
},
{
"key": "can_change_info",
"disabled": true,
"description": "Optional. Pass True, if the administrator can change chat title, photo and other settings",
"description": "Optional. Pass True if the administrator can change chat title, photo and other settings",
"type": "text"
},
{
"key": "can_invite_users",
"disabled": true,
"description": "Optional. Pass True, if the administrator can invite new users to the chat",
"description": "Optional. Pass True if the administrator can invite new users to the chat",
"type": "text"
},
{
"key": "can_pin_messages",
"disabled": true,
"description": "Optional. Pass True, if the administrator can pin messages, supergroups only",
"description": "Optional. Pass True if the administrator can pin messages, supergroups only",
"type": "text"
}
]
@ -2794,7 +2794,7 @@
{
"key": "disable_notification",
"disabled": true,
"description": "Optional. Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.",
"description": "Optional. Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.",
"type": "text"
}
]
@ -2973,7 +2973,7 @@
"getChatAdministrators"
]
},
"description": "Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned."
"description": "Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects."
}
},
{
@ -3284,7 +3284,7 @@
"getMyCommands"
]
},
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns Array of BotCommand on success. If commands aren't set, an empty list is returned."
"description": "Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned."
}
},
{
@ -3788,7 +3788,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -3846,6 +3846,37 @@
"description": "Use this method to get a sticker set. On success, a StickerSet object is returned."
}
},
{
"name": "getCustomEmojiStickers",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "custom_emoji_ids",
"disabled": false,
"description": "Required. List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getCustomEmojiStickers",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getCustomEmojiStickers"
]
},
"description": "Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects."
}
},
{
"name": "uploadStickerFile",
"request": {
@ -3927,15 +3958,15 @@
"type": "text"
},
{
"key": "emojis",
"disabled": false,
"description": "Required. One or more emoji corresponding to the sticker",
"key": "sticker_type",
"disabled": true,
"description": "Optional. Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created.",
"type": "text"
},
{
"key": "contains_masks",
"disabled": true,
"description": "Optional. Pass True, if a set of mask stickers should be created",
"key": "emojis",
"disabled": false,
"description": "Required. One or more emoji corresponding to the sticker",
"type": "text"
},
{
@ -4169,7 +4200,7 @@
{
"key": "is_personal",
"disabled": true,
"description": "Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"description": "Optional. Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"type": "text"
},
{
@ -4345,43 +4376,43 @@
{
"key": "need_name",
"disabled": true,
"description": "Optional. Pass True, if you require the user's full name to complete the order",
"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",
"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",
"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",
"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 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 the 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"
},
{
"key": "is_flexible",
"disabled": true,
"description": "Optional. Pass True, if the final price depends on the shipping method",
"description": "Optional. Pass True if the final price depends on the shipping method",
"type": "text"
},
{
@ -4405,7 +4436,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -4520,43 +4551,43 @@
{
"key": "need_name",
"disabled": true,
"description": "Optional. Pass True, if you require the user's full name to complete the order",
"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",
"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",
"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",
"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",
"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",
"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",
"description": "Optional. Pass True if the final price depends on the shipping method",
"type": "text"
}
]
@ -4593,7 +4624,7 @@
{
"key": "ok",
"disabled": false,
"description": "Required. Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)",
"description": "Required. Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)",
"type": "text"
},
{
@ -4746,7 +4777,7 @@
{
"key": "allow_sending_without_reply",
"disabled": true,
"description": "Optional. Pass True, if the message should be sent even if the specified replied-to message is not found",
"description": "Optional. Pass True if the message should be sent even if the specified replied-to message is not found",
"type": "text"
},
{
@ -4795,13 +4826,13 @@
{
"key": "force",
"disabled": true,
"description": "Optional. Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters",
"description": "Optional. Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters",
"type": "text"
},
{
"key": "disable_edit_message",
"disabled": true,
"description": "Optional. Pass True, if the game message should not be automatically edited to include the current scoreboard",
"description": "Optional. Pass True if the game message should not be automatically edited to include the current scoreboard",
"type": "text"
},
{
@ -4886,7 +4917,7 @@
"getGameHighScores"
]
},
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects."
"description": "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects."
}
}
]