Reseller Communication API

Our resellers now benefit the ability to re-brand and customise our email communication system.

Using either a control panel on aql.com or via an API, resellers can use a simple template syntax to tailor system-generated emails, such as a email-to-fax status notifications, with any content required in order to maintain their brand identity and ensure that customers only gain visibility of the resellers brand.

Available Templates

The following templates are available:

• fax_failfinal
• fax_failretry
• fax_noaccess
• fax_nocredit
• fax_queued
• fax_success

API Usage

The following HTTP POST requests can be sent to http://aql.com/reseller/commsapi.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

Variables and commands are specified within braces, with variabled preceded by a $ sign. The syntax is derived from the Smarty template engine.

action: gettemplate

returns:
item:pair values showing each element of the template
handle:fax_failretry
customised:1
description:An email to fax failed but will be retried
fromname:Fax Service
frommail:{$dest}@{$faxdomain}
subject:Your fax to {$dest} was not successful
body:Hello,

Your fax was not sent successfully on this attempt.

You were charged a total of {$credits} {$credittype} credits for this attempt.

There will be {$retriesleft} further attempt{if $retriesleft > 1}s{/if} at sending this fax.

customised is either 1 or 0 to indicate whether the content returned is the aql default or the customers own

action: puttemplate

Parameters marked * are optional