Supported Call Execution Verbs and Attributes

💬

<say>

The <say> verb is used to play a text or speech synthesis markup language (SSML) message during the call.

Attributes	Value schema	Discerption
Text	[_type text_] [Mandatory]	The text that you want to play during the call, We also accept SSML format for audio tunning "
Reps	[*type number*] default = 1	Number of repetition for the text
Lang	[*type text*]	Select Language code for example "arb" , "ar-AE" , "en-GB" , "en-US" , fr-FR .
Voice	[*type text*]	Select Voice ID for example for Arabic Ziena or Hala [ AE Accented bilingual voice] , for Urdu Uzma, Asad , for English Kendra, Joanna,Matthew

---

SampleArabic Sample

<say reps="3">"Welcome to CEQUENS voice service." </say>

<say lang="arb" voice="Zeina">"مرحبا بك فى سكونس" </say>

💬

<play>

The <play> verb is used to play an audio file during the call.

Attributes	Value schema	Discerption
Url	[*type url*] [Mandatory]	The Url of the audio file to play we expect Audio PCM uncompressed 16bit 8khz mono.

---

Sample

<play url='http://example.com/audiofile.wav'></play>

💬

<record>

The <record> verb is used to record the call audio.

Attributes	Value schema	Discerption
TerminateOn	[*type char*] The default is #.	A character that terminates recording.
MaxSilence	[*type number*] The default is 5.	The maximum number of seconds of silence that can occur during recording before it automatically terminates.
MaxDuration	[*type number*]	The maximum duration, in seconds, of the recording. default = 0 , which mean it can span over the total call duration if no other stopper option provided
Format	[*type text*]	The audio format to use for the recording. Possible values include mp3, wav, and aac, among others.
RecordURL	[*type url*]	The URL to which the recorded audio URL will be sent.
PlayBeep	[*type boolen*] the default is true.	Whether or not to play a beep sound to indicate the start of recording.

---

Sample

<record terminateOn='#' maxSilence='5' maxDuration='15' format='wav' playBeep='true' recordURL='http://ngrok:9080/test'> </record>

💬

<Dial>

The <dial> verb is used to connect a call to a specific phone number.

Attributes	Value schema	Discerption
To	[type number]	The phone number to which the call should be connected.
Caller	[type number]	The caller ID to display when making the call.

---

Sample

<dial to='201002071244' caller='6523'></dial>

💬

<gather>

The <gather> verb is used to collect user input during the call.

Attributes	Value schema	Discerption
dtmfCallbackURL	[_type url_] [Mandatory]	"The Url that you want to receive the captured input from user _And we expect your Url endpoint is return a valid call ExecutionPlan xml"
Text	[_type text_] [Mandatory]	The text to be played or read out to the caller before gathering the input.
RepCount	[_type number_]	Number of times to play the text to the caller.
Lang	[*type text*]	Select Language code for example "arb" , "ar-AE" , "en-GB" , "en-US" , fr-FR .
Voice	[*type text*]	"Select Voice ID for example for Arabic Ziena or Hala [ AE Accented bilingual voice] , for Urdu Uzma, Asad , for English Kendra, Joanna,Matthew
MaxChar	[_type number_]	"The maximum number of characters to be gathered.
StopChar	[_type character_]	The character used to stop the input gathering process.
MatchHash	[_type bolean_]	Set to true if a "#" entered by the caller should be treated as the stop character.
WaitDuration	[_type number_]	The number of seconds to wait for the caller to start entering input.
InnerTimeout	[_type number_]	"the number of seconds to wait between each input from the user"
TotalTimeout	[_type number_]	"Maximum amount of time to wait (after the stop of the audio) for digits to be received default 4sec."
ExitOnFirstDTMF	[_type bolean_]	enables exiting the playback when DTMF is received

---

Sample

<gather dtmfCallbackURL="https://localhost:9000/flow1" stopChar="#" > Hi I am here, Welcome to cequens voice service. Please enter you number followed by the hash key</gather\>