GramIO API Reference / gramio/dist / SendPaidMediaParams
Interface: SendPaidMediaParams
Defined in: @gramio/types/out/params.d.ts:979
Params object for sendPaidMedia method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
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 | @gramio/types/out/params.d.ts:1035 |
business_connection_id? | string | Unique identifier of the business connection on behalf of which the message will be sent | @gramio/types/out/params.d.ts:983 |
caption? | string | { toString: string; } | Media caption, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:1011 |
caption_entities? | TelegramMessageEntity[] | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | @gramio/types/out/params.d.ts:1019 |
chat_id | string | number | 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. | @gramio/types/out/params.d.ts:987 |
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 | @gramio/types/out/params.d.ts:995 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:1027 |
media | TelegramInputPaidMedia[] | A JSON-serialized array describing the media to be sent; up to 10 items | @gramio/types/out/params.d.ts:1003 |
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 | @gramio/types/out/params.d.ts:991 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the media caption. See formatting options for more details. | @gramio/types/out/params.d.ts:1015 |
payload? | string | Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. | @gramio/types/out/params.d.ts:1007 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:1031 |
reply_markup? | TelegramInlineKeyboardMarkup | TelegramReplyKeyboardMarkup | TelegramReplyKeyboardRemove | TelegramForceReply | { toJSON: TelegramInlineKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardRemove; } | { toJSON: TelegramForceReply; } | 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 | @gramio/types/out/params.d.ts:1047 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | @gramio/types/out/params.d.ts:1043 |
show_caption_above_media? | boolean | Pass True, if the caption must be shown above the message media | @gramio/types/out/params.d.ts:1023 |
star_count | number | The number of Telegram Stars that must be paid to buy access to the media; 1-25000 | @gramio/types/out/params.d.ts:999 |
suggested_post_parameters? | TelegramSuggestedPostParameters | 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. | @gramio/types/out/params.d.ts:1039 |