Message.edit_caption()

Message.edit_caption()

Shortcut for method edit_message_caption will automatically fill method attributes:

  • chat_id

  • message_id

  • business_connection_id

Parameters:

  • caption (str) – New caption of the 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.

  • 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 (InlineKeyboardMarkup, optional) – An InlineKeyboardMarkup object.

Returns:

On success, the edited Message is returned.

Raises:

RPCError – In case of a Telegram RPC error.