{ "meta": {}, "group": { "title": "Available methods", "anchor": "available-methods" }, "object": { "anchor": "sendpaidmedia", "name": "sendPaidMedia", "description": "Use this method to send paid media. On success, the sent Message is returned.", "html_description": "

Use this method to send paid media. On success, the sent Message is returned.

", "rst_description": "Use this method to send paid media. On success, the sent :class:`aiogram.types.message.Message` is returned.", "annotations": [ { "type": "String", "required": false, "description": "Unique identifier of the business connection on behalf of which the message will be sent", "html_description": "Unique identifier of the business connection on behalf of which the message will be sent", "rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n", "name": "business_connection_id" }, { "type": "Integer or String", "required": true, "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.", "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.", "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.\n", "name": "chat_id" }, { "type": "Integer", "required": true, "description": "The number of Telegram Stars that must be paid to buy access to the media; 1-10000", "html_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-10000", "rst_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-10000\n", "name": "star_count" }, { "type": "Array of InputPaidMedia", "required": true, "description": "A JSON-serialized array describing the media to be sent; up to 10 items", "html_description": "A JSON-serialized array describing the media to be sent; up to 10 items", "rst_description": "A JSON-serialized array describing the media to be sent; up to 10 items\n", "name": "media" }, { "type": "String", "required": false, "description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.", "html_description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.", "rst_description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.\n", "name": "payload" }, { "type": "String", "required": false, "description": "Media caption, 0-1024 characters after entities parsing", "html_description": "Media caption, 0-1024 characters after entities parsing", "rst_description": "Media caption, 0-1024 characters after entities parsing\n", "name": "caption" }, { "type": "String", "required": false, "description": "Mode for parsing entities in the media caption. See formatting options for more details.", "html_description": "Mode for parsing entities in the media caption. See formatting options for more details.", "rst_description": "Mode for parsing entities in the media caption. See `formatting options `_ for more details.\n", "name": "parse_mode" }, { "type": "Array of MessageEntity", "required": false, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode", "html_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode", "rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n", "name": "caption_entities" }, { "type": "Boolean", "required": false, "description": "Pass True, if the caption must be shown above the message media", "html_description": "Pass True, if the caption must be shown above the message media", "rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n", "name": "show_caption_above_media" }, { "type": "Boolean", "required": false, "description": "Sends the message silently. Users will receive a notification with no sound.", "html_description": "Sends the message silently. Users will receive a notification with no sound.", "rst_description": "Sends the message `silently `_. Users will receive a notification with no sound.\n", "name": "disable_notification" }, { "type": "Boolean", "required": false, "description": "Protects the contents of the sent message from forwarding and saving", "html_description": "Protects the contents of the sent message from forwarding and saving", "rst_description": "Protects the contents of the sent message from forwarding and saving\n", "name": "protect_content" }, { "type": "Boolean", "required": false, "description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance", "html_description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance", "rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits `_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n", "name": "allow_paid_broadcast" }, { "type": "ReplyParameters", "required": false, "description": "Description of the message to reply to", "html_description": "Description of the message to reply to", "rst_description": "Description of the message to reply to\n", "name": "reply_parameters" }, { "type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply", "required": false, "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "html_description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove a reply keyboard or to force a reply from the user\n", "name": "reply_markup" } ], "category": "methods" } }