AVANSER Telco API (202610)
AVANSER Telco API is designed to provide an easy way to order and manage client services.
AVANSER Telco API is Agency friendly. Users can be configured to have access to multiple AVANSER accounts, facilitating service automation.
AVANSER Telco API requires HTTP Basic Authentication over HTTPS.
- Contact AVANSER Support to obtain your credentials.
AVANSER fluid requires HTTP Basic Authentication to access the services as described here
All Requests require authentication
Authorization: Basic {Authentication}- HTTP_BASIC
- username: {AVANSER_username}
- password: {AVANSER_password}
To make the AVANSER Telco API easy, all responses are in JSON format, along with the HTTP Basic authentication. This API has been developed to be friendly with NodeJs, Javascript, Java or PHP.
The @transaction object returned in any reply provide constant feedback on the selected account and the API details.
This API is designed to ease configuration & provisioning of AVANSER transfer and voicemail services. Future releases will include other call features.
The complete call feature is however available through the AVANSER support.
All Provisioning requests provide a status update (Callback-URI). If enabled, AVANSER Telco API returns all request status updates, such as:
- Service Creation
- Service Update
- Service Decommission
An acknowledgment message is returned with any asynchronous request. The acknowledgment message confirms if the request was submitted successfully.
Request status can be always monitored through the List Requests API call.
Call tags can be used in Templates and Call notification email subject.
| TAG | Example | Description |
|---|---|---|
__location__ | Sydney, NSW, Australia | detected call location |
__outnum__ | +61-0290080000 | Answer Point number |
__dateTime__ | 2016-04-15 10:23:20 | call date, according to Answer Point timezone |
__bnum__ | +61-0290080000 | Call Tracking service number |
__ani__ | +61-0420000000 | Caller Party number if not available a private reference is returned |
__adsource__ | Tracking Service 1 | Friendly name associated with the service number |
__callDuration__ | 36 | Call duration, expressed in seconds |
__callstatus__ | Answered | Call status: Abandoned, Unanswered, Busy, Answered |
__URL__ | http://path/to/audio/file.mp3 | Audio recording download url |
__link__ | <a href="">audio file</a> | Audio recording url, HTML Anchor link format |
When a service is successfully provisioned, a Callback is set to the configured call_callback_uri.
Request are sent to the desired call_callback_uri as POST.
- Headers
Content-Type: application/json{
"account_id" : 6999,
"request_id" : "c9220015e2f48bc7cf4b38186a7b2025",
"custom_id" : "client desired unique id",
"status" : "completed",
"message": "Request completed successfully"
"service_number" : "611300123123",
"answer_point": "614201010100"
}{
"account_id" : 6999,
"request_id" : "c9220015e2f48bc7cf4b38186a7b2025",
"custom_id" : "client desired unique id",
"status" : "failed",
"message" : "Selected service number is not available",
"service_number" : "611300123123",
"answer_point": "614201010100"
}If enabled, calls are reported to the desired url as POST Requests.
| Description | Parameter | Example |
|---|---|---|
| AVANSER's ClientID | clientid | 6999 |
| AVANSER's CallID | callid | 324213111 |
| AVANSER's UniqueId | uniqueid | ECS1-1923211.11 |
| Tracking Service # | bnum | +61-0290081596 |
| Tracking Service Name | adname | Tracking Service 1 |
| AnswerPoint # | target | +61-0401020304 |
| AnswerPoint Name | targetname | Sydney Office |
| Caller Party # | ani | +61-0410203045 |
| Call Date (ISO 8601) | tzdate | 2019-11-14T12:11:21+10:00 |
| Call Duration (sec.) | duration | 30 |
| Call Status | callstatus | tags, available values are: avanser_abandoned_call, avanser_answered_call, avanser_busy_call, avanser_unanswered_call, avanser_fax_call, avanser_missed_call |
| Call status code | callcode | 1 |
| Call location | clocation | Sydney |
| Call state | cstate | MOB |
| Call country | ccountry | AU |
If enabled for services supporting SMS messages, each inbound SMS is sent to the configured sms_forward_uri using an HTTP POST request. The following parameters are sent in the request body:
| Description | Parameter | Example |
|---|---|---|
| AVANSER's ClientID | clientId | 6999 |
| SMS Recipient | to | +61-0401020304 |
| SMS Sender | from | +61-0401020305 |
| SMS Text | txt | this is a test message |
| SMS Date | date | 2016-04-12 10:10:10 |