sendPaidMedia()

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

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the message will be sent
`chat_id`	number \| string	required	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.
`message_thread_id`	number	optional	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	optional	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
`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
`payload`	string	optional	Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
`caption`	string	optional	Media caption, 0-1024 characters after entities parsing
`parse_mode`	string	optional	Mode for parsing entities in the media caption. See formatting options for more details.
`caption_entities`	MessageEntity[]	optional	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	optional	Pass True, if the caption must be shown above the message media
`disable_notification`	boolean	optional	Sends the message silently. Users will receive a notification with no sound.
`protect_content`	boolean	optional	Protects the contents of the sent message from forwarding and saving
`allow_paid_broadcast`	boolean	optional	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	optional	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	optional	Description of the message to reply to
`reply_markup`	InlineKeyboardMarkup \| ReplyKeyboardMarkup \| ReplyKeyboardRemove \| ForceReply	optional	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

Message

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { Message, SendPaidMediaParams } from "@yaebal/types";

await bot.api.call<Message>("sendPaidMedia", {
  chat_id: 123456789,
  star_count: 1,
  media: [],
} satisfies SendPaidMediaParams);

context shortcut

also available as ctx.sendPaidMedia() on 16 context types — see @yaebal/contexts.

context shortcut

/** Use this method to send paid media. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendPaidMedia(params: Omit<SendPaidMediaParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#sendpaidmedia