peyk.platforms.telegram.methods.send_paid_media

async peyk.platforms.telegram.methods.send_paid_media(self, chat_id: int | str, star_count: int, media: List[object], *, business_connection_id: str | None = None, message_thread_id: int | None = None, direct_messages_topic_id: int | 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, suggested_post_parameters: object | None = None, reply_parameters: ReplyParameters | None = None, reply_markup: object | None = None) → Message

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

Parameters:

  • chat_id – Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. 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 – The number of Telegram Stars that must be paid to buy access to the media; 1-25000

  • media – A JSON-serialized Array describing the media to be sent; up to 10 items

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

  • message_thread_id – Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only

  • direct_messages_topic_id – Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat

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

  • caption – Media caption, 0-1024 characters after entities parsing

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

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

  • show_caption_above_media – Pass True if the caption must be shown above the message media

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

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • allow_paid_broadcast – 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.

  • suggested_post_parameters – A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.

  • reply_parameters – Description of the message to reply to

  • reply_markup – 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.

Returns:

Result returned by Telegram on successful execution.

Return type:

Message