send_paid_media()

async Client.send_paid_media()

Send a group or one paid photo/video.

Usable by Users Bots

Parameters:

• chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

• stars_amount (int) – The number of Telegram Stars that must be paid to buy access to the media.

• media (List of InputMediaPhoto, InputMediaVideo) – A list describing photos and videos to be sent, must include 1–10 items.

• caption (str, optional) – Media caption, 0-1024 characters after entities parsing.

• payload (str) – Bot-defined payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.

• parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

• disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

• direct_messages_topic_id (int, optional) – Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only.

• reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

• suggested_post_parameters (SuggestedPostParameters, optional) – Information about the suggested post.

• schedule_date (datetime, optional) – Date when the message will be automatically sent.

• protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

• show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

• business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be sent.

• progress (Callable, optional) – Pass a callback function to view the file transmission progress. The function must take (current, total) as positional arguments.

• progress_args (tuple, optional) – Arguments to pass to the progress callback function.

• caption_entities (List of MessageEntity) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

• message_thread_id (int, optional) – Unique identifier for a message thread in a forum topic.

• effect_id (int, optional) – Unique identifier of the effect to apply to the message.

• repeat_period (int, optional) – New period in seconds for the message to be sent repeatedly.

• allow_paid_broadcast (bool, optional) – If True, you will be allowed to send 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. For bots only.

• paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

• background (bool, optional) – Send the message in background.

• clear_draft (bool, optional) – Clear the draft of the chat.

• update_stickersets_order (bool, optional) – Move the sticker set to the top of the list.

• send_as (int | str, optional) – Unique identifier (int) or username (str) of the chat or channel to send the message as.

• quick_reply_shortcut (int, optional) – Unique identifier of the quick reply shortcut the message belongs to.

• reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

• reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

• reply_to_chat_id (int | str, optional) – Unique identifier for the chat to which the replied message belongs. Only applicable in combination with reply_to_message_id.

• quote_text (str, optional) – Text of the quote to reply to.

• quote_entities (List of MessageEntity) – List of special entities that appear in quote_text, which can be specified instead of parse_mode.

• quote_offset (int, optional) – Deprecated, use reply_parameters instead. Position of the quote in the original message, in UTF-16 code units.

Returns:

List of Message – On success, a list of messages is returned.

Example

from wzgram.types import InputMediaPhoto, InputMediaVideo

await app.send_paid_media(
    chat_id,
    stars_amount=50,
    caption="Look at this!",
    media=[
        InputMediaPhoto("photo1.jpg"),
        InputMediaPhoto("photo2.jpg"),
        InputMediaVideo("video.mp4")
    ]
)