Erstellen von Text-APIs

Erstellen Sie bei Verwendung von TextAPI eine Textdatei (.txt-Format), die wie folgt strukturiert ist:

Zeile Beschreibung
Erste Zeile

Geben Sie die Faxnummer des Empfängers an und stellen Sie ihr zwei Doppelpunkte voran:

::Faxnummer

Beispiel:

::12345678

Andere Parameter können auch in folgendem Format eingefügt werden:

::Vorname, Firma, Nachname, Abteilung, E-Mail-Adresse, Faxnummer

Beispiel: Um ein Fax an Peter Müller zu senden, der im Vertrieb der Firma Meier & Co. arbeitet und unter der E-Mail-Adresse vertrieb@meier.com und der Faxnummer 12345678 zu erreichen ist, sieht diese Zeile wie folgt aus:

::Heinz, Meier & Co., Müller, Vertrieb, vertrieb@meier.com, 12345678

Zweite Zeile (optional)

Geben Sie weitere Sendeoptionen an und stellen Sie auch diesen zwei Doppelpunkte voran. Beispiel:

::S=Preisliste

Trennen Sie einzelne Parameter durch Kommas voneinander. Beispiel:

::c=cover1,23:15,B=5

Weitere Informationen finden Sie unter Text-API-Sendeoptionen.

Weitere Zeilen Geben Sie den Nachrichtentext für das Fax ein.

Text-API-Sendeoptionen

In der zweiten Zeile der TextAPI-Datei können einige Sendeoptionen angegeben werden.

HINWEIS

Es können auch mehrere Optionen angegeben werden. Trennen Sie einzelne Parameter durch Kommas voneinander. Beispiel:

::s=Betreff,from=Peter,c=coverpage1,23:15,B=5

HINWEIS

Bei GFI FaxMaker müssen Sie nicht auf Groß- und Kleinschreibung achten. Parameter können in Groß- oder Kleinbuchstaben angegeben werden.

Sendeoptionen Parameter Beschreibung
Betreff

::S=Dies ist der Betreff

oder

::subject=Dies ist der Betreff

Geben Sie den Betreff des Faxes an. Dieser Text wird in das Feld <subject> des Deckblatts eingefügt. Ersetzen Sie den Text Dies ist der Betreff durch den eigentlichen Betreff.
Absender

::fr=Name

oder

::from=Name

Mit diesem Parameter geben Sie den Namen des Fax-Absenders an. Der angegebene Name wird als Absendername zum 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. hinzugefügt. Ersetzen Sie Name durch den Namen des Absenders.

HINWEIS: Wenn diese Angabe fehlt, hat GFI FaxMaker keine Informationen über den Absender und kann damit auch keinen SendeberichtEine E-Mail, die von GFI FaxMaker an interne Benutzer geschickt wird und Informationen über die gesendeten/empfangenen Faxe/SMS enthält. per E-Mail zurückgeben. Stattdessen wird eine Antwortdatei generiert. Weitere Informationen finden Sie unter TextAPI-Antwortdateien.

Anhang

::A=Dateiname

Geben Sie eine Datei an, die an das Fax angehängt werden soll. Die Datei muss im gleichen TextAPI-Sammelordner gespeichert werden.

Erstetzen Sie Dateiname durch den Namen und die Dateinamenerweiterung der Datei, die Sie anhängen möchten.

Beispiel: ::A=FaxAttachment.tif

Wenn mehrere Dateien angehängt werden sollen, muss der Befehl mehrmals angegeben werden. Beispiel:

::A=file1.tif,A=file2.tif

HINWEIS: Anhänge werden dauerhaft aus dem Sammelordner entfernt. Wenn eine Kopie benötigt wird, müssen Sie eine Sicherung erstellen, bevor der Anhang in den TextAPI-Ordner verschoben wird.

Priorität

Hohe Priorität

::p=high

oder

::p=h

oder

::priority=high

oder

::priority=h

Niedrige Priorität

::p=low

oder

::p=l

oder

::priority=low

oder

::priority=l

