close

Anmelden

Neues Passwort anfordern?

Anmeldung mit OpenID

API-Handbuch In diesem Handbuch erfahren Sie, wie Sie Faxe - GFI

EinbettenHerunterladen
API-Handbuch
In diesem Handbuch erfahren Sie, wie Sie Faxe programmatisch von
benutzerdefinierten oder anderen Anwendungen über die APISchnittstelle von GFI FaxMaker versenden können.
Die Informationen in diesem Dokument dienen ausschließlich Informationszwecken und werden in
der vorliegenden Form ohne (ausdrückliche oder stillschweigende) Haftung jeglicher Art
bereitgestellt, insbesondere ohne Gewährleistung der Marktgängigkeit, der Eignung für einen
bestimmten Zweck oder der Nichtverletzung von Rechten. GFI Software haftet nicht für etwaige
Schäden, einschließlich Folgeschäden, die sich aus der Nutzung dieses Dokuments ergeben. Die
Informationen stammen aus öffentlich zugänglichen Quellen. Trotz sorgfältiger Prüfung der Inhalte
übernimmt GFI keine Haftung für die Vollständigkeit, Richtigkeit, Aktualität und Eignung der
Daten. Des Weiteren ist GFI nicht für Druckfehler, veraltete Informationen und Fehler
verantwortlich. GFI übernimmt keine Haftung (ausdrücklich oder stillschweigend) für die
Richtigkeit oder Vollständigkeit der in diesem Dokument enthaltenen Informationen.
Nehmen Sie mit uns Kontakt auf, wenn Ihnen in diesem Dokument Sachfehler auffallen. Wir werden
Ihre Hinweise sobald wie möglich berücksichtigen.
Windows, Exchange, IIS, .NET, Internet Explorer, Outlook, SQL Server und Microsoft sind Marken
oder eingetragene Marken der Microsoft Corporation in den Vereinigten Staaten und anderen
Ländern.
Alle hier aufgeführten Produkte und Firmennamen sind Marken der jeweiligen Eigentümer.
GFI FaxMaker unterliegt dem urheberrechtlichen Schutz von GFI SOFTWARE LTD. - 1999-2013GFI
Software Ltd. Alle Rechte vorbehalten.
Dokumentenversion: 1.3.1
Zuletzt aktualisiert (Monat/Tag/Jahr): 10/2/2013
Inhaltsverzeichnis
1 GFI FaxMaker-APIs
4
2 Text-API
5
2.1 Funktionsweise von TextAPI
2.2 Aktivieren von Text-API in GFI FaxMaker
2.3 Erstellen von Text-APIs
3 XMLAPI
3.1 Funktionsweise von XMLAPI
3.2 Aktivieren von XMLAPI in GFI FaxMaker
3.3 Erstellen von XMLAPIs
3.4 Fax-Felder und Parameter
3.5 SMS-Felder und Parameter
4 Webdienst-API
4.1 Anforderungen und wichtige Hinweise
4.2 Erste Schritte
4.3 API-Funktionen
4.4 Klassen
4.5 Enums
4.6 Verwalten der Webdienst-API-Warteschlange
5 Fehlerbehebung und Support
5.1 Einführung
5.2 Knowledge Base
5.3 Webforum
5.4 Technischen Support anfragen
5.5 Dokumentation
5
5
7
11
11
12
13
14
22
26
26
26
27
29
31
32
33
33
33
33
33
34
1 GFI FaxMaker-APIs
Mit APIs können Sie die Software eines Drittherstellers in GFI FaxMaker integrieren.
Diese Ablaufautomatisierung lässt sich in den unterschiedlichsten Branchen und Anwendungen
einsetzen, z. B. im Gesundheitswesen, im Einzelhandel oder im Bankgewerbe.
Sie können zum Beispiel in Ihrer Rechnungsstellungssoftware eine XMLAPI verwenden, um eine XMLBerichtsvorlage für Kontoauszüge und -guthaben zu erstellen. Diesen Bericht können Sie für jeden
Kunden, der Geld schuldet, in regelmäßigen Abständen durchführen und im XMLAPI-Sammelordner
speichern. GFI FaxMakersendet die Auszüge dann automatisch an die vorgesehenen Empfänger.
In GFI FaxMaker verfügbare API-Typen:
XMLAPI
Senden Sie Faxe oder SMS mithilfe von XML-Dateien. Sie können Drittanbietersoftware so konfigurieren,
dass APIs automatisch erstellt und mehrere Faxe gleichzeitig gesendet werden. GFI FaxMaker ruft alle in
einem benutzerdefinierten XMLAPI-Sammelordner gespeicherten XML-Dateien ab und überträgt sie.
XMLAPIs müssen gemäß einer standardmäßigen Konvention formatiert werden, indem Felder und
Parameter verwendet werden, die GFI FaxMaker zur Verarbeitung der Faxe und SMS nutzen kann.
Weitere Informationen finden Sie unter XMLAPI (Seite 11).
Text-API
Senden Sie Faxe mithilfe von einfachen Textdateien. Sie können Drittanbietersoftware so konfigurieren,
dass APIs automatisch erstellt und mehrere Faxe gleichzeitig gesendet werden. GFI FaxMaker ruft alle in
einem benutzerdefinierten TextAPI-Sammelordner gespeicherten Textdateien ab und überträgt sie.
TextAPIs müssen gemäß einer standardmäßigen Konvention formatiert werden, indem Felder und
Parameter verwendet werden, die GFI FaxMaker zur Verarbeitung der Faxe und SMS nutzen kann.
Weitere Informationen finden Sie unter Text-API (Seite 5).
WebdienstAPI
Mit der Webdienst-API von GFI FaxMaker können Sie Ihre eigenen Anwendungen entwickeln, die sich mit
GFI FaxMaker verbinden. Anschließend können Sie Faxe direkt aus Ihrer Anwendung senden und empfangen. Weitere Informationen finden Sie unter Webdienst-API (Seite 26).
2 Text-API
TextAPI ist eine Funktion von GFI FaxMaker, die das Versenden von Faxen aus Textdateien heraus
ermöglicht. Diese Textdateien müssen gemäß einer standardmäßigen Konvention formatiert werden,
indem Felder und Parameter verwendet werden, die GFI FaxMaker zum Versenden von Faxen nutzen
kann. Speichern Sie TextAPIs in einem eigenen Ordner. GFI FaxMakerruft alle in diesem Ordner
gespeicherten TextAPIs ab und sendet ihren Inhalt als Fax.
So konfigurieren Sie TextAPI:
Erstellen Sie einen Ordern, auf den GFI FaxMaker zugreifen kann. In diesem Ordner speichern Sie
Ihre Textdateien für den Faxversand.
Aktivieren Sie die TextAPI-Funktion von GFI FaxMaker. Weitere Informationen finden Sie unter Aktivieren von Text-API in GFI FaxMaker (Seite 5).
Erstellen Sie TextAPIs mithilfe von Feldern und Parametern, die von GFI FaxMaker akzeptiert werden. Weitere Informationen finden Sie unter Erstellen von Text-APIs (Seite 7).
2.1 Funktionsweise von TextAPI
Abbildung 1: Funktionsweise von TextAPI
Schritt
Beschreibung
Generieren einer TextAPI
Normalerweise wird eine Drittanbieteranwendung so konfiguriert, dass sie die TextAPIs automatisch erstellt.
Achten Sie darauf, dass die erstellte Datei die in diesem Handbuch beschriebenen Anforderungen an
Parameter, Felder und sonstige Elemente von GFI FaxMaker erfüllt. Weitere Informationen finden Sie unter
Erstellen von Text-APIs (Seite 7).
API in einem TextAPI-Sammelordner speichern
Konfigurieren Sie in GFI FaxMaker die Ordner, aus denen die APIs entnommen werden sollen. Speichern Sie die
erstellte API im entsprechenden Ordner. Weitere Informationen finden Sie unter Aktivieren von Text-API in
GFI FaxMaker (Seite 5).
GFI FaxMaker ruft die API ab
GFI FaxMaker fragt die konfigurierten Ordner in regelmäßigen Abständen nach TextAPIs ab.
GFI FaxMaker verarbeitet die Dateien und sendet das Fax.
GFI FaxMaker verarbeitet die abgerufenen APIs und sendet das Fax entsprechend der in der API angegebenen
Felder und Parameter.
HINWEIS
Achten Sie vor dem Speichern der APIs im Sammelordner darauf, dass alle Anhänge und
Nachrichtendateien vollständig im richtigen Ordner gespeichert sind. Speichern Sie alle
Anhänge im TextAPI-Ordner.
2.2 Aktivieren von Text-API in GFI FaxMaker
So aktivieren und konfigurieren Sie TextAPI:
1. Klicken Sie in der GFI FaxMaker-Konfiguration mit der rechten Maustaste auf Erweitert >
TextAPI/XMLAPI, und wählen Sie die Option Eigenschaften.
Screenshot 1: Aktivieren von TextAPI
2. Konfigurieren Sie auf der Registerkarte TextAPI die folgenden Optionen:
Tabelle 1: TextAPI-Optionen
Option
Beschreibung
Aktiviert
Aktiviert TextAPI.
Zu scannende
Ordner
Geben Sie die Ordner an, in denen die TextAPIs für die Verarbeitung durch GFI FaxMaker gespeichert
werden sollen. Klicken Sie auf Hinzufügen, um Ordner auszuwählen. Zum Ausführen rekursiver
TextAPI-Scans für Unterordner wählen Sie Unterordner einschließen.
Alle Antwortdateien in
einem Ordner
speichern
Nach einer TextAPI-Verarbeitung erstellt GFI FaxMaker eine Antwortdatei (Erweiterung *.status).
Standardmäßig speichert GFI FaxMaker die Antwortdateien in Sammelordnern. Um alle Antwortdateien in einem Ordner speichern, aktivieren Sie diese Option und geben einen Speicherort an.
Text mithilfe
des Deckblatts
formatieren
Wählen Sie das Deckblatt aus, das für TextAPI-Faxe verwendet werden soll. Weitere Informationen
über Deckblätter finden Sie im GFI FaxMaker zu Administrations- und Konfigurationshandbuch.
3. Klicken Sie auf OK.
Nächster Schritt: Erstellen Sie XMLAPIs. Weitere Informationen finden Sie unter Erstellen von TextAPIs (Seite 7).
2.3 Erstellen von Text-APIs
Erstellen Sie, wenn Sie TextAPI verwenden, eine folgendermaßen strukturierte Textdatei (.txt):
Tabelle 2: Struktur der TextAPI-Datei
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 (Seite 7).
Sonstige
Zeilen
Geben Sie den Nachrichtentext für das Fax ein.
2.3.1 Text-API-Sendeoptionen
In der zweiten Zeile der TextAPI lassen sich verschiedene Sendeoptionen angeben.
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.
Tabelle 3: TextAPI-Parameter
Sendeoptionen
Parameter
Beschreibung
Betreff
::S=Dies ist der Betreff
Geben Sie den Betreff des Faxes an. Dieser Text
wird im Feld <subject> auf dem Deckblatt eingefügt. Ersetzen Sie den Text Dies ist der
Betreff durch den eigentlichen Betreff.
oder
::subject=Dies ist der Betreff
Sendeoptionen
Parameter
Beschreibung
Absender
::fr=Name
Mit diesem Parameter geben Sie den Namen des
Fax-Absenders an. Der angegebene Name wird
als Absendername zum Deckblatt 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
Sendebericht erstellen.
oder
::from=Name
Anhang
::A=Dateiname
Geben Sie eine Datei an, die an das Fax
angehängt werden soll. Die Datei muss im
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=FaxAttachment.tif,A=disclaimer.ti
f
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 TextAPIOrdner verschoben wird.
Priorität
Hohe Priorität
::p=high
Legt die Priorität (hoch oder niedrig) für den Faxversand fest.
oder
::p=h
oder
::priority=high
oder
::priority=h
Niedrige Priorität
::p=low
oder
::p=l
oder
::priority=low
oder
::priority=l
Kostenstelle
::B=nnnn
oder
::billingcode=nnnn
Mit diesem Parameter geben Sie eine Kostenstelle an, wenn GFI FaxMaker so konfiguriert
wurde, dass eine Kostenstelle erfordert wird.
Ersetzen Sie nnnn durch die Kostenstelle.
Sendeoptionen
Parameter
Beschreibung
Zeitplan
::YYYY-MM-DD-hh:mm:ss
Geben Sie das Datum und die Zeit oder nur die
Zeit an, zu der das Fax gesendet werden soll.
Ersetzen Sie:
JJJJ – Jahr
oder
::hh:mm
MM – Monat
TT – Tag
hh – Stunde im 24-Stunden-Uhrzeitformat
mm – Minuten
ss – Sekunden
Beispiel: ::2012-04-21-16:05:00
Deckblatt
::C=Deckblattname
oder
::Coverpage=Deckblattname
Deckblattadressierung
::F=Deckblattadressierung
Faxleitung
::line=n
oder
::frontcover=Deckblattadressierun
g
oder
::l=n
Standardmäßig verwendet GFI FaxMaker das in
GFI FaxMaker konfigurierte Standard-Deckblatt.
Mit diesem Parameter können Sie ein Fax mit
einem bestimmten Deckblatt schicken. Ersetzen
Sie Deckblattname durch den Namen des in
GFI FaxMaker konfigurierten Deckblatts, das Sie
verwenden möchten.
Wenn Sie kein Deckblatt verwenden möchten,
können Sie den Parameter ::C=none
verwenden.
Mit diesem Parameter können Sie ein Fax mit
einer bestimmten Deckblattadressierung
schicken. Ersetzen Sie
Deckblattadressierung durch den Namen
der in GFI FaxMaker konfigurierten
Deckblattadressierung, die Sie verwenden
möchten.
Geben Sie diesen Parameter an, wenn das Fax
an eine bestimmte Faxleitung geschickt werden
soll. Ersetzen Sie n durch die in GFI FaxMaker
konfigurierte Faxleitungsnummer.
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.
Auflösung
Hohe Auflösung
::H
oder
::high
Mit diesem Parameter bestimmen Sie die Auflösung des Faxes. Wählen Sie zwischen hoher
Auflösung (200 x 200 dpi) oder normaler Auflösung (200 x 100 dpi).
Normale Auflösung
::N
oder
::normal
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.
Sendeoptionen
Parameter
Beschreibung
Zusammenfassender
Sendebericht
Zusammenfassenden Sendebericht senden
::tr=summary
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.
Keine Zusammenfassung senden
::tr=none
2.3.2 Text-API-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
3 XMLAPI
XMLAPI ist eine Funktion von GFI FaxMaker, die das Versenden von Faxen aus XML-Dateien heraus
ermöglicht. Diese XML-Dateien müssen gemäß einer standardmäßigen Konvention formatiert werden,
indem Felder und Parameter verwendet werden, die GFI FaxMaker zum Versenden von Faxen nutzen
kann. Speichern Sie XMLAPIs in einem eigenen Ordner. GFI FaxMakerruft alle in diesem Ordner
gespeicherten XMLAPIs ab und sendet ihren Inhalt als Fax.
So konfigurieren Sie XMLAPI:
Erstellen Sie einen Ordern, auf den GFI FaxMaker zugreifen kann. In diesem Ordner speichern Sie
Ihre XML-Dateien für den Faxversand.
Aktivieren Sie die XMLAPI-Funktion von GFI FaxMaker. Weitere Informationen finden Sie unter Aktivieren von XMLAPI in GFI FaxMaker (Seite 12).
Erstellen Sie XMLAPIs mithilfe von Feldern und Parametern, die von GFI FaxMaker akzeptiert werden. Weitere Informationen finden Sie unter Erstellen von XMLAPIs (Seite 13).
3.1 Funktionsweise von XMLAPI
Abbildung 2: Funktionsweise von XMLAPI
Schritt
Beschreibung
Generieren einer XMLAPI
Normalerweise wird eine Drittanbieteranwendung so konfiguriert, dass sie die XMLAPIs automatisch erstellt.
Achten Sie darauf, dass die erstellte Datei die Anforderungen an Parameter, Felder und sonstige Elemente
von GFI FaxMaker erfüllt. Weitere Informationen finden Sie unter Erstellen von XMLAPIs (Seite 13).
API in einem XMLAPI-Sammelordner speichern
Konfigurieren Sie in GFI FaxMaker die Ordner, aus denen die APIs entnommen werden sollen. Speichern Sie die
erstellte API im entsprechenden Ordner. Weitere Informationen finden Sie unter Aktivieren von XMLAPI in
GFI FaxMaker (Seite 12).
GFI FaxMaker ruft API ab
GFI FaxMaker fragt die konfigurierten Ordner in regelmäßigen Abständen nach XMLAPIs ab.
GFI FaxMaker verarbeitet die Dateien und sendet das Fax/die SMS
GFI FaxMaker verarbeitet die abgerufenen APIs und sendet das Fax/die SMS entsprechend der in der API
angegebenen Felder und Parameter.
HINWEIS
Achten Sie vor dem Speichern der APIs im Sammelordner darauf, dass alle Anhänge und
Nachrichtendateien vollständig im richtigen Ordner gespeichert sind. Speichern Sie
Anhänge und/oder Nachrichtendateien im XMLAPI-Ordner oder unter einem bestimmten
Pfad (der in den XML-Parametern der API konfiguriert wurde).
HINWEIS
Nachdem ein Fax mit XMLAPI versendet wurde, erstellt GFI FaxMaker eine
Antwortnachricht (*.status-Datei) im XMLAPI-Ordner mit Angaben zum Faxversand. Diese
kann von Benutzern, Administratoren oder Drittanbieteranwendungen zur Überwachung
des Faxversands verwendet werden. Weitere Informationen finden Sie unter FaxAntwortdateien (Seite 20).
3.2 Aktivieren von XMLAPI in GFI FaxMaker
So aktivieren und konfigurieren Sie XMLAPI:
1. Klicken Sie in der GFI FaxMaker-Konfiguration mit der rechten Maustaste auf Erweitert >
TextAPI/XMLAPI, und wählen Sie die Option Eigenschaften.
Screenshot 2: Aktivieren von XMLAPI
2. Klicken Sie auf der Registerkarte XMLAPI auf Hinzufügen, und wählen Sie die Ordner aus, in denen
die XMLAPIs gespeichert werden sollen. Um auch Unterordner auf XMLAPIs zu überprüfen, aktivieren
Sie Unterordner einschließen.
3. Nach einer XMLAPI-Verarbeitung erstellt GFI FaxMaker eine Antwortdatei (Erweiterung *.status).
Standardmäßig speichert GFI FaxMaker die Antwortdateien in Sammelordnern. Um alle
Antwortdateien in einem Ordner speichern, aktivieren Sie die Option Alle Antwortdateien in einem
Ordner speichern und geben einen Speicherort an. Weitere Informationen finden Sie unter FaxAntwortdateien (Seite 20).
3. Klicken Sie auf OK.
Nächster Schritt: Erstellen Sie XMLAPIs. Weitere Informationen finden Sie unter Erstellen von XMLAPIs
(Seite 13).
3.3 Erstellen von XMLAPIs
Wenn Sie XMLAPI verwenden, erstellen Sie eine XML-Datei (.xml) mit den Parametern zum Senden des
Faxes/der SMS. Alle XMLAPI-Parameter sollten sich in einem XML-Container <faxmakerdata>
befinden. Die Daten sollten dann folgendermaßen in drei separaten Containern enthalten sein:
Tabelle 4: XMLAPI-Feldcontainer
XMLAPI-Container
Beschreibung
<fields>
Geben Sie in diesem Container Eigenschaften für den Faxversand, wie Betreff, Anhänge und Nachrichtendatei, an.
<sender>
Geben Sie in diesem Container die Absenderangaben an.
<recipients>
Geben Sie in diesem Container die Empfängerangaben an.
HINWEIS
Eine XML-Kopfzeile ist ebenfalls erforderlich. Sie lautet normalerweise:
<?xml version="1.0" encoding="utf-8"?>
Weitere Informationen zu XMLAPI-Feldern und Parameter finden Sie unter:
Fax-Felder und Parameter
SMS-Felder und Parameter
3.3.1 Beispiel-XMLAPI
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<subject>Dies ist Ihr Faxbetreff</subject>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
<attachment>c:\temp\document.txt</attachment>
</fields>
<sender>
<emailaddress>user@senderdomain.com</emailaddress>
</sender>
<recipients>
<fax>
<recipient>
<faxnumber>+1 800 6565</faxnumber>
</recipient>
</fax>
</recipients>
</faxmakerdata>
Ausführlichere Beispiel-XMLAPIs enthält dieses Handbuch:
Beispiel einer Fax-XMLAPI
Beispiel einer SMS-XMLAPI
3.4 Fax-Felder und Parameter
Liste der in XMLAPI unterstützten Felder und Parameter zum Senden von Faxen.
Nachrichtenfelder
Absenderinformationen
Faxempfänger-Informationen
Siehe XMLAPI-Beispielfax. Weitere Informationen finden Sie unter Beispiel einer Fax-XMLAPI (Seite 19).
3.4.1 Nachrichtenfelder
Geben Sie im Container <fields> die folgenden Informationen ein:
Tabelle 5: Nachrichtenfelder und Parameter
Betreff
Zeitplan
XMLPfad
\faxmakerdata\fields\subject
Typ
Zeichenfolge
Disposition
Optional
Details
Geben Sie den Betreff des Faxes an.
Beispiel
<subject>Dies ist ein Faxbetreff</subject>
XMLPfad
\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:
JJJJ – Jahr
MM – Monat
TT – Tag
hh – Stunde im 24-Stunden-Uhrzeitformat
mm – Minuten
ss – Sekunden
Beispiel
<schedule>2012-10-10-08:15:00</schedule>
Priorität
XMLPfad
\faxmakerdata\fields\priority
Typ
Zeichenfolge
Disposition
Optional
Details
Legen Sie die Priorität für die Nachricht fest. Zulässige Werte sind:
low
normal
high
veryhigh
Kostenstelle
Auflösung
Beispiel
<priority>high</priority>
XMLPfad
\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>
XMLPfad
\faxmakerdata\fields\resolution
Typ
Zeichenfolge
Disposition
Optional
Details
Mit diesem Parameter bestimmen Sie die Auflösung des Faxes. Zulässige Werte
sind:
Normal (200 x 100 dpi)
High (200 x 200 dpi)
Deckblatt
Beispiel
<resolution>high</resolution>
XMLPfad
\faxmakerdata\fields\coverpage
Typ
Zeichenfolge
Disposition
Optional
Details
Standardmäßig wird die Fax mit dem in GFI FaxMaker konfigurierten StandardDeckblatt 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:
Name des Deckblatts wie konfiguriert in GFI FaxMaker.
Dateiname eines unter <GFI FaxMaker-Installationsordner>\Coverpage gespeicherten Deckblatts. Zum Beispiel generic.htm.
Deckblattadressierung
Beispiel
<coverpage>Firma</coverpage>
XMLPfad
\faxmakerdata\fields\frontcovernote
Typ
Zeichenfolge
Disposition
Optional
Details
Standardmäßig wird die Fax mit der in GFI FaxMaker konfigurierten StandardDeckblattadressierung 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:
Name der Deckblattadressierung wie konfiguriert in GFI FaxMaker.
Dateiname einer unter <GFI FaxMaker-Installationsordner>\Coverpage gespeicherten Deckblattadressierung. Zum Beispiel MyCovernote.htm.
Beispiel
<frontcovernote>Briefkopf</frontcovernote>
Faxleitung
Kopfzeile
Eindeutige ID
Text-API
Nachrichtentext-Datei
XMLPfad
\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 in GFI FaxMaker konfigurierte
Faxleitungsnummer ein.
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 das folgende Attribut:
demandline=”true”.
Beispiel
<faxline demandline="true">3</faxline>
XMLPfad
\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>
XMLPfad
\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>
XMLPfad
\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>
XMLPfad
\faxmakerdata\fields\bodyfile
Typ
Vollständiger Pfad oder Dateiname
Disposition
Optional
Details
Der Inhalt der Datei wird als Nachrichtentext auf dem Fax-Deckblatt
verwendet.
Geben Sie den vollständigen Pfad der Datei ein oder nur den Dateinamen, wenn
die Nachrichtentext-Datei im Deckblatt-Ordner gespeichert ist:
<GFI FaxMaker-Installationsordner>\Coverpage.
HINWEIS: Wenn der vollständige Pfad eingegeben wird, wird die Datei nach der
Verarbeitung gelöscht.
Geben Sie den Dateityp an. Verwenden Sie eines der folgenden Attribute:
type="text/html" – Geben Sie dieses Attribut an, wenn der Nachrichtentext im HTML-Format vorliegt.
type="text/rtf" – Geben Sie dieses Attribut an, wenn der Nachrichtentext im RTF-Format vorliegt.
type="text/plain" – Geben Sie dieses Attribut an, wenn der Nachrichtentext im TXT-Format vorliegt.
Wenn kein Dateityp-Attribut angegeben wird, wird die Nachricht als einfacher
Text eingegeben.
Beispiel
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
Anhang
XMLPfad
\faxmakerdata\fields\attachment
Typ
Vollständiger Pfad oder Dateiname
Disposition
Optional (max. 60 Anhänge)
Details
Hängt den Inhalt der angegebenen Datei an die Faxnachricht an.
Geben Sie den vollständigen Pfad der Datei ein oder nur den Dateinamen, wenn
die Nachrichtentext-Datei im selben Ordner wie die XMLAPI gespeichert ist.
HINWEIS: Achten Sie vor dem Speichern der APIs im Sammelordner darauf, dass
alle Anhänge im richtigen Ordner gespeichert sind.
HINWEIS: Wenn der vollständige Pfad eingegeben wird, wird die Datei nach der
Verarbeitung gelöscht.
Beispiel
<attachment>c:\temp\document.doc</attachment>
HINWEIS
Es muss entweder ein Anhang oder eine Fax-Nachrichtentext-Datei angegeben werden.
3.4.2 Absenderfelder
Geben Sie im Container <sender> die folgenden Absenderinformationen ein:
Tabelle 6: Absenderfelder und Parameter
Vorname
Nachname
Unternehmen
Abteilung
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\sender\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Absenders fest.
Beispiel
<firstname>Heinz</firstname>
XMLPfad
\faxmakerdata\sender\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Absenders fest.
Beispiel
<lastname>Müller</lastname>
XMLPfad
\faxmakerdata\sender\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Absenders fest.
Beispiel
<company>Firmenname</company>
XMLPfad
\faxmakerdata\sender\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Absenders fest.
Beispiel
<department>Vertrieb</department>
XMLPfad
\faxmakerdata\sender\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Absenders fest.
Beispiel
<voicenumber>+1(800)1234 5678</voicenumber>
XMLPfad
\faxmakerdata\sender\emailaddress
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die E-Mail-Adresse des Absenders fest.
Beispiel
<emailaddress>hmüller@meinefirma.com</emailaddress>
3.4.3 Faxempfänger-Felder
Geben Sie im Container <recipient> die Empfängerinformationen ein. Fügen Sie für Faxe einen
<fax>-Container und einen <recipient>-Container 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 (Seite 19).
Geben Sie weitere Parameter in den Feldern im <recipient>-Container wie folgt ein:
Tabelle 7: Faxempfänger-Felder und Parameter
Vorname
Nachname
Unternehmen
Abteilung
Faxnummer
XMLPfad
\faxmakerdata\recipients\fax\recipient\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Empfängers fest.
Beispiel
<firstname>Thomas</firstname>
XMLPfad
\faxmakerdata\recipients\fax\recipient\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Empfängers fest.
Beispiel
<lastname>Bauer</lastname>
XMLPfad
\faxmakerdata\recipients\fax\recipient\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Empfängers fest.
Beispiel
<company>Faxempfänger-Firma GmbH</company>
XMLPfad
\faxmakerdata\recipients\fax\recipient\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Empfängers fest.
Beispiel
<department>Marketing</department>
XMLPfad
\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
E-Mail-Adresse
XMLPfad
\faxmakerdata\recipients\fax\recipient\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Empfängers fest.
Beispiel
<voicenumber>+1(800)8765 4444</voicenumber>
XMLPfad
\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>
3.4.4 Beispiel einer Fax-XMLAPI
HINWEIS
In diesem Beispiel werden zwei andere Dateien verwendet:
Anhang: Ein Anhang mit dem Namen mswordfile.doc, die unter C:\temp\ gespeichert
ist.
Nachrichtendatei: Eine einfache Textdatei mit dem Namen nachricht.txt, die unter
C:\temp\ gespeichert ist.
Diese Dateien werden von C:\temp\ gelöscht, wenn das Fax von GFI FaxMaker abgerufen
wurde.
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<subject>Dies ist der Faxbetreff</subject>
<schedule>2012-10-10-08:15:00</schedule>
<priority>high</priority>
<billingcode>25</billingcode>
<resolution>high</resolution>
<coverpage>Firma</coverpage>
<frontcovernote>Briefkopf</frontcovernote>
<faxline demandline="true">3</faxline>
<faxheader>Dies ist der Text für die Kopfzeile</faxheader>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
<attachment>c:\temp\mswordfile.doc</attachment>
<uid>3a5a90s7de3g20k9y4d5e7e6fse28se5e097</uid>
</fields>
<sender>
<firstname>Heinz</firstname>
<lastname>Müller</lastname>
<company>MeineFirma GmbH</company>
<department>Vertrieb</department>
<faxnumber>1234 5678</faxnumber>
<voicenumber>9876 5432</voicenumber>
<emailaddress>hmüller@meinefirma.com</emailaddress>
</sender>
<recipients>
<fax>
<recipient>
<firstname>Thomas</firstname>
<lastname>Bauer</lastname>
<company>Bauer & Co.</company>
<department>Marketing</department>
<faxnumber>1122 3344</faxnumber>
<voicenumber>5566 7788</voicenumber>
<emailaddress>tbauer@bauer.com</emailaddress>
</recipient>
</fax>
</recipients>
</faxmakerdata>
3.4.5 Fax-Antwortdateien
Nach der Verarbeitung einer XMLAPI erstellt GFI FaxMaker eine Antwortdatei im XMLAPI-Ordner,
anhand der der Faxversand überprüft werden kann. Die Antwortdatei hat die Erweiterung *.status.
Drittanbieter-Tools lassen sich so konfigurieren, dass sie diesen Ordner abfragen und den Status
gesendeter Faxe automatisch abrufen.
HINWEIS
Beim Versenden von SMS wird keine Antwortdatei erstellt.
Screenshot 3: Beispiel für eine XMLAPI-Antwortnachricht
Die Antwortnachricht enthält die folgenden XML-Container:
Tabelle 8: Antwortnachrichten-Container
Container
Beschreibung
<fax>...</fax>
Container für jeden Faxversand. Wenn eine XML API-Datei mehrere Empfänger
enthält, wird für jeden Empfänger ein <fax>-Container erstellt, der alle Angaben für den jeweiligen Versand 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 Sendebericht für erfolgreiche bzw. fehlgeschlagene Faxversendungen. Dieser enthält wichtige Parameter für das Fax.
Container
Beschreibung
<uid>...</uid>
Wenn in der XMLAPI eine eindeutige ID (uid) bestimmt wurde, wird dieser Container erstellt.
<faxfile>...</faxfile>
Enthält den vollständigen Pfad zur Faxbilddatei.
<recipient>...</recipient>
Zeigt die Faxnummer an, an die das Fax gesendet wurde.
3.5 SMS-Felder und Parameter
Liste der in XMLAPI unterstützten Felder und Parameter zum Senden von SMS.
Nachrichtenfelder
Absenderinformationen
SMS-Empfängerinformationen
Siehe XMLAPI-Beispielfax. Weitere Informationen finden Sie unter Beispiel einer SMS-XMLAPI (Seite 25).
3.5.1 Nachrichtenfelder
Geben Sie im Container <fields> die folgenden Informationen ein:
SMS-Nach- XMLPfad
richt
Typ
\faxmakerdata\fields\bodyfile
Vollständiger Pfad oder Dateiname
Disposition
Erforderlich
Details
Der Inhalt der Datei wird als Nachrichtentext verwendet.
Geben Sie den vollständigen Pfad der Datei ein.
Geben Sie den Dateityp ein:
type="text/html" - Nachrichtentext liegt in HTML-Format vor.
type="text/rtf" - Nachrichtentext liegt in RTF-Format vor.
type="text/plain" - Nachrichtentext liegt in TXT-Format vor.
Wenn kein Dateityp-Attribut angegeben wird, wird die Nachricht als einfacher Text
verarbeitet.
SMS-Leitung
Beispiel
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
XMLPfad
\faxmakerdata\fields\gsmline
Typ
Nummer (COM-Port) oder Zeichenfolge (für GSM-Leitung konfigurierter Name)
Disposition
Optional
Details
Fordern Sie eine SMS an, die auf einer bestimmten GSM-Leitung geschickt werden soll.
Geben Sie den Namen oder die COM-Portnummer wie in GFI FaxMaker konfiguriert an.
Verwenden Sie den Parameter demandline, um anzugeben, wie die SMS geschickt werden
soll, wenn die angegebene Leitung besetzt ist oder nicht existiert. Verwenden Sie
demandline=”true”, um die SMS nur über eine bestimmte Leitung zu schicken. Verwenden
Sie demandline=”false”, um die SMS über die als nächstes verfügbare GSM-Leitung zu
schicken, wenn die angegebene Leitung besetzt ist oder nicht existiert.
Beispiel
<gsmline demandline="true">3</gsmline>
oder
<gsmline demandline="false">MyGSMline</gsmline>
3.5.2 Absenderfelder
Geben Sie im Container <sender> die folgenden Absenderinformationen ein:
Tabelle 9: Absenderfelder und Parameter
Vorname
Nachname
Unternehmen
Abteilung
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\sender\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Absenders fest.
Beispiel
<firstname>Heinz</firstname>
XMLPfad
\faxmakerdata\sender\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Absenders fest.
Beispiel
<lastname>Müller</lastname>
XMLPfad
\faxmakerdata\sender\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Absenders fest.
Beispiel
<company>Firmenname</company>
XMLPfad
\faxmakerdata\sender\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Absenders fest.
Beispiel
<department>Vertrieb</department>
XMLPfad
\faxmakerdata\sender\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Absenders fest.
Beispiel
<voicenumber>+1(800)1234 5678</voicenumber>
XMLPfad
\faxmakerdata\sender\emailaddress
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die E-Mail-Adresse des Absenders fest.
Beispiel
<emailaddress>hmüller@meinefirma.com</emailaddress>
3.5.3 SMS-Empfängerfelder
Geben Sie im Container <recipient> die Empfängerinformationen ein. Fügen Sie für SMS einen
<sms>-Container und einen <recipient>-Container hinzu.
Beispiel:
<recipients>
<sms>
<recipient>
<smsnumber>+1 800 1234 5678</smsnumber>
</recipient>
</sms>
</recipients>
HINWEIS
Eine SMS kann auch an mehrere Empfänger gesendet werden. Weitere Informationen
finden Sie unter Senden einer SMS an mehrere Empfänger (Seite 24).
Geben Sie weitere Parameter in den Feldern im <recipient>-Container wie folgt ein:
Tabelle 10: SMS-Empfänger-Felder und Parameter
Vorname
Nachname
Unternehmen
Abteilung
SMS-Nummer
Telefonnummer
E-Mail-Adresse
XMLPfad
\faxmakerdata\recipients\sms\recipient\firstname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Vornamen des Empfängers fest.
Beispiel
<firstname>Thomas</firstname>
XMLPfad
\faxmakerdata\recipients\sms\recipient\lastname
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Nachnamen des Empfängers fest.
Beispiel
<lastname>Bauer</lastname>
XMLPfad
\faxmakerdata\recipients\sms\recipient\company
Typ
Zeichenfolge
Disposition
Optional
Details
Legt den Firmennamen des Empfängers fest.
Beispiel
<company>SMS-Empfänger-Firma GmbH</company>
XMLPfad
\faxmakerdata\recipients\sms\recipient\department
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Abteilung des Empfängers fest.
Beispiel
<department>Marketing</department>
XMLPfad
\faxmakerdata\recipients\sms\recipient\smsnumber
Typ
Zeichenfolge
Disposition
Erforderlich
Details
Legt die SMS-Nummer des Empfängers fest.
Beispiel
<smsnumber>+1(800)8765 4321</smsnumber>
XMLPfad
\faxmakerdata\recipients\sms\recipient\voicenumber
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die Telefonnummer des Empfängers fest.
Beispiel
<voicenumber>+1(800)8765 4444</voicenumber>
XMLPfad
\faxmakerdata\recipients\sms\recipient\emailaddress
Typ
Zeichenfolge
Disposition
Optional
Details
Legt die E-Mail-Adresse des Empfängers fest.
Beispiel
<emailaddress>hmüller@smsempfänger-firma.com</emailaddress>
Senden einer SMS an mehrere Empfänger
Eine SMS kann auch an mehrere Empfänger gesendet werden. Dazu müssen Sie mehrere
<recipient>...</recipient>-Container erstellen. Beispiel:
<recipients>
<sms>
<recipient>
<firstname>Heinz</firstname>
<smsnumber>+1 800 1111 1111</smsnumber>
</recipient>
<recipient>
<firstname>Bernd</firstname>
<smsnumber>+1 800 2222 2222</smsnumber>
</recipient>
</sms>
</recipients>
3.5.4 Beispiel einer SMS-XMLAPI
HINWEIS
In diesem Beispiel wird eine andere Datei verwendet. nachricht.txt, die unter c:\temp\
gespeichert ist und den Text der SMS-Nachricht enthält.
Diese Datei wird von c:\temp\ gelöscht, wenn die SMS von GFI FaxMaker abgerufen
wurde.
<?xml version="1.0" encoding="utf-8"?>
<faxmakerdata>
<fields>
<bodyfile type="text/plain">c:\temp\bodyfile.txt</bodyfile>
</fields>
<sender>
<emailaddress>hmüller@meinefirma.com</emailaddress>
</sender>
<recipients>
<sms>
<recipient>
<smsnumber>+1 800 2222 2222</smsnumber>
</recipient>
</sms>
</recipients>
</faxmakerdata>
4 Webdienst-API
Mit der Webdienst-API von GFI FaxMaker können Sie Ihre eigenen Anwendungen entwickeln, die sich
mit GFI FaxMaker verbinden.
HINWEIS
Dieses Thema gilt für Benutzer, die mit Visual Studio, XML Web Services und SOAPTechnologien vertraut sind.
4.1 Anforderungen und wichtige Hinweise
26
4.2 Erste Schritte
26
4.3 API-Funktionen
27
4.4 Klassen
29
4.5 Enums
31
4.6 Verwalten der Webdienst-API-Warteschlange
32
4.1 Anforderungen und wichtige Hinweise
Verwenden Sie zur Erstellung der API eine Entwicklungsumgebung, die XML Web Services und SOAP
unterstützt.
Greifen Sie mit XML Web Services über den HTTPS-Port 8555 und mithilfe der folgenden URL auf
den GFI FaxMaker-Webdienst zu:
<GFI FaxMaker-Server>:8555/faxmaker/wsapi
Ersetzen Sie http://<GFI FaxMaker-Server> durch den Namen oder die IP-Adresse des GFI
FaxMaker-Servers. Beispiel: http://192.168.1.1:8555/faxmaker/wsapi.
Verwenden Sie alternativ eine sichere Verbindung über den HTTPS-Port 8556. Beispiel: https://192.168.1.1:8556/faxmaker/wsapi. Weisen Sie für eine sichere Verbindung der IPAdresse und dem Port 8556 ein Zertifikat zu. Weitere Informationen finden Sie unter http://go.gfi.com/?pageid=HowToSSL.
Registrieren Sie im Knoten Lizenzierte Benutzer die Benutzer, welche die Webdienst-API verwenden werden. Verwenden Sie die Anmeldeinformationen dieser Benutzer in API-Anrufen.
Empfangene Faxe, die an Benutzer geschickt werden, die für die Webdienst-API registriert sind,
werden in der Webdienst-API-Warteschlange gespeichert und nicht per E-Mail an den Benutzer weitergeleitet. Konfigurieren Sie Routing-Regeln, um Faxe umzuleiten, die von der Webdienst-API an die
registrierten Benutzer übertragen werden sollen.
GFI FaxMaker speichert empfangene Faxe für 30 Tage in der Warteschlange der Webdienst-API.
Abgelaufene Faxe können nicht von der Webdienst-API abgerufen werden. Weitere Informationen finden Sie unter Verwalten der Webdienst-API-Warteschlange (Seite 32).
4.2 Erste Schritte
1. Erstellen Sie in Visual Studio eine C#-Windows- oder Konsolenanwendung.
2. Klicken Sie in Solution Explorer mit der rechten Maustaste auf Verweis, und wählen Sie Webverweis hinzufügen.
3. Fügen Sie die Webdienst-URL (WSDL-Link) ein, und klicken Sie auf Los.
4. Klicken Sie auf Verweis hinzufügen, um die erforderlichen Klassen zu erstellen.
5. Fügen Sie in Ihren Code einen Verweis in den Namespace ein, der von Visual Studio erstellt wurde.
6. Verwenden Sie die folgenden Namespace-Klassen als typische C#-Klassen.
4.3 API-Funktionen
4.3.1 SendFax
Verwenden Sie diese Funktion zum Senden eines Faxes. Diese Funktion gibt ein Array aus FaxJobIDs
zurück. Für jeden Empfänger wird eine FaxJobID erstellt. Diese ID gibt die Möglichkeit, den Status
des gesendeten Faxes an den jeweiligen Empfänger zu überwachen.
FMResult SendFax
(
FMUser user,
UserDetails senderdetails,
List<UserDetails> recipients,
MessageDetails messagedetails,
out FaxJobID[] faxjobids
);
Parameter:
Parameter
Beschreibung
user
Die Anmeldeinformationen des Webdienst-API-Benutzers
senderdetails
Die Details des Benutzers
recipients[]
Die Liste der Faxempfänger
messagedetails
Das zu sendende Fax
Rückgabewerte:
Parameter
Beschreibung
FMResult
Gibt das Ergebnis der Funktion zurück.
Faxjobids
Ein Array aus faxjobid. Für jeden Empfänger gibt es eine Job-ID. Diese Job-ID kann später verwendet
werden, um den Status eines bestimmten Faxes abzurufen.
4.3.2 CheckForUnreadFaxes
Verwenden Sie diese Funktion, um eine Liste der Faxe in der Warteschlange zu erhalten. Diese
Warteschlange enthält all diese Faxe, die zuvor nicht heruntergeladen wurden.
Jedes Element in dieser Liste enthält nur die Details dieses Faxes und nicht das tatsächliche Faxbild.
Verwenden Sie zum Herunterladen des Faxes den Befehl GetNextFax().
FMResult CheckForUnreadFaxes
(
FMUser user,
out ReceivedFaxDetails[] receivedfaxes
);
Parameter:
Parameter
Beschreibung
user
Die Anmeldeinformationen des Webdienst-API-Benutzers
Rückgabewerte:
Parameter
Beschreibung
FMResult
Gibt das Ergebnis der Funktion zurück.
receivedfaxes
Ein Array aus ReceivedFaxDetails
4.3.3 GetNextFax
Verwenden Sie diesen Befehl, um das älteste Fax aus der Warteschlange abzurufen. Diese
Warteschlange enthält all diese Faxe, die zuvor nicht heruntergeladen wurden.
Beim Abrufen des ältesten Faxes wird es nicht automatisch aus der Warteschlange gelöscht.
Verwenden Sie DeleteFax(), um das älteste Fax zu löschen und so das nächste Fax abrufen zu
können. Wenn das älteste Fax nicht gelöscht wird, erhalten Sie das gleiche Fax erneut.
FMResult GetNextFax
(
FMUser user,
out ReceivedFaxDetails faxdetails,
out FileData fax
);
Parameter:
Parameter
Beschreibung
user
Die Anmeldeinformationen des Webdienst-API-Benutzers
Rückgabewerte:
Parameter
Beschreibung
FMResult
Gibt das Ergebnis der Funktion zurück.
faxdetails
ReceivedFaxDetails enthält die Details des Faxes.
fax
Das Faxbild
4.3.4 GetNextFaxByCriteria
Verwenden Sie diesen Befehl, um das älteste Fax gemäß den angegebenen Kriterien aus der
Warteschlange zu löschen. Diese Warteschlange enthält all diese Faxe, die zuvor nicht
heruntergeladen wurden.
Beim Abrufen des ältesten Faxes wird es nicht automatisch aus der Warteschlange gelöscht.
Verwenden Sie DeleteFax(), um das älteste Fax zu löschen und so das nächste Fax abrufen zu
können. Wenn das älteste Fax nicht gelöscht wird, erhalten Sie das gleiche Fax erneut.
FMResult GetNextFaxByCriteria
(
FMUser user,
SearchCriteria criteria,
stringcriteriavalue,
out ReceivedFaxDetails faxdetails,
out FileData fax
);
Parameter:
Parameter
Beschreibung
user
Die Anmeldeinformationen des Webdienst-API-Benutzers
Criteria
DTMF- oder Remote-ID
Criteriavalue
Der Wert des Kriteriums
Rückgabewerte:
Parameter
Beschreibung
FMResult
Gibt das Ergebnis der Funktion zurück.
faxdetails
ReceivedFaxDetails enthält die Details des Faxes.
Fax
FileData enthält die tatsächlichen Faxbilddaten.
4.3.5 DeleteFax
Verwenden Sie diese Funktion, um ein bestimmtes Fax zu löschen.
FMResult DeleteFax
(
FMUser user,
int FaxID
);
Parameter:
Parameter
Beschreibung
user
Die Anmeldeinformationen des Webdienst-API-Benutzers
FaxID
Die ID des zu löschenden Faxes. Dieser Wert kann aus der Ausgabe von CheckForUnreadFaxes(),
GetNextFax() und GetNextFaxByCriteria() abgerufen werden.
Rückgabewerte:
Parameter
Beschreibung
FMResult
Gibt das Ergebnis der Funktion zurück.
4.4 Klassen
4.4.1 UserDetails
Diese Klasse enthält die Details eines Empfängers/Absenders.
Alle Felder sind optional. Eine Ausnahme bildet die Eigenschaft Faxnumber, wenn sie als Empfänger
verwendet wird.
Datenelemente
Typ
Beschreibung
Firstname
Zeichenfolge
Der Vorname
Lastname
Zeichenfolge
Der Nachname
Company
Zeichenfolge
Der Unternehmensname
Department
Zeichenfolge
Der Abteilungsname
Faxnumber
Zeichenfolge
Die Faxnummer
Email
Zeichenfolge
Die E-Mail-Adresse
4.4.2 MessageDetails
Ein Objekt dieser Klasse enthält die Details für ein neues Fax.
Alle Felder sind optional mit Ausnahme von BillingCode, wenn die Kostenstelle aktiviert ist.
Datenelemente
Typ
Beschreibung
Subject
Zeichenfolge
Der Faxbetreff
Schedule
DateTime
Das Datum und die Uhrzeit, an dem/zu der das Fax gesendet werden soll.
Priority
FaxPriority
Legt die Faxpriorität fest.
BillingCode
Zeichenfolge
Gibt die Kostenstelle an. Nur erforderlich, wenn Kostenstelle aktiviert ist.
Resolution
FaxResolution
Die zu verwendende Auflösung.
Coverpage
Zeichenfolge
Standardmäßig wird ein Fax mit dem in GFI FaxMaker konfigurierten StandardDeckblatt geschickt. Mit diesem Parameter können Sie ein Fax mit einem
bestimmten Deckblatt schicken.
FrontCoverNote
Zeichenfolge
Standardmäßig wird das Fax mit der in GFI FaxMaker konfigurierten StandardDeckblattadressierung geschickt. Mit diesem Parameter können Sie ein Fax mit
einer bestimmten Deckblattadressierung schicken.
FaxLine
Ganzzahl
Verwenden Sie diesen Parameter, wenn das Fax an eine bestimmte Faxleitung
geschickt werden soll. Geben Sie die Faxleitungsnummer an, die in der GFI
FaxMaker-Konfiguration festgelegt ist.
Demandline
Bool‘sch
Bei der Angabe einer bestimmten Faxleitung (Attribut FaxLine) wird das Fax an
eine andere Leitung geschickt, wenn die Leitung besetzt ist. Wenn das Fax nur
über eine bestimmte Leitung gesendet werden soll, setzen Sie den Attributwert auf true.
header
Zeichenfolge
Geben Sie eine personalisierte Kopfzeile an, die oben auf der Faxseite zur Faxkopfzeile hinzugefügt wird.
UniqueID
Zeichenfolge
Gibt eine Kennung an, die zur Markierung der Nachricht verwendet wird. Die Eindeutigkeit dieser Kennung legt die Person fest, die die Nachricht erstellt.
TextAPI
Zeichenfolge
Gibt eine einzelne Zeile des TextAPI-Befehls an.
Eine Liste der TextAPI-Befehle finden Sie unter TextAPI-Befehle.
MessageBodyFile.
FileData
Eine Instanz von FileData, die eine Textdatei enthält, die wiederum den Nachrichtentext des Faxes enthält.
Attachments
List<FileData>
Array aus Anhängen
4.4.3 FMUser
Ein Webdienst-API-Benutzer
Datenelemente
Typ
Beschreibung
Email
Zeichenfolge
Die E-Mail-Adresse, wie sie im GFI FaxMaker-Konfigurationsknoten „Lizenzierte
Benutzer“ konfiguriert ist. Der Benutzer muss ein registrierter Webdienst-APIBenutzer sein.
Password
Zeichenfolge
In Active Directory ist dies das konfigurierte Benutzerkennwort.
In SMTP-Umgebungen ist das Kennwort eine automatisch erstellte GUID aus dem GFI
FaxMaker-Konfigurationsknoten „Lizenzierte Benutzer“ für registrierte WebdienstAPI-Benutzer.
4.4.4 FaxJobID
GFI FaxMaker weist jedem Empfänger eines ausgehenden Faxes eine einzigartige Kennung zu.
Verwenden Sie diese Kennung, um den Status eines Faxes zu überwachen.
Datenelemente
Typ
Beschreibung
Recipient
Zeichenfolge
Die Faxnummer des Empfängers
ID
Zeichenfolge
Die von GFI FaxMaker zugewiesene, einzigartige Kennung
4.4.5 ReceivedFaxDetails
Ein Objekt dieser Klasse wird empfangen, wenn GetNextFax() aufgerufen wird.
Datenelemente
Typ
Beschreibung
FaxUID
Zeichenfolge
Die eindeutige Faxkennung. Verwenden Sie diese Kennung, um ein Fax zu löschen.
WhenReceived
DateTime
Das Datum und die Uhrzeit, an dem/zu der das Fax empfangen wurde.
NosPages
Zeichenfolge
Die Anzahl der empfangen Seiten
Resolution
FaxResolution
Die Auflösung des empfangenen Faxes
RemoteID
Zeichenfolge
Der Name des Faxgerätes des Empfängers
DTMF_DID
Zeichenfolge
Die DTMF/DID-Durchwahlnummer der empfangenden Leitung
4.4.6 FileData
Ein Objekt dieser Klasse enthält die tatsächlichen Daten einer Datei.
Datenelemente
Typ
Beschreibung
Filename
Zeichenfolge
Die Name der Datei; oftmals zur Bestimmung des Dateiformats verwendet.
Data
Byte[]
Die Dateidaten in einem Bytearray
4.5 Enums
4.5.1 FaxPriority
Wert
Beschreibung
None
Keine Priorität festgelegt.
Low
Niedrige Priorität
Normal
Normale Priorität
High
Hohe Priorität
VeryHigh
Sehr hohe Priorität
4.5.2 FaxResolution
Wert
Beschreibung
NonSet
Keine Auflösung für benutzerdefiniertes Fax festgelegt.
High
Hohe Auflösung
Normal
Normale Auflösung
4.5.3 SearchCriteria
Wert
Beschreibung
RemoteID
Suchen Sie Faxe nach Anrufer-ID oder Name des Faxgerätes.
DTMF
Suchen Sie Faxe nach der Durchwahlnummer der empfangenden Leitung.
4.5.4 FMResult
Wert
Beschreibung
Success
Funktion erfolgreich abgeschlossen.
Failure
Funktion fehlgeschlagen.
UserNotValid
Die Benutzerdetails sind ungültig.
DBError
Fehler beim Schreiben in oder Lesen aus der Datenbank
FaxImageNotFound
Das erforderliche Faxbild wurde nicht gefunden.
NoSender
Kein oder ungültiger Absender angegeben.
NoRecipients
Kein oder ungültiger Empfänger angegeben.
InvalidFaxDescription
Ein oder mehrere Pflichtfelder wurden nicht ausgefüllt.
4.6 Verwalten der Webdienst-API-Warteschlange
Wenn ein Fax an einen registrierten Webdienst-API-Benutzer weitergeleitet wird, speichert GFI
FaxMaker das Fax in der Webdienst-API-Warteschlange.
Verwenden Sie die verschiedenen Funktionen, die unter Webdienst-API beschrieben sind, um die Faxe
aus der Warteschlange abzurufen. Beim Empfang eines Faxes wird es nicht automatisch aus der
Warteschlange gelöscht. Verwenden Sie DeleteFax(), um das Fax zu löschen.
4.6.1 Abgelaufene Faxe in der Warteschlange
Empfangene Faxe werden für 30 Tage in der Webdienst-API-Warteschlange gespeichert. Wenn diese
30 Tage abgelaufen sind, werden diese Faxe automatisch aus der Warteschlange entfernt und können
nicht mehr von der Webdienst-API abgerufen werden.
Abgelaufene Faxe werden standardmäßig in den folgenden Ordner verschoben:
<GFI FaxMaker-Installationsverzeichnis>/WSAPI/Retention/
Für jedes in diesen Ordner verschobenes Fax speichert GFI FaxMaker das Faxbild im .fax-Format (mit
Bildanzeige zu öffnen) und eine XML-Datei mit den Faxmetadaten.
So ändern Sie den Standardordner:
1. Beenden Sie alle GFI FaxMaker-Dienste.
2. Navigieren Sie zum Installationsordner von GFI FaxMaker.
3. Öffnen Sie die Datei ML.Svc.Attendant.exe.config in einem Texteditor.
4. Suchen Sie RetentionFolder, und ändern sie dessen Wert in den neuen Pfad.
5. Starten Sie die Dienste, die in Schritt 1 beendet wurden.
HINWEIS
Gehen Sie mit Bedacht vor, wenn Sie die Installationsdateien der Software ändern. Eine
fehlerhafte Konfiguration kann Funktionsprobleme verursachen.
5 Fehlerbehebung und Support
5.1 Einführung
In diesem Abschnitt wird erklärt, wie bei der Installation von GFI FaxMaker auftretende Probleme
behoben werden können. Die wichtigsten verfügbaren Informationsquellen zum Beheben dieser
Probleme lauten wie folgt:
Dieses Handbuch – die meisten Probleme können Sie mithilfe der Informationen in diesem Hilfesystem lösen.
Artikel aus der GFI Knowledge Base
Webforum
Technischer Support von GFI
5.2 Knowledge Base
GFI pflegt ein umfangreiches Knowledge Base-Repository, in dem Lösungen für die häufigsten
Probleme bei der Installation beschrieben sind. Wenn die Informationen in diesem Handbuch nicht
ausreichen, um Ihre Installationsprobleme zu lösen, schlagen Sie bitte in der Knowledge Base nach.
Die Knowledge Base enthält immer die aktuelle Liste der Fragen, die an den technischen Support
gerichtet wurden, sowie die neuesten Patches. Zur Knowledge Base gelangen Sie über folgende URLAdresse: http://kb.gfi.com/.
5.3 Webforum
Über das GFI-Webforum erhalten Sie technischen Support von Benutzer zu Benutzer. Zum Webforum
gelangen Sie über folgende URL-Adresse: http://forums.gfi.com/.
5.4 Technischen Support anfragen
Wenn Sie mit keiner der oben angegebenen Ressourcen Ihre Probleme beheben können, wenden Sie
sich bitte an das technische Supportteam von GFI. Füllen Sie dazu ein Online-Support-Formular aus,
oder rufen Sie an.
Online: Füllen Sie das Anfrageformular für den Support aus, und befolgen Sie genau die Anweisungen auf dieser Seite, um Ihre Support-Anfrage unter folgendem Link zu übermitteln: http://support.gfi.com/supportrequestform.asp.
Telefon: Die korrekte Telefonnummer für den technischen Support Ihrer Region finden Sie unter:
http://www.gfi.com/company/contact.htm.
HINWEIS
Halten Sie bitte Ihre Kundennummer bereit, wenn Sie sich an den technischen Support
wenden. Ihre Kundennummer entspricht der Online-Kontonummer, die Sie bei der ersten
Registrierung Ihrer Lizenzschlüssel im GFI-Kundenbereich unter folgendem Link erhalten
haben: http://customers.gfi.com.
Für die Beantwortung Ihrer Anfrage benötigt GFI in Abhängigkeit von Ihrer Zeitzone maximal
24 Stunden.
5.5 Dokumentation
Wenn dieses Handbuch Ihren Erwartungen nicht entspricht oder Sie der Meinung sind, dass die
Dokumentation verbessert werden kann, senden Sie uns bitte eine E-Mail an: documentation@gfi.com.
USA, KANADA UND ZENTRAL- SOWIE SÜDAMERIKA
15300 Weston Parkway, Suite 104 Cary, NC 27513, USA
Telefon: +1 (888) 243-4329
Fax: +1 (919) 379-3402
ussales@gfi.com
GROSSBRITANNIEN UND IRLAND
Magna House, 18-32 London Road, Staines-upon-Thames, Middlesex, TW18 4BP, UK
Telefon: +44 (0) 870 770 5370
Fax: +44 (0) 870 770 5377
sales@gfi.co.uk
EUROPA, MITTLERER OSTEN UND AFRIKA
GFI House, San Andrea Street, San Gwann, SGN 1612, Malta
Telefon: +356 2205 2000
Fax: +356 2138 2419
sales@gfi.com
AUSTRALIEN UND NEUSEELAND
83 King William Road, Unley 5061, South Australia
Telefon: +61 8 8273 3000
Fax: +61 8 8273 3099
sales@gfiap.com
Document
Kategorie
Internet
Seitenansichten
6
Dateigröße
1 235 KB
Tags
1/--Seiten
melden