Wholesale fax provisioning API

Wholesale customers can provision fax services on their own, non-aql, numbering using the following API.

The following HTTP POST requests can be sent to:

http://gw.aql.com/reseller/wsfaxapi.php

Errors are returned in the form: ERR:Message

‘OK’ is returned for successful operations

Required parameters for all operations:

  • username – aql.com username
  • password – aql.com password
  • action – the action name

action:adduser

Parameter Notes
faxnumber The Fax Number in international form (e.g. 441133203040)
name The “Friendly Name” to associate with the fax number
email The email address to associate with the fax number
format The file format to be used when emailing faxes [pdf|tif]

Returns OK if successful, ERR: (followed by an error description) otherwise.

action:getuser

Parameter Notes
faxnumber The Fax Number in international form (e.g. 441133203040)

Returns item:value pairs separated by newlines, e.g.:

name:Joe User
email:user@example.com
format:pdf

action:changeuser

Parameter Notes
faxnumber The Fax Number in international form (e.g. 441133203040)
name The “Friendly Name” to associate with the fax number
email The email address to associate with the fax number
format The file format to be used when emailing faxes [pdf|tif]

Returns OK if successful, ERR: (followed by an error description) otherwise.