Skip to content

editMessageCaption

Returns Message | boolean

Use this method to edit captions of messages. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.

Optional: 9 parameters

Limits:

  • caption: 0-1024 characters
Try it
Token saved
Response

TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("edit_message_caption")

Parameters

business_connection_id string
Unique identifier of the business connection on behalf of which the message to be edited was sent.

chat_id number | string
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 number
Required if inline_message_id is not specified. Identifier of the message to edit.

inline_message_id string
Required if chat_id and message_id are not specified. Identifier of the inline message.

caption string
New caption of the message, 0-1024 characters after entities parsing.

parse_mode "HTML" | "MarkdownV2"
Mode for parsing entities in the message caption. See formatting options for more details.

caption_entities MessageEntity[]
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode.

show_caption_above_media boolean
Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.

reply_markup InlineKeyboardMarkup
A JSON-serialized object for an inline keyboard.

editChatInviteLink · editChatSubscriptionInviteLink · editForumTopic · editGeneralForumTopic · editMessageChecklist · editMessageLiveLocation · editMessageMedia · editMessageReplyMarkup · editMessageText · editStory · editUserStarSubscription