Comment on page

didML Reference Doc

DIDforSale cPaaS is designed to provide a platform to do API development in your application using <didML> which is an acronym for DIDforSale Mark up Language.

<didML>
DIDforSale API is designed to provide you with a comprehensive tool set to make API development breeze for you. <didML> which is an acronym for DIDforSale Mark up Language puts together set of instructions to be used when programming your inbound calls. These instructions lay down step by step process as to what to do when someone calls your DIDforSale(DFS) phone number. As soon as the number is dialed DFS  will read the instructions from the URL where <didML> has listed actions that can be performed. These actions are defined as <didML> verb. Some of the examples are, Say caller name, play music, prompt for user input by pressing key.
<didML> Verbs
<didML> Verbs is the list of actions verbs that have a specific function. When programming with choice of your programming language you can include these verbs to compile your set of instructions for inbound calls. These verbs can be used by themselves or can be used in combination. This list below lists all the verbs included in <didML>. The description of the verb defines the role of the verb.
Verb
Description
<Conference>

Create a dynamic conference bridge and put the caller in that conference
<Dial>
 Connect the existing call to another party
<EnQueue>
 Put the caller in the queue.
<Fax>
 Receive the fax. System will give the fax tone to the caller and receive the fax.
<Forward>
 Same as dial. Connect the existing call to another party
<Gather>
 Collect the digits pressed from caller phone. (collect user response)
<Hangup>
 Disconnect the call
<Pause>
 Stop the call for some time before executing next instruction.
<Play>
 Play a mp3/wav audio file from the web server.
<Postcall>
URL can be supplied to collect all the details of the call.
<Queue>
Pickup the call from the queue.
<Record>
Caller is given the option to record the message
<Recording>
Record the complete call. Caller and the called party do not know if the call is being recorded unless mentioned.
<Redirect>
Redirect the call flow to different URL to access another set instructions included in another didML document.
<Reject>
Reject the incoming call.
<Say>
Read the text, convert that to audio and play to the caller.
Lets looks at the information we send you when we receive call on any of your phone numbers. 

Collect Response

Voice API Request Params

Last modified 4yr ago

Verb	Description
<Conference>	Create a dynamic conference bridge and put the caller in that conference
<Dial>	Connect the existing call to another party
<EnQueue>	Put the caller in the queue.
<Fax>	Receive the fax. System will give the fax tone to the caller and receive the fax.
<Forward>	Same as dial. Connect the existing call to another party
<Gather>	Collect the digits pressed from caller phone. (collect user response)
<Hangup>	Disconnect the call
<Pause>	Stop the call for some time before executing next instruction.
<Play>	Play a mp3/wav audio file from the web server.
<Postcall>	URL can be supplied to collect all the details of the call.
<Queue>	Pickup the call from the queue.
<Record>	Caller is given the option to record the message
<Recording>	Record the complete call. Caller and the called party do not know if the call is being recorded unless mentioned.
<Redirect>	Redirect the call flow to different URL to access another set instructions included in another didML document.
<Reject>	Reject the incoming call.
<Say>	Read the text, convert that to audio and play to the caller.