Number control API
Once provisioned, aql numbers can configured for any purpose via our extensive API.
Number pricing will be as arranged with your account manager.
Once a number has been provisioned using the provisioning API, it may be configured using the following operations.
The following HTTP POST requests can be sent to:
http://gw.aql.com/reseller/voipapi.php
Errors are returned in the form: ERR:Message
‘OK’ is returned for successful operations, optionally by an ID, e.g.: OK:22
Required parameters for all operations:
- username – aql.com username
- password – aql.com password
- action – the action name
The following parameters may be accessed via the getuser command, or amended using the changeuser command:
| Parameter | Description |
|---|---|
| voicemailon | Either 1 or 0, to denote whether aql voicemail is enabled |
| pstnnumber | The PSTN number associated with the VoIP number (read-only) |
| voicemaildelay | The delay in seconds before an unanswered call is transferred to voicemail |
| voicemaildest | The email address for voicemail messages to be sent to |
| forwardto | Destination number for call forwarding |
| forwardstart | Time in HH:MM:SS format to start call forwarding |
| forwardend | Time in HH:MM:SS format to end call forwarding |
| forwardcli | Either 1 or 0, to denote if the original callers number should be forwarded |
| forwardactive | Either 1 or 0 to enable/disable call forwarding |
| faxenabled | 1 indicates that the number will be used for fax reception |
| faxrecipient | The email address (or addresses, comma or semicolon separated) for received faxes |
| faxrecipientname | The recipient name to use for received faxes |
| sipendpoint | The SIP endpoint of the number in form user@host (e.g. 12345@sip.aql.com) |
| credit | The current credit level of the number (read-only). Note that outbound faxing uses SMS credits |
| smsaction | The action to be taken with inbound SMS (httppost/httpget/email/none) |
| smsdata | The email address or URL for the inbound SMS to go to |
| callrecord | Whether the calls will be recorded or not |
action:getuser
| Parameter | Notes |
|---|---|
| voipnumber | The VoIP number to query, 6-8 digits, beginning 6 or 7 |
returns
item:value pairs separated by newlines, e.g.:
voipnumber:606309 pstnnumber:441133200142 voicemailon:1 voicemaildelay:30 voicemaildest:user@example.com forwardto:01133203040 forwardstart:00:00:00 forwardend:23:59:59 forwardactive:0 forwardcli:1 faxenabled:0 faxrecipient:faxuser@example.com;otherfaxuser@example.com faxrecipientname:Joe Bloggs sipendpoint:606309@sip.aql.com callrecord:0 credit:3.42
action:changeuser
| Parameter | Notes |
|---|---|
| voipnumber | The VoIP number to modify, 6-8 digits, beginning 6 or 7 |
Any of the fields returned in the getuser operation above (apart from credit), together with a new value.
action:listusers
This action takes no parameters.
returns
A newline separated list of all the VoIP usernames and the corresponding PSTN numbers on the account.
action:listusers_e164
This action takes no parameters.
returns
A newline separated list of all the VoIP usernames and the corresponding PSTN numbers on the account.
