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). Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
Required: chat_id, voice · Optional: 14 parameters
Limits:
- caption: 0-1024 characters
- allow_paid_broadcast: up to 1000 messages
Try it
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("send_voice", { chat_id: "YOUR_CHAT_ID", voice: { /* InputFile | string */ }})Parameters
chat_id number | string Required
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
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 ».
business_connection_id string
Unique identifier of the business connection on behalf of which the message will be sent.
message_thread_id number
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
Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat.
caption string
Voice message caption, 0-1024 characters after entities parsing.
parse_mode "HTML" | "MarkdownV2"
Mode for parsing entities in the voice 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.
duration number
Duration of the voice message in seconds.
disable_notification boolean
Sends the message silently. Users will receive a notification with no sound.
protect_content boolean
Protects the contents of the sent message from forwarding and saving.
allow_paid_broadcast boolean
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
Unique identifier of the message effect to be added to the message; for private chats only.
suggested_post_parameters SuggestedPostParameters
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
Description of the message to reply to.
reply_markup InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply
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.
Related methods
sendAnimation · sendAudio · sendChatAction · sendChecklist · sendContact · sendDice · sendDocument · sendGame · sendGift · sendInvoice · sendLocation · sendMediaGroup · sendMessage · sendMessageDraft · sendPaidMedia · sendPhoto · sendPoll · sendSticker · sendVenue · sendVideo · sendVideoNote