How XMLAPI works

How XMLAPI works

Step Description

Generate XML API

Usually a 3rd party application is configured to automatically generate XML APIs. Ensure that the generated file complies to the parameters, fields and requirements of GFI FaxMaker. For more information refer to Creating XMLAPIs.

Store the API in XMLAPI 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 XMLAPI.

GFI FaxMaker retrieves API

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

GFI FaxMaker processes and transmits fax/SMS

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


Store attachments and/or body file as configured within the XML parameters of the API. Ensure that attachments and body files are fully stored in the specified location before storing the XMLAPIs in the pickup folder. If attachments or body files are not accessible by GFI FaxMaker during pickup, the fax fails.


After transmitting a fax using XMLAPI, GFI FaxMaker generates a response message (*.status file) in the XMLAPI folder which includes details about the fax transmission. This can be used by users, administrators or 3rd party applications to monitor fax transmission. For more information refer to XMLAPI response files.