sendPaidMedia
Use this method to send paid media.
Required: chat_id, star_count, media · Optional: 14 parameters
Limits:
- caption: 0-1024 characters
- allow_paid_broadcast: up to 1000 messages
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("send_paid_media", { chat_id: "YOUR_CHAT_ID", star_count: 0, media: []})Parameters
chat_id number | string Required
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 number Required
The number of Telegram Stars that must be paid to buy access to the media; 1-25000.
media InputPaidMedia[] Required
A JSON-serialized array describing the media to be sent; up to 10 items.
business_connection_id string
Unique identifier of the business connection on behalf of which the message will be sent.
message_thread_id number
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 number
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 string
Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
caption string
Media caption, 0-1024 characters after entities parsing.
parse_mode "HTML" | "MarkdownV2"
Mode for parsing entities in the media caption. See formatting options for more details.
caption_entities MessageEntity[]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.
show_caption_above_media boolean
Pass True, if the caption must be shown above the message media.
disable_notification boolean
Sends the message silently. Users will receive a notification with no sound.
protect_content boolean
Protects the contents of the sent message from forwarding and saving.
allow_paid_broadcast boolean
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 SuggestedPostParameters
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 ReplyParameters
Description of the message to reply to.
reply_markup InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply
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.
Related methods
sendAnimation · sendAudio · sendChatAction · sendChecklist · sendContact · sendDice · sendDocument · sendGame · sendGift · sendInvoice · sendLocation · sendMediaGroup · sendMessage · sendMessageDraft · sendPhoto · sendPoll · sendSticker · sendVenue · sendVideo · sendVideoNote · sendVoice