Legt die Priorität (hoch oder niedrig) für den Faxversand fest.
Kostenstelle

::B=nnnn

oder

::billingcode=nnnn

Verwenden Sie diesen Parameter zur Angabe einer Kostenstelle, wenn GFI FaxMaker so konfiguriert ist, dass eine Kostenstelle erforderlich ist. Ersetzen Sie nnnn durch die Kostenstelle.
Zeitplan

::YYYY-MM-DD-hh:mm:ss

oder

::hh:mm

Geben Sie das Datum und die Uhrzeit oder nur die Uhrzeit für das Senden des Faxes an.

Ersetzen Sie:

  • JJJJ – Jahr
  • MM – Monat
  • DD – Tag
  • hh – Stunde im 24-Stunden-Uhrzeitformat
  • mm – Minuten
  • ss – Sekunden

Zum Beispiel: ::2018-04-21-16:05:00

Deckblatt

::C=Deckblattname

oder

::Coverpage=Deckblattname

Standardmäßig verwendet GFI FaxMaker das in GFI FaxMaker konfigurierte Standarddeckblatt. Mit diesem Parameter können Sie ein Fax mit einem bestimmten Deckblatt schicken. Ersetzen Sie Deckblattname mit dem Namen des zu verwendenden Deckblatts, wie in GFI FaxMaker konfiguriert.

Wenn Sie kein Deckblatt verwenden möchten, können Sie den Parameter ::C=none verwenden.

Vorderes Deckblatt

::F=Deckblattadressierung

oder

::frontcover=Deckblattadressierung

Mit diesem Parameter können Sie ein Fax mit einer bestimmten Deckblattadressierung schicken. Ersetzen Sie Deckblattnotiz mit dem Namen der zu verwendenden Deckblattnotiz, wie in GFI FaxMaker konfiguriert.

FaxleitungEine reale Telefonleitung oder softwarebasierte (FoIP-)Leitung, die an ein Faxgerät (Modem oder ISDN-/Faxkarte) angeschlossen ist.

::line=n

oder

::l=n

Geben Sie diesen Parameter an, wenn das Fax an eine bestimmte Faxleitung geschickt werden soll. Ersetzen Sie n durch die Nummer der Faxleitung, 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. Wenn das Fax nur über eine bestimmte Leitung gesendet werden soll, verwenden Sie den folgenden Parameter:

::dl=n

Das Fax wird dann erst geschickt, wenn diese Leitung verfügbar ist.

HINWEIS: Der Parameter dl ist auch verfügbar, wenn TextAPI-Befehle in SMS verwendet werden, um eine SMS anzufordern, die über eine bestimmte GSMGlobal System for Mobile Communications-Leitung verschickt werden soll.

Auflösung

Hohe Auflösung

::H

oder

::high

Normale Auflösung

::N

oder

::normal

Mit diesem Parameter bestimmen Sie die Auflösung des Faxes. Verwenden Sie eine hohe (200 * 200 dpi) oder normale (200 * 100 dpi) Auflösung.
Kopfzeile

::fh=Kopfzeile

oder

::faxheader=Kopfzeile

Mit dieser Option können Sie eine personalisierte Kopfzeile angeben, die oben auf der Faxseite zur Standard-Faxkopfzeile hinzugefügt wird. Ersetzen Sie Kopfzeile durch den gewünschten Text für die Kopfzeile.
Zusammenfassender Sendebericht

Zusammenfassenden Sendebericht senden

::tr=summary

Keine Zusammenfassung senden

::tr=none

Verwenden Sie summary, um beim Senden eines Faxes an mehrere Empfänger nur einen Sendebericht zu empfangen.

Verwenden Sie none, um nach der Faxübertragung keinen Sendebericht zu senden.

TextAPI-Beispiel

::Heinz, Meier & Co., Müller, Vertrieb, vertrieb@meier.com, 12345678

::from=Klaus Schmidt,subject=Hallo Heinz,H,fh=Testfax

dies ist ein Testfax.

Mit freundlichen Grüßen

Paul