sendVoice()

Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the message will be sent
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format `@username`
`message_thread_id`	number	optional	Unique 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_id`	number	optional	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
`voice`	InputFile \| string	required	Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
`caption`	string	optional	Voice message caption, 0-1024 characters after entities parsing
`parse_mode`	string	optional	Mode for parsing entities in the voice message caption. See formatting options for more details.
`caption_entities`	MessageEntity[]	optional	A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
`duration`	number	optional	Duration of the voice message in seconds
`disable_notification`	boolean	optional	Sends the message silently. Users will receive a notification with no sound.
`protect_content`	boolean	optional	Protects the contents of the sent message from forwarding and saving
`allow_paid_broadcast`	boolean	optional	Pass 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_id`	string	optional	Unique identifier of the message effect to be added to the message; for private chats only
`suggested_post_parameters`	SuggestedPostParameters	optional	A 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_parameters`	ReplyParameters	optional	Description of the message to reply to
`reply_markup`	InlineKeyboardMarkup \| ReplyKeyboardMarkup \| ReplyKeyboardRemove \| ForceReply	optional	Additional 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, SendVoiceParams } from "@yaebal/types";

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

context shortcut

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

context shortcut

/** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as [Audio](https://core.telegram.org/bots/api/#audio) or [Document](https://core.telegram.org/bots/api/#document)). On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
ctx.sendVoice(params: Omit<SendVoiceParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#sendvoice