GramIO API Reference / gramio/dist / CopyMessageParams
Interface: CopyMessageParams
Defined in: @gramio/types/out/params.d.ts:245
Params object for copyMessage 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:297 |
caption? | string | { toString: string; } | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept | @gramio/types/out/params.d.ts:273 |
caption_entities? | TelegramMessageEntity[] | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode | @gramio/types/out/params.d.ts:281 |
chat_id | string | number | Unique identifier for the target chat or username of the target channel (in the format @channelusername) | @gramio/types/out/params.d.ts:249 |
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:257 |
disable_notification? | boolean | Sends the message silently. Users will receive a notification with no sound. | @gramio/types/out/params.d.ts:289 |
from_chat_id | string | number | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) | @gramio/types/out/params.d.ts:261 |
message_effect_id? | string | Unique identifier of the message effect to be added to the message; only available when copying to private chats | @gramio/types/out/params.d.ts:301 |
message_id | number | Message identifier in the chat specified in from_chat_id | @gramio/types/out/params.d.ts:265 |
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:253 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the new caption. See formatting options for more details. | @gramio/types/out/params.d.ts:277 |
protect_content? | boolean | Protects the contents of the sent message from forwarding and saving | @gramio/types/out/params.d.ts:293 |
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:313 |
reply_parameters? | TelegramReplyParameters | Description of the message to reply to | @gramio/types/out/params.d.ts:309 |
show_caption_above_media? | boolean | Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified. | @gramio/types/out/params.d.ts:285 |
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:305 |
video_start_timestamp? | number | New start timestamp for the copied video in the message | @gramio/types/out/params.d.ts:269 |