Extended VoIP API

«aql messaging services» «aql voice services»


Extended VoIP API

Account Login

Lost password?

	aql ®
	Award Winning Service

	aql SMS Messaging
	Click here to view aql's range of SMS messaging solutions

	Getting Started
	Sign up online for FREE internet phone calls

Extended VoIP 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://aql.com/reseller/voipapi.php

Errors are returned in the form: ERR:Message

'OK' is returned for successful operations, optionally by an ID, eg: 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
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
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

action:getuser

Parameter	Notes
voipnumber	The voip number to query, 6 digits, beginning 6 or 7

returns:

item:value pairs separated by newlines. eg:

voipnumber:606309
pstnnumber:441133200142
voicemailon:1
voicemaildelay:30
voicemaildest:user@example.com
forwardto:01133203040
forwardstart:00:00:00
forwardend:23:59:59
forwardactive:0
faxenabled:0
faxrecipient:faxuser@example.com;otherfaxuser@example.com
faxrecipientname:Joe Bloggs
credit:3.44

action:changeuser

Parameter	Notes
voipnumber	The voip number to modify, 6 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 on the account.