Telegram.Bot.API.Methods.SendVoice

sendVoice

data SendVoiceRequest

Request parameters for sendVoice.

Constructors

SendVoiceRequest

Fields

• sendVoiceChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendVoiceMessageThreadId :: Maybe MessageThreadId

  Unique identifier for the target message thread (topic) of the forum; for forum supergroups only.

• sendVoiceVoice :: InputFile

  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 info on Sending Files »

• sendVoiceCaption :: Maybe Text

  Voice message caption, 0-1024 characters after entities parsing

• sendVoiceParseMode :: Maybe ParseMode

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

• sendVoiceCaptionEntities :: Maybe [MessageEntity]

  A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

• sendVoiceDuration :: Maybe Int

  Duration of the voice message in seconds

• sendVoiceDisableNotification :: Maybe Bool

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

• sendVoiceProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving

• sendVoiceReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message

• sendVoiceAllowSendingWithoutReply :: Maybe Bool

  Pass True, if the message should be sent even if the specified replied-to message is not found

• sendVoiceReplyMarkup :: Maybe InlineKeyboardMarkup

  Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Instances

ToJSON SendVoiceRequest

Defined in Telegram.Bot.API.Methods.SendVoice

Methods

toJSON :: SendVoiceRequest -> Value

toEncoding :: SendVoiceRequest -> Encoding

toJSONList :: [SendVoiceRequest] -> Value

toEncodingList :: [SendVoiceRequest] -> Encoding

Generic SendVoiceRequest

Defined in Telegram.Bot.API.Methods.SendVoice

Associated Types

type Rep SendVoiceRequest :: Type -> Type

Methods

from :: SendVoiceRequest -> Rep SendVoiceRequest x

to :: Rep SendVoiceRequest x -> SendVoiceRequest

ToMultipart Tmp SendVoiceRequest

Defined in Telegram.Bot.API.Methods.SendVoice

Methods

toMultipart :: SendVoiceRequest -> MultipartData Tmp

type Rep SendVoiceRequest

Defined in Telegram.Bot.API.Methods.SendVoice

type Rep SendVoiceRequest = D1 ('MetaData "SendVoiceRequest" "Telegram.Bot.API.Methods.SendVoice" "telegram-bot-api-6.7-8B5O9jcStFh8aacJiwZZeM" 'False) (C1 ('MetaCons "SendVoiceRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendVoiceChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "sendVoiceMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: S1 ('MetaSel ('Just "sendVoiceVoice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile))) :*: (S1 ('MetaSel ('Just "sendVoiceCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sendVoiceParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :*: S1 ('MetaSel ('Just "sendVoiceCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity]))))) :*: ((S1 ('MetaSel ('Just "sendVoiceDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "sendVoiceDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendVoiceProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "sendVoiceReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: (S1 ('MetaSel ('Just "sendVoiceAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendVoiceReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendVoiceContent = "sendVoice" :> (MultipartForm Tmp SendVoiceRequest :> Post '[JSON] (Response Message))

type SendVoiceLink = "sendVoice" :> (ReqBody '[JSON] SendVoiceRequest :> Post '[JSON] (Response Message))

sendVoice :: SendVoiceRequest -> ClientM (Response Message)

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 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.

defSendVoice :: SomeChatId -> InputFile -> SendVoiceRequest