This site is no longer updated.Go to new Conversational Cloud docs

audio


To send an audio file to a chat, use the audio reply type.

You can also use the equivalent audio DSL tag or the $reactions.audio method.

Properties

Property Type Required Description
audioUrl String Yes An audio file URL.
audioName String No An audio file name.

Syntax

{
  "type": "audio",
  "audioUrl": "https://www.example.com/example.mp3",
  "audioName": "CallRecording"
}

Channel restrictions

audio is not supported in the following channels:

  • Bitrix24
  • Chat2Desk
  • Jivo
  • Marusia
  • Salut
  • Slack
  • Viber
  • Webim (Custom Channel API)
  • WeChat
  • Zendesk
  • Zendesk Chat

How to use

state: Welcome
    q!: $regex</start>
    script:
        $response.replies = $response.replies || [];
        $response.replies.push({
            "type": "audio",
            "audioUrl": "https://www.example.com/welcome.mp3"
        });