editMessageCaption()
Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.
parameters
| parameter | type | required | description |
|---|---|---|---|
business_connection_id | string | optional | Unique identifier of the business connection on behalf of which the message to be edited was sent |
chat_id | number | string | optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. |
message_id | number | optional | Required if inline_message_id is not specified. Identifier of the message to edit. |
inline_message_id | string | optional | Required if chat_id and message_id are not specified. Identifier of the inline message. |
caption | string | optional | New caption of the message, 0-1024 characters after entities parsing |
parse_mode | string | optional | Mode for parsing entities in the message caption. See formatting options for more details. |
caption_entities | MessageEntity[] | optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode |
show_caption_above_media | boolean | optional | Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages. |
reply_markup | InlineKeyboardMarkup | optional | A JSON-serialized object for an inline keyboard |
returns
Message | boolean
usage in yaebal
not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.
import type { EditMessageCaptionParams, Message } from "@yaebal/types";
await bot.api.call<Message | boolean>("editMessageCaption", {} satisfies EditMessageCaptionParams);context shortcut
also available as ctx.editCaption() on
16
context types — see @yaebal/contexts.
/** Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api/#message) is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. */
ctx.editCaption(params: Omit<EditMessageCaptionParams, "chat_id" | "message_id">)official Bot API docs: https://core.telegram.org/bots/api/#editmessagecaption