Phone Lines icon GFI Support

Articles in this section

See more

Understanding How TextAPI Works

Author: Shera Matig-a Updated

Overview

TextAPI is a feature in GFI FaxMaker that allows transmission of faxes from text files. These text files must be formatted to a standard convention, using fields and parameters which GFI FaxMaker can use to transmit faxes. Store TextAPIs in a dedicated folder; GFI FaxMaker picks up all TextAPIs stored in this folder and transmits content via fax.

This article details the steps on how TextAPI plays a huge role in the GFI FaxMaker.

 

Process

2019-08-27_18-08-32.png

  1. Generate TextAPI.

    Usually, a 3rd party application is configured to automatically generate TextAPIs. Ensure that the generated file complies to the parameters, fields, and requirements of GFI FaxMaker, as described in this manual. For more information refer to Creating TextAPIs.

  2. Store the API in the TextAPI pickup folder.

    In GFI FaxMaker, configure the folders from where to pick up APIs from. Store generated API in the appropriate folder. For more information refer to Enabling TextAPI.

  3. GFI FaxMaker retrieves API.

    Periodically, GFI FaxMaker polls configured folders for *.txt APIs.

  4. GFI FaxMaker processes and transmits the fax.

    GFI FaxMaker processes the retrieved APIs and transmits the fax according to the fields and parameters specified in the API.

NOTE: Ensure that attachments and body files are fully stored in the appropriate location before storing APIs in the pickup folder. Store any attachments in the TextAPI folder.