editMessageMedia()
Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. 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. |
media | InputMedia | required | A JSON-serialized object for a new media content of the message |
reply_markup | InlineKeyboardMarkup | optional | A JSON-serialized object for a new 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 { EditMessageMediaParams, Message } from "@yaebal/types";
await bot.api.call<Message | boolean>("editMessageMedia", {
media: {} /* InputMedia */,
} satisfies EditMessageMediaParams);context shortcut
also available as ctx.editMedia() on
16
context types — see @yaebal/contexts.
/** Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. 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.editMedia(params: Omit<EditMessageMediaParams, "chat_id" | "message_id">)