editMessageCaption

Description

Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Arguments

Name Type Description
chat_id Optional[Union[int, str]] Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)
message_id Optional[int] Optional. Required if inline_message_id is not specified. Identifier of the message to edit
inline_message_id Optional[str] Optional. Required if chat_id and message_id are not specified. Identifier of the inline message
caption Optional[str] Optional. New caption of the message, 0-1024 characters after entities parsing
parse_mode Optional[str] Optional. Mode for parsing entities in the message caption. See formatting options for more details.
reply_markup Optional[InlineKeyboardMarkup] Optional. A JSON-serialized object for an inline keyboard.

Response

Type: Union[Message, bool]

Description: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.

Usage

As bot method

result: Union[Message, bool] = await bot.edit_message_caption(...)

Method as object

Imports:

  • from aiogram.methods import EditMessageCaption
  • from aiogram.api.methods import EditMessageCaption
  • from aiogram.api.methods.edit_message_caption import EditMessageCaption

In handlers with current bot

result: Union[Message, bool] = await EditMessageCaption(...)

With specific bot

result: Union[Message, bool] = await bot(EditMessageCaption(...))

As reply into Webhook in handler

return EditMessageCaption(...)