SendPaidMediaParams

interface

Declaration

interface SendPaidMediaParams

Properties

allow_paid_broadcastproperty#

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.

business_connection_idproperty#

business_connection_id?: string;

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

caption_entitiesproperty#

caption_entities?: MessageEntity[];

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

captionproperty#

caption?: string;

Media caption, 0-1024 characters after entities parsing

chat_idproperty#

chat_id: number | string;

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.

direct_messages_topic_idproperty#

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

disable_notificationproperty#

disable_notification?: boolean;

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

mediaproperty#

media: InputPaidMedia[];

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

message_thread_idproperty#

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

parse_modeproperty#

parse_mode?: string;

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

payloadproperty#

payload?: string;

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

protect_contentproperty#

protect_content?: boolean;

Protects the contents of the sent message from forwarding and saving

reply_markupproperty#

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.

reply_parametersproperty#

reply_parameters?: ReplyParameters;

Description of the message to reply to

show_caption_above_mediaproperty#

show_caption_above_media?: boolean;

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

star_countproperty#

star_count: number;

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

suggested_post_parametersproperty#

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.