edit_message_caption()

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 (:obj:`~pyrogram.enums.ParseMode`, *optional*) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of :obj:`~pyrogram.types.MessageEntity`) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

  • show_caption_above_media (``bool``, *optional*) – Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.

  • reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*) – An InlineKeyboardMarkup object.

  • schedule_date (:py:obj:`~datetime.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 to be edited was sent

Returns:

:obj:`~pyrogram.types.Message` (On success, the edited message is returned.)

Example

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