XMLAPI-Antwortdateien

Nach Verarbeitung einer XMLAPI erstellt GFI FaxMaker eine Antwortdatei, die zur Überprüfung der Faxübertragung verwendet werden kann. Drittanbieter-Tools lassen sich so konfigurieren, dass sie diesen Ordner abfragen und den Status gesendeter Faxe automatisch abrufen.

Standardmäßig speichert GFI FaxMaker die Antwortdateien im selben Ordner, aus dem die XMLAPI ursprünglich abgerufen wurde. Alternativ kann GFI FaxMaker so konfiguriert werden, dass alle Antwortdateien in einem speziellen Ordner gespeichert werden. Weitere Informationen finden Sie unter Aktivieren von XMLAPI.

Der Name der Antwortdatei entspricht dem Namen der TextAPI, mit der Erweiterung *.status. Die Antwortdatei der XMLAPI fax123.xml würde beispielsweise fax123.xml.status heißen. Wenn eine Antwortdatei mit demselben Namen bereits vorhanden ist, hängt GFI FaxMaker die Antwortnachricht an die Datei an.

HINWEIS

Bei einer SMS-Übertragung wird keine Antwortdatei erstellt.

XMLAPI-Beispielnachricht als Antwort

Die Antwortnachricht enthält die folgenden XML-Container:

Container Beschreibung

<fax>...</fax>

Container für jeden Faxversand. Wenn eine XMLAPI-Datei mehrere Empfänger enthält, wird für jeden Empfänger ein <fax>-Container erstellt, der alle Details für die jeweilige Übertragung enthält.

<errorcode>...</errorcode>

Gibt den Fehlercode für den Faxversand zurück. Bei einem erfolgreichen Faxversand lautet der Fehlercode 0.

<description>...</description>

Enthält den SendeberichtEine E-Mail, die von GFI FaxMaker an interne Benutzer geschickt wird und Informationen über die gesendeten/empfangenen Faxe/SMS enthält. für erfolgreiche bzw. fehlgeschlagene Faxversendungen. Dieser enthält wichtige Parameter für das Fax.

<uid>...</uid>

Wenn in der XMLAPI eine eindeutige ID (uid) angegeben wurde, wird dieser Container produziert.

<faxfile>...</faxfile>

Enthält den vollständigen Pfad zur Faxbilddatei.

<recipient>...</recipient>

Zeigt die Faxnummer an, an die das Fax gesendet wurde.