GramIO API Reference / gramio/dist / EditMessageCaptionParams
Interface: EditMessageCaptionParams
Defined in: @gramio/types/out/params.d.ts:3313
Params object for editMessageCaption method
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
business_connection_id? | string | Unique identifier of the business connection on behalf of which the message to be edited was sent | @gramio/types/out/params.d.ts:3317 |
caption? | string | { toString: string; } | New caption of the message, 0-1024 characters after entities parsing | @gramio/types/out/params.d.ts:3333 |
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:3341 |
chat_id? | string | number | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) | @gramio/types/out/params.d.ts:3321 |
inline_message_id? | string | Required if chat_id and message_id are not specified. Identifier of the inline message | @gramio/types/out/params.d.ts:3329 |
message_id? | number | Required if inline_message_id is not specified. Identifier of the message to edit | @gramio/types/out/params.d.ts:3325 |
parse_mode? | "HTML" | "MarkdownV2" | "Markdown" | Mode for parsing entities in the message caption. See formatting options for more details. | @gramio/types/out/params.d.ts:3337 |
reply_markup? | TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; } | A JSON-serialized object for an inline keyboard. | @gramio/types/out/params.d.ts:3349 |
show_caption_above_media? | boolean | Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. | @gramio/types/out/params.d.ts:3345 |