APIs and documentation

Email to Fax Reseller API

Introduction

Users are uniquely identified by their email address and the fax domain. The following HTTP POST requests can be sent to http://gw.aql.com/reseller/faxapi.php

Errors are returned in the form: ERR:Message

'OK' is returned for successful operations, optionally by an ID, eg: OK:22

List users

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "listusers"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
Response

A comma-separated list of email addresses and fax domains. For example:

joe@domain.com,fax.reseller.com
fred@otherdomain.net,fax.reseller.com

Get user

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "getuser"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
emailAlphanumericYes The email address of the user
faxdomainAlphanumericYes The fax domain of the user
Response

item:value pairs separated by newlines. For example:

email:joe@domain.com
faxdomain:fax.reseller.com
maxpages:
stationid:01133200032
headerinfo:Joe Bloggs
callerid:01133200032
coverpage:1
creditsused:1310
disabled:0
credit:

Change user

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "changeuser"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
emailAlphanumericYes User email address
faxdomainAlphanumericYes User fax domain
maxpagesNumericNo Leave empty if you do not want to limit this
calleridAlphanumericNo
stationidAlphanumericNo
headerinfoAlphanumericNo
coverpageNumericNo The ID of the cover page. Note that this can be found using "list cover pages" action (described below).
disabledBooleanNo Disable or enable sending from this address
creditNumericNo Sets the amount of credit available on the user. Send to an empty value to allow user to use all the available credit on the account.
addcreditNumericNo When a user has an individual credit limit, this adds the specified amount to the remaining balance
Response

OK or ERR:Error Message

Add user

Add user
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "adduser"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
emailAlphanumericYes User email address
faxdomainAlphanumericYes User fax domain
stationidAlphanumericYes This will also set the caller id for the call if the callerid parameter is not provided
calleridAlphanumericNo
headerinfoAlphanumericYes
maxpagesAlphanumericNo Leave empty if you do not want to limit this
coverpageAlphanumericNo The ID of the cover page. Note that this can be found using "list cover pages" action (described below).
Response

OK or ERR:Error Message

List cover pages

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "listcoverpages"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
Response

A csv list of IDs and names in the form

5,Default Cover Page

Get cover page

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Values must be "getcoverpage"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
idNumericYes ID obtained from the "list cover pages" action above.
Response

Returns the cover page content.

Add a cover page

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "addcoverpage"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
nameAlphanumericYes The name of the cover page; an arbitrary identifier
contentAlphanumericYes The content of the cover page template.
Response

Returns OK:<id> where <id> is the new cover page ID

Change cover page

Request
ParameterTypeRequiredLengthDescription
actionAlphanumericYes Value must be "changecoverpage"
usernameAlphanumericYes aql username
passwordAlphanumericYes aql password
idNumericYes ID obtained using "list cover pages" action (described above)
contentAlphanumericYes The new content of the cover page template
Response

Returns OK


Back to Documentation and APIs

Follow us on Twitter

Like us on Facebook

Connect to us on LinkedIn

Where we are

aql
13-15 Hunslet Road
Leeds
LS10 1JQ
Telephone 01133 20 30 40