Voice API Request Params

Documentation for Developer/Administrators

Search…

Detail of the information we send you when we receive a call. This information can be used to make a decision in your application.

DIDforSale sends Request to your webserver
As soon as someone dials your DIDforSale phone number, DIDforSale will send an HTTP request to the weburl you have configured with the phone number.
How do I know which URL is being connected with a specific phone phone number?
 Log in to your DIDforSale account, click on a phone number and see which URL its linked with. You can direct each phone number to connect with unique URL’s if you have specific instructions/purpose for them.
What is the importance of URL connected with the phone number?
 This URL holds the instruction file defined by you.
So for a phone number to be handled in a specific order, there has to be a URL that its linked to. This URL holds the dial plan or the instruction file that’s created by you. When someone dials your DIDforSale phone number, an HTTP request is send to the connected URL, The system then will wait to get response from the <didML> and handle the call respectively.
Data flow between DFS platform and Client Application
What is included in the Request?
Idea is to give you flexibility to built a dynamic application. So when we send first request for the URL, we also pass some information about the call in the post variables.
POST: DIDforSale will submit the call related information in a form to the URL when request is made
You can use all or some of them.
To=”..DIALED_NUMBER..”&From=”..caller_id_number..”&CallerName=”..caller_id_name..”&callSid=”..UUID..”&Direction=”..direction..”&CallStatus=”..callstatus
To: The number that end user dialed.
 From: Callers Caller ID
 CallerName: Name of the caller from database, If name is not registered, then we can provide City and State (*Extra charges may apply)
 callSid: Unique id for each call. Can be useful for reporting purpose.
 Direction: Whether the call is an inbound or outbound call.
 Callstatus: What state the call is in at the time of this request. (On hold, in Queue, answered etc.)

didML Reference Doc

Voice API Response

Last modified 3yr ago

Copy link

Outline

DIDforSale sends Request to your webserver

What is included in the Request?