Voice Push API
Introduction
Please note that access to this API is restricted to only those accounts that have the voice push service enabled. Please contact us if you are interested in this service.
HTTP Interface
Text to voice requests are processed via our HTTP Post Interface at:
https://gw.aql.com/voice_push.php - Latest API (recommended)
Outbound Messages
The text to voice gateway requires an HTTP POST call with the following variables:
| Parameter | Description |
|---|---|
| Parameter: username | Description: Your aql.com username |
| Parameter: password | Description: Your aql.com password |
| Parameter: msisdn | Description: The number to be dialled in international format |
| Parameter: message | Description: The text to be converted to voice |
| Parameter: dlrData | Description: Delivery report URL [optional] |
| Parameter: dlrType | Description: Type of delivery report (either 'httpget' or 'email') [optional] |
Responses
You will receive a response from our gateway as follows:
VP_OK
Message queued for sending
This take the form of a two-line response. The first line is an error code with the second a short string describing the status. The complete list of possible values are as follows:
| Error Code | Description |
|---|---|
| Error Code: VP_OK | Description: Success |
| Error Code: VP_ERR_INVALIDMOBNUM | Description: The number provided was invalid |
| Error Code: VP_ERR_NOCREDIT | Description: There is insufficient credit to send this message |
| Error Code: VP_ERR_INVALIDAUTH | Description: The username or password provided were incorrect |
| Error Code: VP_ERR_NOAUTH | Description: No username/password pair was provided |
| Error Code: VP_ERR_NOMSG | Description: No message was provided |
Delivery Reports
If delivery reports are required you can specify a URL in the dlrData parameter which will be called when a message is confirmed as being successfully delivered.
The placeholder '%code' will be translated to the status code of the message which will be one of the following:
| Status Code | Description |
|---|---|
| Status Code: 1 | Description: Confirmed delivered (acknowledged) |
| Status Code: 2 | Description: Unable to deliver the message |
URL to enable you to keep track of messages e.g. http://www.yourcompany.com/reports/voicepush.php?code=%code&destination=%dest&id=YOURID - Latest API (recommended)
