Email To Fax Reseller API
Users are uniquely identified by their email address and the fax domain. The following HTTP POST requests can be sent to http://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
Required parameters for all operations:
username - aql.com username
password - aql.com password
action - the action name
action: listusers
returns:
A csv list of email addresses and fax domains in the form:
joe@domain.com,fax.reseller.com
fred@otherdomain.net,fax.reseller.com
action: getuser
| Parameter |
Notes |
| email |
| faxdomain |
returns:
item:value pairs separated by newlines. E.g.
email:joe@domain.com
faxdomain:fax.reseller.com
maxpages:
stationid:01133200032
headerinfo:Joe Bloggs
callerid:01133200032
coverpage:1
creditsused:1310
disabled:0
credit:
action: changeuser
| Parameter (* optional) |
Notes |
| email |
| faxdomain |
| max pages * |
empty = no limit |
| callerid * |
string |
| stationid * |
string |
| headerinfo * |
string |
| coverpage * |
integer - see coverpage actions |
| disabled * |
1 or 0 - disabled sending from the address |
| credit * |
sets the amount of credit available on the user. set to an empty string to allow use of all the available credit on the account |
| addcredit * |
when a user has an individual credit limit, this adds the specified amount to the remaining balance |
returns:
OK or ERR:Error Message
action: adduser
| Parameter (* optional) |
Notes |
| email |
| faxdomain |
| stationid |
string - will also set the caller id for the call if the callerid parameter is not provided |
| callerid |
string * |
| headerinfo |
string |
| max pages * |
empty = no limit |
| coverpage * |
integer - see coverpage actions |
returns:
OK or ERR:Error Message
action: listcoverpages
returns:
A csv list of IDs and names in the form
5,Default Cover Page
action: getcoverpage
| Parameter |
Notes |
| id |
integer - ID obtained from listcoverpages |
returns:
The coverpage content
action: addcoverpage
| Parameter |
Notes |
| name |
string - arbitrary identifier |
| content |
string - the template |
returns:
OK:<id>
where <id> is the new coverpage ID
action: changecoverpage
| Parameter |
Notes |
| id |
integer - ID obtained from listecoverpages |
| content |
string - the template |
returns:
OK
|
