Cover page personalization

A cover page can be personalized for each individual recipient and then attached to the front of each fax document.

A template containing keys that function as placeholders for the definitive personalized data is used to design the cover page. Customers can choose which keys in the template they want to use. An element has then to be specified in the job request including the name of the key and the value for the key that should be applied to the cover page, which allows you to specify a value for each fax recipient.

Example

Template (FreeMarker Template Language)

NONE

…
Fax from ${senderName} an ${rcptName}<br>
<b>Subject: ${subject}</b>
…

Personalization

The following parameters are provided in the fax job itself.

Key	Value
senderName	Alice
rcptName	Bob
subject	Important Message

Result - Personalized cover page

CODE

Fax from Alice to Bob
<b>Subject: Important message</b>

The template used to process a fax job is entered in the job itself. The name of the template to be used is specified in the job itself, e.g., coverpage-default.ftl.html.

Templates are stored on Retarus servers.

JSON sample with cover page customization using a default template

This example shows an example of how a job in Fax-for-Applications REST. The same logic is applied to the SOAP web service.

JSON

{
  "recipients": [
    {
      "number": "0012015551000",
      "properties": [
        {
          "key": "FromName",
          "value": "Sales Engineering Department"
        },
        {
          "key": "FromCompanyName",
          "value": "retarus, Inc."
        },
        {
          "key": "FromTelNum",
          "value": "1-855-462-0839"
        },
        {
          "key": "ToName",
          "value": "Customer Services"
        },
        {
          "key": "ToCompanyName",
          "value": "ABC Company"
        },
        {
          "key": "ToFaxNum",
          "value": "1-202-827-2391"
        },
        {
          "key": "SubjectTitle",
          "value": "Test Fax using REST API"
        },
        {
          "key": "SubjectText",
          "value": "This is a test fax for john.doe@retarus.com"
        }
      ]
    }
  ],
  "meta": {
    "customerReference": null,
    "jobValid": {
      "start": null,
      "end": null
    }
  }
}