davtur19/tgscraper
1
0
Fork 0
mirror of https://github.com/Sysbot-org/tgscraper.git synced 2024-11-23 03:56:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 9d0cdff59b

Browse Source
This commit is contained in:
sys-001 2024-06-07 12:18:11 +00:00
parent ed594e537f
commit f653ab8306
5 changed files with 1404 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

400
schemas/botapi.json
View File

@ -1,5 +1,5 @@
{
"version": "7.3.0",
"version": "7.4.0",
"types": [
{
"name": "Update",
@ -59,7 +59,7 @@
"Message"
],
"optional": true,
"description": "Optional. New non-service message from a connected business account"
"description": "Optional. New message from a connected business account"
},
{
"name": "edited_business_message",
@ -662,7 +662,7 @@
"bool"
],
"optional": true,
"description": "Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators",
"description": "Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators",
"default": true
},
{
@ -1009,6 +1009,14 @@
"optional": true,
"description": "Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed"
},
{
"name": "effect_id",
"types": [
"string"
],
"optional": true,
"description": "Optional. Unique identifier of the message effect added to the message"
},
{
"name": "animation",
"types": [
@ -1097,6 +1105,15 @@
"optional": true,
"description": "Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. True, if the caption must be shown above the message media",
"default": true
},
{
"name": "has_media_spoiler",
"types": [
@ -1530,7 +1547,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), “blockquote” (block quotation), “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)"
"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), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “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",
@ -3943,7 +3960,7 @@
},
{
"name": "KeyboardButton",
"description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.",
"description": "This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.",
"fields": [
{
"name": "text",
@ -4219,7 +4236,7 @@
},
{
"name": "InlineKeyboardButton",
"description": "This object represents one button of an inline keyboard. You must use exactly one of the optional fields.",
"description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
"fields": [
{
"name": "text",
@ -4299,7 +4316,7 @@
"bool"
],
"optional": true,
"description": "Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages."
"description": "Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages."
}
],
"extended_by": []
@ -4788,7 +4805,7 @@
"bool"
],
"optional": true,
"description": "Optional. True, if the user joined the chat after sending a direct join request and being approved by an administrator"
"description": "Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator"
},
{
"name": "via_chat_folder_invite_link",
@ -6468,6 +6485,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "has_spoiler",
"types": [
@ -6533,6 +6558,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "width",
"types": [
@ -6630,6 +6663,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "width",
"types": [
@ -7381,6 +7422,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -7502,6 +7551,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -7623,6 +7680,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -7719,6 +7784,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "video_width",
"types": [
@ -8527,6 +8600,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -8607,6 +8688,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -8687,6 +8776,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -8911,6 +9008,14 @@
"optional": true,
"description": "Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Optional. Pass True, if the caption must be shown above the message media"
},
{
"name": "reply_markup",
"types": [
@ -9331,8 +9436,8 @@
"types": [
"string"
],
"optional": false,
"description": "Payment provider token, obtained via @BotFather"
"optional": true,
"description": "Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars."
},
{
"name": "currency",
@ -9340,7 +9445,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code, see more on currencies"
"description": "Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars."
},
{
"name": "prices",
@ -9348,7 +9453,7 @@
"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.)"
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars."
},
{
"name": "max_tip_amount",
@ -9356,7 +9461,7 @@
"int"
],
"optional": 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",
"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. Not supported for payments in Telegram Stars.",
"default": 0
},
{
@ -9413,7 +9518,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_phone_number",
@ -9421,7 +9526,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_email",
@ -9429,7 +9534,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_shipping_address",
@ -9437,7 +9542,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. Ignored for payments in Telegram Stars."
},
{
"name": "send_phone_number_to_provider",
@ -9445,7 +9550,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 the provider. Ignored for payments in Telegram Stars."
},
{
"name": "send_email_to_provider",
@ -9453,7 +9558,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 the provider. Ignored for payments in Telegram Stars."
},
{
"name": "is_flexible",
@ -9461,7 +9566,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. Ignored for payments in Telegram Stars."
}
],
"extended_by": []
@ -9585,7 +9690,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code"
"description": "Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars"
},
{
"name": "total_amount",
@ -9733,7 +9838,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code"
"description": "Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars"
},
{
"name": "total_amount",
@ -9851,7 +9956,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code"
"description": "Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars"
},
{
"name": "total_amount",
@ -10781,6 +10886,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -10985,6 +11098,14 @@
"optional": true,
"description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified."
},
{
"name": "disable_notification",
"types": [
@ -11154,6 +11275,14 @@
"optional": true,
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the caption must be shown above the message media"
},
{
"name": "has_spoiler",
"types": [
@ -11178,6 +11307,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11313,6 +11450,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11432,6 +11577,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11551,6 +11704,14 @@
"optional": true,
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the caption must be shown above the message media"
},
{
"name": "has_spoiler",
"types": [
@ -11583,6 +11744,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11702,6 +11871,14 @@
"optional": true,
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the caption must be shown above the message media"
},
{
"name": "has_spoiler",
"types": [
@ -11726,6 +11903,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11836,6 +12021,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -11939,6 +12132,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12016,6 +12217,14 @@
"optional": true,
"description": "Protects the contents of the sent messages from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12122,6 +12331,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12255,6 +12472,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12356,6 +12581,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12540,6 +12773,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -12618,6 +12859,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -14520,6 +14769,14 @@
"optional": true,
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode"
},
{
"name": "show_caption_above_media",
"types": [
"bool"
],
"optional": true,
"description": "Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages."
},
{
"name": "reply_markup",
"types": [
@ -14910,6 +15167,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -15491,8 +15756,8 @@
"types": [
"string"
],
"optional": false,
"description": "Payment provider token, obtained via @BotFather"
"optional": true,
"description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars."
},
{
"name": "currency",
@ -15500,7 +15765,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code, see more on currencies"
"description": "Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars."
},
{
"name": "prices",
@ -15508,7 +15773,7 @@
"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.)"
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars."
},
{
"name": "max_tip_amount",
@ -15516,7 +15781,7 @@
"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",
"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. Not supported for payments in Telegram Stars.",
"default": 0
},
{
@ -15581,7 +15846,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_phone_number",
@ -15589,7 +15854,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_email",
@ -15597,7 +15862,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_shipping_address",
@ -15605,7 +15870,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. Ignored for payments in Telegram Stars."
},
{
"name": "send_phone_number_to_provider",
@ -15613,7 +15878,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 the provider. Ignored for payments in Telegram Stars."
},
{
"name": "send_email_to_provider",
@ -15621,7 +15886,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 the provider. Ignored for payments in Telegram Stars."
},
{
"name": "is_flexible",
@ -15629,7 +15894,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. Ignored for payments in Telegram Stars."
},
{
"name": "disable_notification",
@ -15647,6 +15912,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [
@ -15701,8 +15974,8 @@
"types": [
"string"
],
"optional": false,
"description": "Payment provider token, obtained via BotFather"
"optional": true,
"description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars."
},
{
"name": "currency",
@ -15710,7 +15983,7 @@
"string"
],
"optional": false,
"description": "Three-letter ISO 4217 currency code, see more on currencies"
"description": "Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars."
},
{
"name": "prices",
@ -15718,7 +15991,7 @@
"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.)"
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars."
},
{
"name": "max_tip_amount",
@ -15726,7 +15999,7 @@
"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",
"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. Not supported for payments in Telegram Stars.",
"default": 0
},
{
@ -15783,7 +16056,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_phone_number",
@ -15791,7 +16064,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_email",
@ -15799,7 +16072,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. Ignored for payments in Telegram Stars."
},
{
"name": "need_shipping_address",
@ -15807,7 +16080,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. Ignored for payments in Telegram Stars."
},
{
"name": "send_phone_number_to_provider",
@ -15815,7 +16088,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. Ignored for payments in Telegram Stars."
},
{
"name": "send_email_to_provider",
@ -15823,7 +16096,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. Ignored for payments in Telegram Stars."
},
{
"name": "is_flexible",
@ -15831,7 +16104,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. Ignored for payments in Telegram Stars."
}
],
"return_types": [
@ -15912,6 +16185,31 @@
"bool"
]
},
{
"name": "refundStarPayment",
"description": "Refunds a successful payment in Telegram Stars. Returns True on success.",
"fields": [
{
"name": "user_id",
"types": [
"int"
],
"optional": false,
"description": "Identifier of the user whose payment will be refunded"
},
{
"name": "telegram_payment_charge_id",
"types": [
"string"
],
"optional": false,
"description": "Telegram payment identifier"
}
],
"return_types": [
"bool"
]
},
{
"name": "setPassportDataErrors",
"description": "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.",
@ -15989,6 +16287,14 @@
"optional": true,
"description": "Protects the contents of the sent message from forwarding and saving"
},
{
"name": "message_effect_id",
"types": [
"string"
],
"optional": true,
"description": "Unique identifier of the message effect to be added to the message; for private chats only"
},
{
"name": "reply_parameters",
"types": [

323
schemas/botapi.yaml
View File

@ -1,4 +1,4 @@
version: 7.3.0
version: 7.4.0
types:
-
name: Update
@ -45,7 +45,7 @@ types:
types:
- Message
optional: true
description: 'Optional. New non-service message from a connected business account'
description: 'Optional. New message from a connected business account'
-
name: edited_business_message
types:
@ -498,7 +498,7 @@ types:
types:
- bool
optional: true
description: 'Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators'
description: 'Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators'
default: true
-
name: description
@ -760,6 +760,12 @@ types:
- LinkPreviewOptions
optional: true
description: 'Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed'
-
name: effect_id
types:
- string
optional: true
description: 'Optional. Unique identifier of the message effect added to the message'
-
name: animation
types:
@ -826,6 +832,13 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. True, if the caption must be shown above the message media'
default: true
-
name: has_media_spoiler
types:
@ -1152,7 +1165,7 @@ types:
types:
- 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), “blockquote” (block quotation), “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)'
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), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “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
types:
@ -2956,7 +2969,7 @@ types:
extended_by: { }
-
name: KeyboardButton
description: 'This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.'
description: 'This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.'
fields:
-
name: text
@ -3162,7 +3175,7 @@ types:
extended_by: { }
-
name: InlineKeyboardButton
description: 'This object represents one button of an inline keyboard. You must use exactly one of the optional fields.'
description: 'This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.'
fields:
-
name: text
@ -3223,7 +3236,7 @@ types:
types:
- bool
optional: true
description: 'Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.'
description: "Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages."
extended_by: { }
-
name: LoginUrl
@ -3588,7 +3601,7 @@ types:
types:
- bool
optional: true
description: 'Optional. True, if the user joined the chat after sending a direct join request and being approved by an administrator'
description: 'Optional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator'
-
name: via_chat_folder_invite_link
types:
@ -4845,6 +4858,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: has_spoiler
types:
@ -4894,6 +4913,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: width
types:
@ -4967,6 +4992,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: width
types:
@ -5535,6 +5566,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -5626,6 +5663,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -5717,6 +5760,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -5789,6 +5838,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: video_width
types:
@ -6395,6 +6450,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -6455,6 +6516,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -6515,6 +6582,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -6683,6 +6756,12 @@ types:
- Array<MessageEntity>
optional: true
description: 'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Optional. Pass True, if the caption must be shown above the message media'
-
name: reply_markup
types:
@ -6998,26 +7077,26 @@ types:
name: provider_token
types:
- string
optional: false
description: 'Payment provider token, obtained via @BotFather'
optional: true
description: 'Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.'
-
name: currency
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code, see more on currencies'
description: 'Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.'
-
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.)'
description: 'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.'
-
name: max_tip_amount
types:
- int
optional: 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'
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. Not supported for payments in Telegram Stars.'
default: 0
-
name: suggested_tip_amounts
@ -7060,43 +7139,43 @@ types:
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_phone_number
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_email
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_shipping_address
types:
- 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. Ignored for payments in Telegram Stars."
-
name: send_phone_number_to_provider
types:
- 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 the provider. Ignored for payments in Telegram Stars."
-
name: send_email_to_provider
types:
- 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 the provider. Ignored for payments in Telegram Stars."
-
name: is_flexible
types:
- 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. Ignored for payments in Telegram Stars.'
extended_by: { }
-
name: ChosenInlineResult
@ -7188,7 +7267,7 @@ types:
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code'
description: 'Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars'
-
name: total_amount
types:
@ -7298,7 +7377,7 @@ types:
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code'
description: 'Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars'
-
name: total_amount
types:
@ -7386,7 +7465,7 @@ types:
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code'
description: 'Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars'
-
name: total_amount
types:
@ -8082,6 +8161,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8235,6 +8320,12 @@ methods:
- Array<MessageEntity>
optional: true
description: 'A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified."
-
name: disable_notification
types:
@ -8362,6 +8453,12 @@ methods:
- Array<MessageEntity>
optional: true
description: 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Pass True, if the caption must be shown above the message media'
-
name: has_spoiler
types:
@ -8380,6 +8477,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8482,6 +8585,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8572,6 +8681,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8662,6 +8777,12 @@ methods:
- Array<MessageEntity>
optional: true
description: 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Pass True, if the caption must be shown above the message media'
-
name: has_spoiler
types:
@ -8686,6 +8807,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8776,6 +8903,12 @@ methods:
- Array<MessageEntity>
optional: true
description: 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Pass True, if the caption must be shown above the message media'
-
name: has_spoiler
types:
@ -8794,6 +8927,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8877,6 +9016,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -8955,6 +9100,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9013,6 +9164,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent messages from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9092,6 +9249,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9192,6 +9355,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9268,6 +9437,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9407,6 +9582,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -9466,6 +9647,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -10860,6 +11047,12 @@ methods:
- Array<MessageEntity>
optional: true
description: 'A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name: show_caption_above_media
types:
- bool
optional: true
description: 'Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.'
-
name: reply_markup
types:
@ -11150,6 +11343,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -11574,26 +11773,26 @@ methods:
name: provider_token
types:
- string
optional: false
description: 'Payment provider token, obtained via @BotFather'
optional: true
description: 'Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.'
-
name: currency
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code, see more on currencies'
description: 'Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.'
-
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.)'
description: 'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.'
-
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'
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. Not supported for payments in Telegram Stars.'
default: 0
-
name: suggested_tip_amounts
@ -11642,43 +11841,43 @@ methods:
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_phone_number
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_email
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_shipping_address
types:
- 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. Ignored for payments in Telegram Stars."
-
name: send_phone_number_to_provider
types:
- 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 the provider. Ignored for payments in Telegram Stars."
-
name: send_email_to_provider
types:
- 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 the provider. Ignored for payments in Telegram Stars."
-
name: is_flexible
types:
- 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. Ignored for payments in Telegram Stars.'
-
name: disable_notification
types:
@ -11691,6 +11890,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:
@ -11731,26 +11936,26 @@ methods:
name: provider_token
types:
- string
optional: false
description: 'Payment provider token, obtained via BotFather'
optional: true
description: 'Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.'
-
name: currency
types:
- string
optional: false
description: 'Three-letter ISO 4217 currency code, see more on currencies'
description: 'Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.'
-
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.)'
description: 'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.'
-
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'
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. Not supported for payments in Telegram Stars.'
default: 0
-
name: suggested_tip_amounts
@ -11793,43 +11998,43 @@ methods:
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_phone_number
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_email
types:
- 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. Ignored for payments in Telegram Stars."
-
name: need_shipping_address
types:
- 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. Ignored for payments in Telegram Stars."
-
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"
description: "Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars."
-
name: send_email_to_provider
types:
- 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. Ignored for payments in Telegram Stars."
-
name: is_flexible
types:
- 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. Ignored for payments in Telegram Stars.'
return_types:
- string
-
@ -11886,6 +12091,24 @@ methods:
description: 'Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.'
return_types:
- bool
-
name: refundStarPayment
description: 'Refunds a successful payment in Telegram Stars. Returns True on success.'
fields:
-
name: user_id
types:
- int
optional: false
description: 'Identifier of the user whose payment will be refunded'
-
name: telegram_payment_charge_id
types:
- string
optional: false
description: 'Telegram payment identifier'
return_types:
- bool
-
name: setPassportDataErrors
description: "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues."
@ -11944,6 +12167,12 @@ methods:
- bool
optional: true
description: 'Protects the contents of the sent message from forwarding and saving'
-
name: message_effect_id
types:
- string
optional: true
description: 'Unique identifier of the message effect to be added to the message; for private chats only'
-
name: reply_parameters
types:

360
schemas/botapi_openapi.json
View File

@ -3,7 +3,7 @@
"info": {
"title": "Telegram Bot API",
"description": "Auto-generated OpenAPI schema by TGScraper.",
"version": "7.3.0"
"version": "7.4.0"
},
"servers": [
{
@ -608,6 +608,9 @@
"link_preview_options": {
"$ref": "#/components/schemas/LinkPreviewOptions"
},
"effect_id": {
"type": "string"
},
"animation": {
"$ref": "#/components/schemas/Animation"
},
@ -647,6 +650,10 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean",
"default": true
},
"has_media_spoiler": {
"type": "boolean",
"default": true
@ -2271,7 +2278,7 @@
"type": "object"
},
"KeyboardButton": {
"description": "This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.",
"description": "This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.",
"required": [
"text"
],
@ -2418,7 +2425,7 @@
"type": "object"
},
"InlineKeyboardButton": {
"description": "This object represents one button of an inline keyboard. You must use exactly one of the optional fields.",
"description": "This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.",
"required": [
"text"
],
@ -3826,6 +3833,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
}
@ -3868,6 +3878,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"width": {
"type": "integer"
},
@ -3922,6 +3935,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"width": {
"type": "integer"
},
@ -4390,6 +4406,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -4449,6 +4468,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -4508,6 +4530,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -4559,6 +4584,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"video_width": {
"type": "integer"
},
@ -4956,6 +4984,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -4998,6 +5029,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -5040,6 +5074,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -5159,6 +5196,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
},
@ -5386,7 +5426,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -6856,6 +6895,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -6923,6 +6965,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -6990,6 +7035,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -7513,6 +7561,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"disable_notification": {
"type": "boolean"
},
@ -7588,6 +7639,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"disable_notification": {
"type": "boolean"
},
@ -7663,6 +7717,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"disable_notification": {
"type": "boolean"
},
@ -8002,6 +8059,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -8011,6 +8071,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8079,6 +8142,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -8088,6 +8154,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8156,6 +8225,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -8165,6 +8237,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8316,6 +8391,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8409,6 +8487,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8502,6 +8583,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8647,6 +8731,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8734,6 +8821,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8821,6 +8911,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -8966,6 +9059,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -8978,6 +9074,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9065,6 +9164,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -9077,6 +9179,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9164,6 +9269,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -9176,6 +9284,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9321,6 +9432,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -9330,6 +9444,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9417,6 +9534,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -9426,6 +9546,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9513,6 +9636,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"has_spoiler": {
"type": "boolean"
},
@ -9522,6 +9648,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9657,6 +9786,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9734,6 +9866,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9811,6 +9946,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -9947,6 +10085,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10025,6 +10166,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10103,6 +10247,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10232,6 +10379,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
}
@ -10287,6 +10437,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
}
@ -10342,6 +10495,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
}
@ -10457,6 +10613,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10528,6 +10687,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10599,6 +10761,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10734,6 +10899,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10813,6 +10981,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -10892,6 +11063,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11017,6 +11191,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11082,6 +11259,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11147,6 +11327,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11311,6 +11494,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11417,6 +11603,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11523,6 +11712,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11638,6 +11830,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11693,6 +11888,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -11748,6 +11946,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -19619,6 +19820,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
}
@ -19657,6 +19861,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
}
@ -19695,6 +19902,9 @@
"$ref": "#/components/schemas/MessageEntity"
}
},
"show_caption_above_media": {
"type": "boolean"
},
"reply_markup": {
"$ref": "#/components/schemas/InlineKeyboardMarkup"
}
@ -20867,6 +21077,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -20932,6 +21145,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -20997,6 +21213,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -23104,7 +23323,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -23197,6 +23415,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -23214,7 +23435,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -23307,6 +23527,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -23324,7 +23547,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -23417,6 +23639,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -23491,7 +23716,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -23572,7 +23796,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -23653,7 +23876,6 @@
"title",
"description",
"payload",
"provider_token",
"currency",
"prices"
],
@ -24033,6 +24255,115 @@
}
}
},
"/refundStarPayment": {
"description": "Refunds a successful payment in Telegram Stars. Returns True on success.",
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_id",
"telegram_payment_charge_id"
],
"properties": {
"user_id": {
"type": "integer"
},
"telegram_payment_charge_id": {
"type": "string"
}
}
}
},
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"user_id",
"telegram_payment_charge_id"
],
"properties": {
"user_id": {
"type": "integer"
},
"telegram_payment_charge_id": {
"type": "string"
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"required": [
"user_id",
"telegram_payment_charge_id"
],
"properties": {
"user_id": {
"type": "integer"
},
"telegram_payment_charge_id": {
"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": "boolean"
}
}
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"409": {
"$ref": "#/components/responses/Conflict"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
},
"default": {
"$ref": "#/components/responses/UnknownError"
}
}
}
},
"/setPassportDataErrors": {
"description": "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.",
"post": {
@ -24179,6 +24510,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -24214,6 +24548,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},
@ -24249,6 +24586,9 @@
"protect_content": {
"type": "boolean"
},
"message_effect_id": {
"type": "string"
},
"reply_parameters": {
"$ref": "#/components/schemas/ReplyParameters"
},

241
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: 7.3.0
version: 7.4.0
servers:
-
url: 'https://api.telegram.org/bot{token}'
@ -409,6 +409,8 @@ components:
$ref: '#/components/schemas/MessageEntity'
link_preview_options:
$ref: '#/components/schemas/LinkPreviewOptions'
effect_id:
type: string
animation:
$ref: '#/components/schemas/Animation'
audio:
@ -435,6 +437,9 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
default: true
has_media_spoiler:
type: boolean
default: true
@ -1547,7 +1552,7 @@ components:
type: boolean
type: object
KeyboardButton:
description: 'This object represents one button of the reply keyboard. For simple text buttons, String can be used instead of this object to specify the button text. The optional fields web_app, request_users, request_chat, request_contact, request_location, and request_poll are mutually exclusive.'
description: 'This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.'
required:
- text
properties:
@ -1646,7 +1651,7 @@ components:
$ref: '#/components/schemas/InlineKeyboardButton'
type: object
InlineKeyboardButton:
description: 'This object represents one button of an inline keyboard. You must use exactly one of the optional fields.'
description: 'This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.'
required:
- text
properties:
@ -2620,6 +2625,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
type: object
@ -2648,6 +2655,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
width:
type: integer
height:
@ -2684,6 +2693,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
width:
type: integer
height:
@ -3004,6 +3015,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3045,6 +3058,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3086,6 +3101,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3122,6 +3139,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
video_width:
type: integer
video_height:
@ -3398,6 +3417,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3427,6 +3448,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3456,6 +3479,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3539,6 +3564,8 @@ components:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
input_message_content:
@ -3695,7 +3722,6 @@ components:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -4672,6 +4698,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -4715,6 +4743,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -4758,6 +4788,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5089,6 +5121,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
disable_notification:
type: boolean
protect_content:
@ -5137,6 +5171,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
disable_notification:
type: boolean
protect_content:
@ -5185,6 +5221,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
disable_notification:
type: boolean
protect_content:
@ -5399,12 +5437,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5448,12 +5490,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5497,12 +5543,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5598,6 +5648,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5657,6 +5709,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5716,6 +5770,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5807,6 +5863,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5862,6 +5920,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -5917,6 +5977,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6008,6 +6070,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
supports_streaming:
@ -6016,6 +6080,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6071,6 +6137,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
supports_streaming:
@ -6079,6 +6147,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6134,6 +6204,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
supports_streaming:
@ -6142,6 +6214,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6233,12 +6307,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6294,12 +6372,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6355,12 +6437,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
has_spoiler:
type: boolean
disable_notification:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6446,6 +6532,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6495,6 +6583,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6544,6 +6634,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6629,6 +6721,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6678,6 +6772,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6727,6 +6823,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6808,6 +6906,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
required:
@ -6843,6 +6943,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
required:
@ -6878,6 +6980,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
required:
@ -6951,6 +7055,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -6997,6 +7103,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7043,6 +7151,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7129,6 +7239,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7181,6 +7293,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7233,6 +7347,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7313,6 +7429,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7355,6 +7473,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7397,6 +7517,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7503,6 +7625,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7573,6 +7697,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7643,6 +7769,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7716,6 +7844,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7751,6 +7881,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -7786,6 +7918,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -12681,6 +12815,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
application/x-www-form-urlencoded:
@ -12705,6 +12841,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
multipart/form-data:
@ -12729,6 +12867,8 @@ paths:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
show_caption_above_media:
type: boolean
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
responses:
@ -13459,6 +13599,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -13500,6 +13642,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -13541,6 +13685,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -14880,7 +15026,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -14942,6 +15087,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -14954,7 +15101,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -15016,6 +15162,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -15028,7 +15176,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -15090,6 +15237,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -15137,7 +15286,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -15192,7 +15340,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -15247,7 +15394,6 @@ paths:
- title
- description
- payload
- provider_token
- currency
- prices
properties:
@ -15487,6 +15633,75 @@ paths:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/refundStarPayment:
description: 'Refunds a successful payment in Telegram Stars. Returns True on success.'
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- user_id
- telegram_payment_charge_id
properties:
user_id:
type: integer
telegram_payment_charge_id:
type: string
application/x-www-form-urlencoded:
schema:
type: object
required:
- user_id
- telegram_payment_charge_id
properties:
user_id:
type: integer
telegram_payment_charge_id:
type: string
multipart/form-data:
schema:
type: object
required:
- user_id
- telegram_payment_charge_id
properties:
user_id:
type: integer
telegram_payment_charge_id:
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: boolean
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
$ref: '#/components/responses/TooManyRequests'
5XX:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/setPassportDataErrors:
description: "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues."
post:
@ -15584,6 +15799,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -15607,6 +15824,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:
@ -15630,6 +15849,8 @@ paths:
type: boolean
protect_content:
type: boolean
message_effect_id:
type: string
reply_parameters:
$ref: '#/components/schemas/ReplyParameters'
reply_markup:

219
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": "7.3.0"
"version": "7.4.0"
},
"variable": {
"key": "token",
@ -318,6 +318,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -519,6 +525,12 @@
"description": "Optional. A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode",
"type": "text"
},
{
"key": "show_caption_above_media",
"disabled": true,
"description": "Optional. Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.",
"type": "text"
},
{
"key": "disable_notification",
"disabled": true,
@ -677,6 +689,12 @@
"description": "Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"type": "text"
},
{
"key": "show_caption_above_media",
"disabled": true,
"description": "Optional. Pass True, if the caption must be shown above the message media",
"type": "text"
},
{
"key": "has_spoiler",
"disabled": true,
@ -695,6 +713,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -810,6 +834,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -913,6 +943,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1016,6 +1052,12 @@
"description": "Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"type": "text"
},
{
"key": "show_caption_above_media",
"disabled": true,
"description": "Optional. Pass True, if the caption must be shown above the message media",
"type": "text"
},
{
"key": "has_spoiler",
"disabled": true,
@ -1040,6 +1082,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1143,6 +1191,12 @@
"description": "Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"type": "text"
},
{
"key": "show_caption_above_media",
"disabled": true,
"description": "Optional. Pass True, if the caption must be shown above the message media",
"type": "text"
},
{
"key": "has_spoiler",
"disabled": true,
@ -1161,6 +1215,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1258,6 +1318,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1349,6 +1415,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1422,6 +1494,12 @@
"description": "Optional. Protects the contents of the sent messages from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1519,6 +1597,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1634,6 +1718,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1725,6 +1815,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1878,6 +1974,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -1952,6 +2054,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -4491,6 +4599,12 @@
"description": "Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
"type": "text"
},
{
"key": "show_caption_above_media",
"disabled": true,
"description": "Optional. Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
@ -4919,6 +5033,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -5678,26 +5798,26 @@
},
{
"key": "provider_token",
"disabled": false,
"description": "Required. Payment provider token, obtained via @BotFather",
"disabled": true,
"description": "Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
"type": "text"
},
{
"key": "currency",
"disabled": false,
"description": "Required. Three-letter ISO 4217 currency code, see more on currencies",
"description": "Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.",
"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.)",
"description": "Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
"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",
"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. Not supported for payments in Telegram Stars.",
"type": "text"
},
{
@ -5745,43 +5865,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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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 the provider. Ignored for payments in Telegram Stars.",
"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 the provider. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"type": "text"
},
{
@ -5796,6 +5916,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,
@ -5853,26 +5979,26 @@
},
{
"key": "provider_token",
"disabled": false,
"description": "Required. Payment provider token, obtained via BotFather",
"disabled": true,
"description": "Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
"type": "text"
},
{
"key": "currency",
"disabled": false,
"description": "Required. Three-letter ISO 4217 currency code, see more on currencies",
"description": "Required. Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.",
"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.)",
"description": "Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.",
"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",
"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. Not supported for payments in Telegram Stars.",
"type": "text"
},
{
@ -5914,43 +6040,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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"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. Ignored for payments in Telegram Stars.",
"type": "text"
}
]
@ -6063,6 +6189,43 @@
"description": "Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent."
}
},
{
"name": "refundStarPayment",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "user_id",
"disabled": false,
"description": "Required. Identifier of the user whose payment will be refunded",
"type": "text"
},
{
"key": "telegram_payment_charge_id",
"disabled": false,
"description": "Required. Telegram payment identifier",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/refundStarPayment",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"refundStarPayment"
]
},
"description": "Refunds a successful payment in Telegram Stars. Returns True on success."
}
},
{
"name": "setPassportDataErrors",
"request": {
@ -6143,6 +6306,12 @@
"description": "Optional. Protects the contents of the sent message from forwarding and saving",
"type": "text"
},
{
"key": "message_effect_id",
"disabled": true,
"description": "Optional. Unique identifier of the message effect to be added to the message; for private chats only",
"type": "text"
},
{
"key": "reply_parameters",
"disabled": true,