VoicePush API

The text to voice service provided by aql.com is an easy to use method of converting text into voice via a telephone call.

HTTP Interface

Text to voice requests are processed via our HTTP Post Interface at http://vp1.aql.com/voice_push.php

Outbound messages

The text to voice gateway requires an HTTP POST call with the following variables;

Parameter	Description
username	Your aql.com username
password	Your aql.com password
msisdn	The number to be dialled in international format
message	The text to be converted to voice
dlrData	Delivery report url [optional]
dlrType	Type of delivery report (e.g. httpget) [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
VP_OK	Success
VP_ERR_INVALIDMOBNUM	The number provided was invalid
VP_ERR_NOCREDIT	There is insufficient credit to send this message
VP_ERR_INVALIDAUTH	The username or password provided were incorrect
VP_ERR_NOAUTH	No username/password pair was provided
VP_ERR_NOMSG	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
1	Confirmed Delivered (Acknowledged)

At present no delivery reports will be sent for failed deliveries.

You may wish to include a unique identifier in the URL to enable you to keep track of messages e.g.;

http://www.yourcompany.com/reports/voicepush.php?code=%code&id=YOURID