When handling an inbound call, TelAPI requests the Voice Request URL (or any other subseqent URLs TelAPI may interacte with) using standard HTTP GET or POST methods. The method can be specified on a case by case basis but both send the following default request parameters so TelAPI has some information about the call taking place. If the initial request method is GET, these values are sent as URL query parameters. If it is POST, they are sent as POST parameters.
| Parameter | Description |
|---|---|
|
Alphanumeric string identifying the account this call occurred through.
|
|
|
The version of the API the call is using (currently only v1).
|
|
|
The direction of the call.
|
|
|
The name registered to the phone calling.
|
|
|
The number called.
|
|
|
The number calling.
|
|
|
Alphanumeric string identifying this call.
|
|
|
Status of the call. May be: queued, ringing, in-progress, completed, busy, failed, no-answer, or canceled.
|
|
|
The base URL that was consulted at call connection.
|
|
|
Boolean value specifying whether the inbound number calling was unblocked. This parameter will only be default for DIDs that have unblocking enabled.
|
|
|
The number this call was forwardedFrom. This parameter will only be present if the call was forwarded.
|
In requests, TelAPI tries to change all phone numbers to E.164 format (e.g. (123)-456-7890 to 1234567890). If it can not, it uses the raw number input.
Also in TelAPI requests, the date "1:22 PM PDT on January 12th, 2012 " would be "Thu, 12 Jan 2010 01:22:00 -4000" to adhere to UTC in RFC 2822 format.