Fax-Felder und Parameter
Liste der in XMLAPI unterstützten Felder und Parameter zum Senden von Faxen.
Siehe XMLAPI-Beispielfax.
Nachrichtenfelder
Geben Sie im Container <fields>
folgende Informationen ein:
Betreff | XML-Pfad |
\faxmakerdata\fields\subject |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Geben Sie den Betreff des Faxes an. | |
Beispiel |
<subject>Dies ist ein Faxbetreff</subject> |
|
Zeitplan | XML-Pfad | \faxmakerdata\fields\schedule |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details |
Geben Sie das Datum und die Zeit an, zu der das Fax gesendet werden soll. Machen Sie die Angabe in folgendem Format: JJJJ-MM-TT-HH:mm:ss Ersetzen Sie:
|
|
Beispiel |
<schedule>2018-10-10-08:15:00</schedule> |
|
Priorität | XML-Pfad | \faxmakerdata\fields\priority |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details |
Legen Sie die Priorität für die Nachricht fest. Zulässige Werte sind:
|
|
Beispiel |
<priority>high</priority> |
|
Kostenstelle | XML-Pfad | \faxmakerdata\fields\billingcode |
Typ | Zeichenfolge | |
Disposition | Optional. Nur erforderlich, wenn „Kostenstelle“ aktiviert ist. | |
Details | Legt die Absender-Kostenstelle für die Nachricht fest. | |
Beispiel |
<billingcode>25</billingcode> |
|
Auflösung | XML-Pfad | \faxmakerdata\fields\resolution |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details |
Mit diesem Parameter bestimmen Sie die Auflösung des Faxes. Zulässige Werte sind:
|
|
Beispiel |
<resolution>high</resolution> |
|
DeckblattEine Seite mit Informationen, die an das Fax angehängt und als erste Seite gesendet wird. Diese Seite ist benutzerdefinierbar und kann das Unternehmenslogo und die Unternehmensfarben sowie Absender- und Empfängerinformationen, Faxdetails u.v.m. enthalten. | XML-Pfad | \faxmakerdata\fields\coverpage |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details |
Standardmäßig wird die Fax mit dem in GFI FaxMaker konfigurierten Standard-Deckblatt geschickt. Mit diesem Parameter können Sie ein Fax mit einem bestimmten Deckblatt schicken. Geben Sie das zu verwendende Deckblatt ein. Sie haben dazu folgende Möglichkeiten:
|
|
Beispiel |
<coverpage>Firma</coverpage> |
|
Deckblattadressierung | XML-Pfad | \faxmakerdata\fields\frontcovernote |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details |
Standardmäßig wird die Fax mit der in GFI FaxMaker konfigurierten Standard-Deckblattadressierung geschickt. Mit diesem Parameter können Sie ein Fax mit einer bestimmten Deckblattadressierung schicken. Geben Sie die zu verwendende Deckblattadressierung ein. Sie haben dazu folgende Möglichkeiten:
|
|
Beispiel |
<frontcovernote>Briefkopf</frontcovernote> |
|
FaxleitungEine reale Telefonleitung oder softwarebasierte (FoIP-)Leitung, die an ein Faxgerät (Modem oder ISDN-/Faxkarte) angeschlossen ist. | XML-Pfad | \faxmakerdata\fields\faxline |
Typ | Nummer | |
Disposition | Optional | |
Details |
Verwenden Sie diesen Parameter, wenn das Fax an eine bestimmte Faxleitung geschickt werden soll. Geben Sie die Nummer der Faxleitung an, die in der GFI FaxMaker-Konfiguration festgelegt ist. HINWEIS: Ist diese Leitung allerdings besetzt oder nicht verfügbar, wird das Fax an eine andere Leitung geschickt. Verwenden Sie zum Senden eines Faxes von einer bestimmten Leitung das folgende Attribut:
|
|
Beispiel |
<faxline demandline="true">3</faxline> |
|
Kopfzeile | XML-Pfad | \faxmakerdata\fields\faxheader |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Geben Sie eine personalisierte Kopfzeile an, die oben auf der Faxseite zur Faxkopfzeile hinzugefügt wird. | |
Beispiel |
<faxheader>Dies ist eine Faxkopfzeile</faxheader> |
|
Eindeutige ID | XML-Pfad | \faxmakerdata\fields\uid |
Typ | Zeichenfolge [max. 255 Zeichen] | |
Disposition | Optional | |
Details | Geben Sie eine Kennung an, die zur Markierung der Nachricht verwendet wird. Die Eindeutigkeit dieser Kennung legt die Person fest, die die Nachricht erstellt. Es sind maximal 255 Zeichen möglich. | |
Beispiel |
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid> |
|
Text-API | XML-Pfad | \faxmakerdata\fields\textapi |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Wird zur Angabe einer einzelnen Zeile mit TextAPI-Befehlen verwendet (einschließlich Präfix „::“). Dieses Feld kann mehrfach angegeben werden. | |
Beispiel |
<textapi>::billingcode=25,line=3</textapi> |
|
Nachrichtentext-Datei | XML-Pfad | \faxmakerdata\fields\bodyfile |
Typ | Vollständiger Pfad oder Dateiname | |
Disposition |
Optional HINWEIS: Es muss entweder ein Anhang oder eine Fax-Nachrichtentext-Datei angegeben werden. |
|
Details |
Der Inhalt der Datei wird als Nachrichtentext auf dem Fax-Deckblatt verwendet. Geben Sie die Nachrichtentextdatei im folgenden Format an:
HINWEIS: Achten Sie vor dem Speichern der XMLAPI-Dateien im Sammelordner darauf, dass die Nachrichtentextdatei im richtigen Ordner gespeichert ist. Wenn GFI FaxMaker bei der Abholung nicht auf die Nachrichtentextdatei zugreifen kann, schlägt die Faxübertragung fehl. Verwenden Sie das Attribut type, um den Typ der Nachrichtentextdatei anzugeben. Verwenden Sie eines der folgenden Attribute:
Wenn kein Dateityp-Attribut angegeben wird, wird die Nachricht als einfacher Text eingegeben. |
|
Beispiel |
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile> |
|
Anhang | XML-Pfad | \faxmakerdata\fields\attachment |
Typ | Vollständiger Pfad oder Dateiname | |
Disposition |
Optional (max. 60 Anhänge) HINWEIS: Es muss entweder ein Anhang oder eine Fax-Nachrichtentext-Datei angegeben werden. |
|
Details |
Hängt den Inhalt der angegebenen Datei an das Fax an. Geben Sie die Nachrichtentextdatei im folgenden Format an:
HINWEIS: Achten Sie vor dem Speichern der XMLAPI-Dateien im Sammelordner darauf, dass alle Anhangdateien im richtigen Ordner gespeichert sind. Wenn GFI FaxMaker bei der Abholung nicht auf die Anhänge zugreifen kann, schlägt die Faxübertragung fehl. HINWEIS: Anhänge werden nach der Abholung gelöscht. |
|
Beispiel |
<attachment>c:\temp\document.doc</attachment> |
Absenderfelder
Geben Sie im Container <sender>
die Absenderinformationen folgendermaßen an:
Vorname | XML-Pfad | \faxmakerdata\sender\firstname |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Vornamen des Absenders fest. | |
Beispiel |
<firstname>Heinz</firstname> |
|
Nachname | XML-Pfad | \faxmakerdata\sender\lastname |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Nachnamen des Absenders fest. | |
Beispiel |
<lastname>Müller</lastname> |
|
Unternehmen | XML-Pfad | \faxmakerdata\sender\company |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Firmennamen des Absenders fest. | |
Beispiel |
<company>Firmenname</company> |
|
Abteilung | XML-Pfad | \faxmakerdata\sender\department |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt die Abteilung des Absenders fest. | |
Beispiel |
<department>Vertrieb</department> |
|
Telefonnummer | XML-Pfad | \faxmakerdata\sender\voicenumber |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt die Telefonnummer des Absenders fest. | |
Beispiel |
<voicenumber>+1(800)1234 5678</voicenumber> |
|
E-Mail-Adresse | XML-Pfad | \faxmakerdata\sender\emailaddress |
Typ | Zeichenfolge | |
Disposition | Erforderlich | |
Details | Legt die E-Mail-Adresse des Absenders fest. | |
Beispiel |
<emailaddress>hmüller@meinefirma.com</emailaddress> |
Faxempfänger-Felder
Geben Sie im Container <recipient>
die Empfängerinformationen ein: Fügen Sie für Faxe die Container <fax>
und <recipient>
hinzu.
Beispiel:
<recipients>
<fax>
<recipient>
<faxnumber>+1 800 1234 5678</faxnumber>
</recipient>
</fax>
</recipients>
HINWEIS
Ein Fax kann auch an mehrere Empfänger gesendet werden. Weitere Informationen finden Sie unter Senden eines Fax an mehrere Empfänger.
Fügen Sie im Container <recipient> weitere Parameter und Felder wie folgt ein:
Vorname | XML-Pfad | \faxmakerdata\recipients\fax\recipient\firstname |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Vornamen des Empfängers fest. | |
Beispiel |
<firstname>Thomas</firstname> |
|
Nachname | XML-Pfad | \faxmakerdata\recipients\fax\recipient\lastname |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Nachnamen des Empfängers fest. | |
Beispiel |
<lastname>Bauer</lastname> |
|
Unternehmen | XML-Pfad | \faxmakerdata\recipients\fax\recipient\company |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt den Firmennamen des Empfängers fest. | |
Beispiel |
<company>Faxempfänger-Firma GmbH</company> |
|
Abteilung | XML-Pfad | \faxmakerdata\recipients\fax\recipient\department |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt die Abteilung des Empfängers fest. | |
Beispiel |
<department>Marketing</department> |
|
Faxnummer | XML-Pfad | \faxmakerdata\recipients\fax\recipient\faxnumber |
Typ | Zeichenfolge | |
Disposition | Erforderlich | |
Details | Legt die Faxnummer des Empfängers fest. | |
Beispiel |
<faxnumber>+1(800)8765 4321</faxnumber> |
|
Telefonnummer | XML-Pfad | \faxmakerdata\recipients\fax\recipient\voicenumber |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt die Telefonnummer des Empfängers fest. | |
Beispiel |
<voicenumber>+1(800)8765 4444</voicenumber> |
|
E-Mail-Adresse | XML-Pfad | \faxmakerdata\recipients\fax\recipient\emailaddress |
Typ | Zeichenfolge | |
Disposition | Optional | |
Details | Legt die E-Mail-Adresse des Empfängers fest. | |
Beispiel |
<emailaddress>hmüller@faxempfänger-firma.com</emailaddress> |
Senden eines Fax an mehrere Empfänger
Ein Fax kann auch an mehrere Empfänger gesendet werden. Dazu müssen Sie mehrere <recipient>...</recipient>
-Container erstellen. Beispiel:
<recipients>
<fax>
<recipient>
<firstname>Bernd</firstname>
<faxnumber>+1 800 1111 1111</faxnumber>
</recipient>
<recipient>
<firstname>Heinz</firstname>
<faxnumber>+1 800 2222 2222</faxnumber>
</recipient>
</fax>
</recipients>