peyk.platforms.telegram.methods.edit_ephemeral_message_caption

async peyk.platforms.telegram.methods.edit_ephemeral_message_caption(self, chat_id: int | str, receiver_user_id: int | None = None, ephemeral_message_id: int | None = None, *, caption: str | None = None, parse_mode: str | None = None, caption_entities: List[MessageEntity] | None = None, show_caption_above_media: bool | None = None, reply_markup: InlineKeyboardMarkup | None = None) → bool

Use this method to edit the caption 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:

  • chat_id – Unique identifier for the target chat or username of the target supergroup in the format @username

  • receiver_user_id – Identifier of the user who received the message

  • ephemeral_message_id – Identifier of the ephemeral message to edit

  • caption – New caption of the message, 0-1024 characters after entities parsing

  • parse_mode – Mode for parsing entities in the message caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • show_caption_above_media – Value accepted by this operation.

  • reply_markup – A JSON-serialized object for an inline keyboard

Returns:

Result returned by Telegram on successful execution.

Return type:

bool