sendVoice: Send voice files

View source: R/bot.R

sendVoiceR Documentation

Send voice files

Description

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 (other formats may be sent with sendAudio or sendDocument).

Usage

sendVoice(
  chat_id,
  voice,
  duration = NULL,
  caption = NULL,
  disable_notification = FALSE,
  reply_to_message_id = NULL,
  reply_markup = NULL,
  parse_mode = NULL
)

Arguments

chat_id

Unique identifier for the target chat or username of the target channel.

voice

Voice file to send. Pass a file_id as String to send a voice file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a voice file from the Internet, or upload a local voice file file by passing a file path.

duration

(Optional). Duration of sent audio in seconds.

caption

(Optional). Voice message caption, 0-1024 characters.

disable_notification

(Optional). Sends the message silently. Users will receive a notification with no sound.

reply_to_message_id

(Optional). If the message is a reply, ID of the original message.

reply_markup

(Optional). A Reply Markup parameter object, it can be either:

  • ReplyKeyboardMarkup

  • InlineKeyboardMarkup

  • ReplyKeyboardRemove

  • ForceReply

parse_mode

(Optional). Send 'Markdown' or 'HTML', if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.

Details

You can also use it's snake_case equivalent send_voice.

Examples

## Not run: 
bot <- Bot(token = bot_token("RTelegramBot"))
chat_id <- user_id("Me")
ogg_url <- "https://upload.wikimedia.org/wikipedia/commons/c/c8/Example.ogg"

bot$sendVoice(
  chat_id = chat_id,
  voice = ogg_url
)

## End(Not run)

ebeneditos/telegram.bot documentation built on Sept. 12, 2022, 9:20 p.m.