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, optional) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

  • rich_text (str | InputRichMessage, optional) – Rich content to send, as Markdown or HTML text or as a whole InputRichMessage. When provided, caption/parse_mode/caption_entities are ignored.

  • rich_text_parse_mode (ParseMode, optional) – Parse mode for rich_text. Defaults to Markdown. Ignored when rich_text is an InputRichMessage.

  • rich_text_media (List of InputRichMessageMedia, optional) – Media rich_text refers to through tg://photo?id=, tg://video?id= or tg://audio?id= links. Ignored when rich_text is an InputRichMessage.

  • reply_markup (InlineKeyboardMarkup, optional) – An InlineKeyboardMarkup object. Pass None to remove the existing reply markup.

  • link_preview_options (LinkPreviewOptions, optional) – Link preview options.

  • show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

  • disable_web_page_preview (bool, optional) – Disables link previews for links in this message.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be edited.

Returns:

Message – On success, the edited message is returned.

Example

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