Updating messages

editEphemeralMessageMedia()

Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, True is returned.

parameters

parametertyperequireddescription
chat_idnumber | stringrequiredUnique identifier for the target chat or username of the target supergroup in the format @username
receiver_user_idnumberrequiredIdentifier of the user who received the message
ephemeral_message_idnumberrequiredIdentifier of the ephemeral message to edit
mediaInputMediarequiredA JSON-serialized object for the new media content of the message
reply_markupInlineKeyboardMarkupoptionalA JSON-serialized object for an inline keyboard

returns

boolean

usage in yaebal

editEphemeralMessageMedia is directly typed on Api — call it straight off bot.api.

bot.ts
import type { EditEphemeralMessageMediaParams } from "@yaebal/types";

await bot.api.editEphemeralMessageMedia({
  chat_id: 123456789,
  receiver_user_id: 1,
  ephemeral_message_id: 1,
  media: {} /* InputMedia */,
} satisfies EditEphemeralMessageMediaParams);

context shortcut

also available as ctx.editEphemeralMessageMedia() on 17 context types — see @yaebal/contexts.

context shortcut
/** Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned. */
ctx.editEphemeralMessageMedia(params: Omit<EditEphemeralMessageMediaParams, "chat_id">)