Available methods

sendVideoNote()

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. 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
video_noteInputFile | stringrequiredVideo note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported.
durationnumberoptionalDuration of sent video in seconds
lengthnumberoptionalVideo width and height, i.e. diameter of the video message
thumbnailInputFile | stringoptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
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, SendVideoNoteParams } from "@yaebal/types";

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

context shortcut

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

context shortcut
/** As of [v.4.0](https://telegram.org/blog/video-messages-and-telescope), Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendVideoNote(params: Omit<SendVideoNoteParams, "chat_id">)