Available methods

sendPhoto()

Use this method to send 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 bot, supergroup or channel in the format @username
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
photoInputFile | stringrequiredPhoto to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »
captionstringoptionalPhoto caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
parse_modestringoptionalMode for parsing entities in the photo 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 photo 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, SendPhotoParams } from "@yaebal/types";

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

context shortcut

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

context shortcut
/** send a photo. accepts a {@link MediaSource} or a raw file_id / URL string. */
ctx.sendPhoto(photo: MediaSource | string, extra: Record<string, unknown> = {})