edit_message_caption()

async Client.edit_message_caption()

Edit the caption of media messages.

Usable by Users Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • message_id (int) – Message identifier in the chat specified in chat_id.

  • caption (str) – New caption of the media message.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of MessageEntity) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

  • rich_text (str, optional) – Rich text content with GitHub Flavored Markdown or HTML formatting (server-side rendered). When provided, caption/parse_mode/caption_entities are ignored.

  • rich_text_parse_mode (str, optional) – Parse mode for rich_text: "markdown" (default, supports GFM) or "html".

  • reply_markup (InlineKeyboardMarkup, optional) – An InlineKeyboardMarkup object.

Returns:

Message – On success, the edited message is returned.

Example

await app.edit_message_caption(chat_id, message_id, "new media caption")