Dialplans & Verbs

With Dialplans and Verbs you can control your voice calls

You can create custom dialplans that fit your needs. You are able to use a combination of prerecorded audio files, text to speech, connection to another recipient. It is possible to change a dialplan dynamically through the use of DTMF tones.

A valid dialplan is constructed by the "verbs" array of verb objects, in JSON format (you can check the example below).

The supported action verbs of a dialplan are the following:

  • SAY (text to speech)
  • PLAY (prerecorded audio file)
  • DIAL (connection to another recipient)
  • PAUSE (temporary stop the dialplan execution)
  • COLLECT (DTMF tones gathering)

The "verbs" array cannot be empty and it contains the verbs that are going to be executed. It may contain many SAY, PLAY and PAUSE verbs, but only one DIAL.

{
  "verbs":[
    {
      "type" : "SAY",
      "message" : {
        "language" : "en-US",
        "gender" : "male",
        "text" : "Hello. This is an example of a valid dialplan"
      }
    },
    {
      "type" : "PLAY",
      "fileURL" : "http://an-example-wav-file.wav"
    },
    {
      "type":"PAUSE",
      "duration":5
    },
    {
      "type": "DIAL",
      "from":"xxxxxxxx",
      "to": {
        "phone":"+3069xxxxxxxx"
      }
    },
    {
    "type":"COLLECT",
    "submitOnHash":true,
    "eventUrl":"http://xxxxxxxxx"
  }
  ]
}

KEY

DESCRIPTION

verbs*

An array of verb objects that are going to be executed (SAY, PLAY, DIAL, PAUSE, COLLECT).