Number Control
Introduction
Once provisioned, aql numbers can be 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 |
|---|---|
| Parameter: voicemailon | Description: Either 1 or 0, to denote whether aql voicemail is enabled |
| Parameter: pstnnumber | Description: The PSTN number associated with the VoIP number (read-only) |
| Parameter: voicemaildelay | Description: The delay in seconds before an unanswered call is transferred to voicemail |
| Parameter: voicemaildest | Description: The email address for voicemail messages to be sent to |
| Parameter: forwardto | Description: Destination number for call forwarding |
| Parameter: forwardstart | Description: Time in HH:MM:SS format to start call forwarding |
| Parameter: forwardend | Description: Time in HH:MM:SS format to end call forwarding |
| Parameter: forwardcli | Description: Either 1 or 0, to denote if the original callers number should be forwarded |
| Parameter: forwardactive | Description: Either 1 or 0 to enable/disable call forwarding |
| Parameter: faxenabled | Description: 1 indicates that the number will be used for fax reception |
| Parameter: faxrecipient | Description: The email address (or addresses, comma or semicolon separated) for received faxes |
| Parameter: faxrecipientname | Description: The recipient name to use for received faxes |
| Parameter: sipendpoint | Description: The SIP endpoint of the number in form user@host (e.g. [email protected]) |
| Parameter: credit | Description: The current credit level of the number (read-only). Note that outbound faxing uses SMS credits |
| Parameter: smsaction | Description: The action to be taken with inbound SMS (httppost/httpget/email/none) |
| Parameter: smsdata | Description: The email address or URL for the inbound SMS to go to |
| Parameter: callrecord | Description: Whether the calls will be recorded or not |
action:getuser
| Parameter | Notes |
|---|---|
| Parameter: voipnumber | Notes: 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:[email protected]
forwardto:01133203040
forwardstart:00:00:00
forwardend:23:59:59
forwardactive:0
forwardcli:1
faxenabled:0
faxrecipient:[email protected];[email protected]
faxrecipientname:Joe Bloggs
sipendpoint:[email protected]
callrecord:0
credit:3.42action:changeuser
| Parameter | Notes |
|---|---|
| Parameter: voipnumber | Notes: 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.
