Skip to content

GramIO API Reference / gramio/dist / EditEphemeralMessageCaptionParams

Interface: EditEphemeralMessageCaptionParams

Defined in: @gramio/types/out/params.d.ts:3984

Params object for editEphemeralMessageCaption method

Properties

PropertyTypeDescriptionDefined in
caption?string | { toString: string; }New caption of the message, 0-1024 characters after entities parsing@gramio/types/out/params.d.ts:4000
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:4008
chat_idstring | numberUnique identifier for the target chat or username of the target supergroup in the format @username@gramio/types/out/params.d.ts:3988
ephemeral_message_idnumberIdentifier of the ephemeral message to edit@gramio/types/out/params.d.ts:3996
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:4004
receiver_user_idnumberIdentifier of the user who received the message@gramio/types/out/params.d.ts:3992
reply_markup?TelegramInlineKeyboardMarkup | { toJSON: TelegramInlineKeyboardMarkup; }A JSON-serialized object for an inline keyboard@gramio/types/out/params.d.ts:4016
show_caption_above_media?booleanPass 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:4012