Available methods

sendLivePhoto()

Use this method to send live photos. On success, the sent Message is returned.

parameters

parametertyperequireddescription
business_connection_idstringoptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idnumber | stringrequiredUnique identifier for the target chat or username of the target channel (in the format @channelusername)
message_thread_idnumberoptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idnumberoptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
live_photoInputFile | stringrequiredLive photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photoInputFile | stringrequiredThe static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
captionstringoptionalVideo caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
parse_modestringoptionalMode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesMessageEntity[]optionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediabooleanoptionalPass True, if the caption must be shown above the message media
has_spoilerbooleanoptionalPass True if the video needs to be covered with a spoiler animation
disable_notificationbooleanoptionalSends the message silently. Users will receive a notification with no sound.
protect_contentbooleanoptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastbooleanoptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idstringoptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersoptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersoptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReplyoptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.

returns

Message

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts
import { media } from "@yaebal/core";
import type { Message, SendLivePhotoParams } from "@yaebal/types";

await bot.api.call<Message>("sendLivePhoto", {
  chat_id: 123456789,
  live_photo: media.url("https://picsum.photos/400"),
  photo: media.url("https://picsum.photos/400"),
} satisfies SendLivePhotoParams);

context shortcut

also available as ctx.sendLivePhoto() on 16 context types — see @yaebal/contexts.

context shortcut
/** Use this method to send live photos. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendLivePhoto(params: Omit<SendLivePhotoParams, "chat_id">)