Phone Lines icon GFI Support

Articles in this section

See more

Creating TextAPIs

Author: Shera Matig-a Updated

Overview

This article guides you on how to generate TextAPI files.

 

Process

When using TextAPI, create a text file (.txt format) that is structured as follows:

Line Description
First Line

Specify the recipient's fax number preceded by a double colon, in the following format: ::fax number

For example: ::12345678

Other parameters can also be included in the following format:

::first name, company, last name, department, email address, fax number

For example, to send a fax to John Smith who is in the Sales department at company John Company and whose email address and fax number are sales@johncompany.com and 12345678 respectively, the entry will be as follows:

::John, John Company, Smith, Sales, sales@johncompany.com, 12345678
Second Line (optional)

Specify other sending options preceded by a double colon.
For example: ::S=pricelist

Separate multiple parameters by commas.
For example: ::c=cover1,23:15,B=5

For more information refer to TextAPI Sending Options.
Other lines Enter the message text to fax.


TextAPI Sending Options

  • A number of sending options can be specified in the second line of the text API.
  • Multiple options can be specified. Separate multiple parameters by commas.
    For example: ::s=subject,from=Peter,c=coverpage1,23:15,B=5
  • GFI FaxMaker is not case-sensitive. Parameters can be specified in both capital or small letters.

Sending Options Parameter Description
Subject

::S=This is the subject

or

::subject=This is the subject

 Specify the subject of the fax. This text is inserted in the <subject> field of the Coverpage. Replace This is the subject with the subject text.
Sender

::fr=name

or

::from=name

Use this parameter to specify the name of the fax sender. The name specified is included as the sender's name in the Coverpage. Replace name with the sender's name.

NOTE: When this option is not specified, GFI FaxMaker has no information about the sender and therefore cannot return a transmission report via email. Instead, a response file is generated. 

For more information refer to TextAPI Response Files.
Attachment

::A=FileName

Specify a file to attach to the fax. The file must be stored in the same TextAPI pickup folder.

Replace FileName with the name and extension of the file to attach.

For example: ::A=FaxAttachment.tif

Multiple files can be attached by specifying the command multiple times.

For example: ::A=file1.tif,A=file2.tif

NOTE: Attachments are permanently removed from the pickup folder. If a copy is required, ensure that backup is taken before moving the attachment to the TextAPI folder.
Priority

High priority

::p=high

or

::p=h

or

::priority=high

or

::priority=h

Low priority

::p=low

or

::p=l

or

::priority=low

or

::priority=l

 Specify the fax priority (low or high) to use when sending the fax.
Billing Code

::B=nnnn

or

::billingcode=nnnn

 Use this parameter to specify a billing code if GFI FaxMaker is configured to require a billing code. Replace nnnn with the billing code.
Schedule

::YYYY-MM-DD-hh:mm:ss

or

::hh:mm

Specify the date and time, or time only when to send the fax.

Replace:

  • YYYY - year
  • MM - month
  • DD - day
  • hh - hours in 24-hour clock format
  • mm - minutes
  • ss - seconds

For example, ::2019-04-21-16:05:00
Coverpage

::C=CoverpageName

or

::Coverpage=CoverpageName

By default, GFI FaxMaker uses the default Coverpage configured in GFI FaxMaker. Use this parameter to send a fax using a particular Coverpage. Replace CoverpageName with the name of the Coverpage to use, as configured in GFI FaxMaker.

You can also use ::C=none to not add a Coverpage.
Front Covernote

::F=FrontCovernote

or

::frontcover=FrontCovernote

Use this parameter to send a fax using a particular Front Covernote. Replace FrontCovernote with the name of the Front Covernote to use, as configured in GFI FaxMaker.
Fax Line

::line=n

or

::l=n

Specify this parameter to request the fax to be sent on a particular fax line. Replace n with the fax line number as configured in GFI FaxMaker Configuration.

NOTE: If the line is busy or unavailable, the fax is sent on another line. To send the fax strictly from a particular line, use the following parameter:

::dl=n

The fax is not sent until this fax line is available.

NOTE: dl parameter is also available when using TextAPI commands in SMS to request an SMS to be sent over particular GSM line.
Resolution

High resolution

::H

or

::high

Normal resolution

::N

or

::normal

 Use this parameter to specify the resolution of the fax. Use high (200 * 200 dpi) or normal (200 * 100 dpi) resolution.
Header

::fh=header

or

::faxheader=header

 Use this option to set a custom personal header that is added to the default fax header at the top of the fax. Replace header with the header text to add.
Transmission Report Summary

Send transmission report summary:

::tr=summary

Never send a summary:

::tr=none

Use summary to receive only one transmission report when sending a fax to multiple recipients.

Use none to not send a transmission report after fax transmission.


TextAPI Example:

::John, John's Company, Smith, Sales, sales@johnscompany.com, 12345678

::from=Bob Jones,subject=Hi John,H,fh=Test fax

This is the fax message.
Best regards,
Paul

Back to top

Related Article

Evaluating TextAPI Response Files