Telegram.Bot.API.Methods.SendAudio

sendAudio

data SendAudioRequest

Request parameters for sendAudio.

Constructors

SendAudioRequest

Fields

• sendAudioChatId :: SomeChatId

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

• sendAudioMessageThreadId :: Maybe MessageThreadId

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

• sendAudioAudio :: InputFile

  Audio to send. Pass a file_id as String to send an audio that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a audio from the Internet, or upload a new audio using multipart/form-data. More info on Sending Files »

• sendAudioDuration :: Maybe Int

  Duration of sent audio in seconds

• sendAudioPerformer :: Maybe Text

  Performer

• sendAudioTitle :: Maybe Text

  Track name

• sendAudioThumb :: Maybe InputFile

  Thumbnail 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 multipartform-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 multipartform-data under file_attach_name. More info on Sending Files »

• sendAudioCaption :: Maybe Text

  Audio caption (may also be used when resending audios by file_id), 0-1024 characters after entities parsing

• sendAudioParseMode :: 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.

• sendAudioCaptionEntities :: Maybe [MessageEntity]

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

• sendAudioDisableNotification :: Maybe Bool

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

• sendAudioProtectContent :: Maybe Bool

  Protects the contents of the sent message from forwarding and saving

• sendAudioReplyToMessageId :: Maybe MessageId

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

• sendAudioAllowSendingWithoutReply :: Maybe Bool

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

• sendAudioReplyMarkup :: 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

Generic SendAudioRequest

Defined in Telegram.Bot.API.Methods.SendAudio

Associated Types

type Rep SendAudioRequest :: Type -> Type

Methods

from :: SendAudioRequest -> Rep SendAudioRequest x

to :: Rep SendAudioRequest x -> SendAudioRequest

ToJSON SendAudioRequest

Defined in Telegram.Bot.API.Methods.SendAudio

Methods

toJSON :: SendAudioRequest -> Value

toEncoding :: SendAudioRequest -> Encoding

toJSONList :: [SendAudioRequest] -> Value

toEncodingList :: [SendAudioRequest] -> Encoding

ToMultipart Tmp SendAudioRequest

Defined in Telegram.Bot.API.Methods.SendAudio

Methods

toMultipart :: SendAudioRequest -> MultipartData Tmp

type Rep SendAudioRequest

Defined in Telegram.Bot.API.Methods.SendAudio

type Rep SendAudioRequest = D1 ('MetaData "SendAudioRequest" "Telegram.Bot.API.Methods.SendAudio" "telegram-bot-api-6.5-inplace" 'False) (C1 ('MetaCons "SendAudioRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sendAudioChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "sendAudioMessageThreadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageThreadId)) :*: S1 ('MetaSel ('Just "sendAudioAudio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputFile))) :*: ((S1 ('MetaSel ('Just "sendAudioDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sendAudioPerformer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sendAudioTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendAudioThumb") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InputFile))))) :*: (((S1 ('MetaSel ('Just "sendAudioCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sendAudioParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode))) :*: (S1 ('MetaSel ('Just "sendAudioCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :*: S1 ('MetaSel ('Just "sendAudioDisableNotification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "sendAudioProtectContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAudioReplyToMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "sendAudioAllowSendingWithoutReply") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "sendAudioReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe InlineKeyboardMarkup)))))))

type SendAudioContent = "sendAudio" :> (MultipartForm Tmp SendAudioRequest :> Post '[JSON] (Response Message))

type SendAudioLink = "sendAudio" :> (ReqBody '[JSON] SendAudioRequest :> Post '[JSON] (Response Message))

sendAudio :: SendAudioRequest -> ClientM (Response Message)

Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

For sending voice messages, use the sendVoice method instead.