Call Handle Commands

Call Handling: MAKE, SLEEP, DROP SESSIONS, HANGUP

   MakeCall

Parameter Required Value
function Yes MakeCall
calling_party Yes Calling party number
called_party Yes Called party number
ringtone No Play ringtone, valid value
Default =
au = Australian
eu =European
jp = Japanese
uk = UK
us = US
record_call No Record conversation
Default value = "false"
Valid value = “true” or “false”
record_split No Split record conversation to individual recording file.
Default value = "false"
Valid value = “true” or “false”
record_callback_method No Record status callback method
Valid value = “GET” or “POST”
record_callback_url No Record status callback URL
handle_interrupt No Force callback to handle URL when outbound call disconnected.
Default = "false"
Valid value = “true” or “false”
record_wait_sync No Enforce record callback webhook sent only when the recording file is ready for download.
Valid value = “true” or "false"
Default = “false”
Call Handling: PLAY TTS, PLAY FILE, START/STOP RECORDING

   Play TTS

Parameter Required Value
function Yes PlayTTS
message Yes Text to speech message
voice Yes f = female, m = male
language Yes Two letter language abbreviation (e.g. “en” = English)
See also “Text-to-Speech Language Support
dtmf No Collect DTMF input
Valid range = 0 ~ 20
Default = 0
replay No Replay TTS
Valid range = 0 ~ 3
Default = 0
Note: if dtmf = 0, TTS will replay based on replay value, if dtmf >0, TTS will replay only if no input
no_dtmf_message No Text to speech message, only play if dtmf >0 and no input, if no_dtmf_message not provided, “message” will be played.
Default =
handle_interrupt No Force callback to handle URL after DTMF input, subsequence command will be deleted, new command will be executed based on callback returned. See: Handle Callback Event – DTMF for details.
Valid value = “true” or “false”
Default = “false”
Note

System will answer the incoming call if PlayTTS on incoming call.

Scenarios
The code samples provided below are for reference, only.
Scenario: PlayTTS and MakeCall
{
  	"commands": [
      {
        "function":"PlayTTS",
        "message":"This is a test message!",
        "voice":"f",
        "language":"en",
        "dtmf":0,
        "replay":0
      },
      {
        "function":"MakeCall",
        "called_party":"6531234567",
        "calling_party":"6598765432",
        "ringtone":"us",
      }
    ]
}