Information
XMLAPI is a feature in GFI FaxMaker that allows transmission of faxes from XML files. These XML files must be formatted to a standard convention, using fields and parameters which GFI FaxMaker can use to transmit faxes. Store XMLAPIs in a dedicated folder; GFI FaxMaker picks up all XMLAPIs stored in this folder and transmits content via fax.
This article walks you through the entire process of how XMLAPI functions in the GFI FaxMaker.
Process
-
Generate XMLAPI.
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 Factors When Creating XMLAPI for GFI FaxMaker. -
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 in GFI FaxMaker Configuration. -
GFI FaxMaker retrieves API.
Periodically, GFI FaxMaker polls configured folders for*.xmlAPIs. -
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.
Important Notes
Attachments and Body Files Should Always Be Accessible
- Store attachments and 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.
Monitoring Fax Transmissions
- After transmitting 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 third-party applications to monitor fax transmission. For more information refer to Evaluating XMLAPI Response Files.