Overview
After processing an XMLAPI, GFI FaxMaker creates a response file which provides the final status of the fax transmission. Third-party tools can be configured to poll this folder and automatically retrieve the status of transmitted faxes.
By default, GFI FaxMaker stores response files in the same folder where the XMLAPI was originally picked up. Alternatively, GFI FaxMaker can be configured to store all response files in a particular folder.
This article guides you on how to assess XMLAPI response files to ensure successful transmission.
Solution
The name of the response file should match the name of the XMLAPI with a *.status extension.
For example, the response file of XMLAPI fax123.xml, is named fax123.xml.status. If a response file with the same name already exists, GFI FaxMaker appends the response message to the file.
Sample XMLAPI response message:
The response message contains the following XML Containers along with their descriptions:
| Container | Description |
|---|---|
|
|
A container for each fax transmission. If one XML API file contains multiple recipients, a <fax> container is created for each recipient, containing all details for that particular transmission. |
|
|
Returns the error code for fax transmission. A successful transmission returns a 0 error code. |
|
|
Contains transmission report for successful or failed transmissions. This includes important parameters for the fax. |
|
|
If a unique ID (UID) Unique Identifier was specified in the XMLAPI it means that this container is produced. |
|
|
Contains a full path to the image file of the fax. |
|
|
Displays the fax number to which the fax has been sent. |