sendPaidMedia

Returns: Message

class aiogram.methods.send_paid_media.SendPaidMedia(*, chat_id: int | str, star_count: int, media: list[InputPaidMediaPhoto | InputPaidMediaVideo], business_connection_id: str | None = None, payload: str | None = None, caption: str | None = None, parse_mode: str | None = None, caption_entities: list[MessageEntity] | None = None, show_caption_above_media: bool | None = None, disable_notification: bool | None = None, protect_content: bool | None = None, allow_paid_broadcast: bool | None = None, reply_parameters: ReplyParameters | None = None, reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | None = None, **extra_data: Any)[source]

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

Source: https://core.telegram.org/bots/api#sendpaidmedia

chat_id: int | str

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.

star_count: int

The number of Telegram Stars that must be paid to buy access to the media; 1-2500

media: list[InputPaidMediaPhoto | InputPaidMediaVideo]

A JSON-serialized array describing the media to be sent; up to 10 items

business_connection_id: str | None

Unique identifier of the business connection on behalf of which the message will be sent

payload: str | None

Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.

caption: str | None

Media caption, 0-1024 characters after entities parsing

parse_mode: str | None

Mode for parsing entities in the media caption. See formatting options for more details.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

caption_entities: list[MessageEntity] | None

A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

show_caption_above_media: bool | None

Pass True, if the caption must be shown above the message media

disable_notification: bool | None

Sends the message silently. Users will receive a notification with no sound.

protect_content: bool | None

Protects the contents of the sent message from forwarding and saving

allow_paid_broadcast: bool | None

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

reply_parameters: ReplyParameters | None

Description of the message to reply to

reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | None

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

Usage

As bot method

result: Message = await bot.send_paid_media(...)

Method as object

Imports:

  • from aiogram.methods.send_paid_media import SendPaidMedia

  • alias: from aiogram.methods import SendPaidMedia

With specific bot

result: Message = await bot(SendPaidMedia(...))

As reply into Webhook in handler

return SendPaidMedia(...)

As shortcut from received object