Wichtige Grundsätze für die Nutzung der -Schnittstellen

Transkript

1 Einleitung Diese Dokumentation soll Ihnen bei der Nutzung unseres Produktes zur Seite stehen. Leider können wir hiermit sicherlich nicht alle Fragen und Fallstricke aus der Welt schaffen, daher scheuen Sie sich nicht uns bei Fragen jeglicher Art einfach zu kontaktieren: Der in fullsms.de integrierte Faxversand bietet Ihnen die Möglichkeit über verschiedene Wege Faxe zu versenden. In diesem Dokument sind alle verfügbaren Schnittstellen dokumentiert. Wir bieten jedoch die Möglichkeit in Ausnahmefällen Ihnen eine individuelle, projektbezogene Schnittstelle zur Verfügung zu stellen, falls dies erforderlich sein sollte. Kontaktieren Sie uns einfach: Desweiteren ist auch der Versand direkt aus dem Webportal möglich. Inhalt Wichtige Grundsätze für die Nutzung der -Schnittstellen Konfigurations-Möglichkeiten und Versand aus dem Webportal -Schnittstelle Betreffzeile -Schnittstelle Body -Schnittstelle Domain Antwort- s vom Gateway Rückgabewerte Wichtige Grundsätze für die Nutzung der -Schnittstellen Generell wird der Text im Body der und bis zu 3 PDF-Anhänge gefaxt. Die PDF-Dateien im Anhang dürfen zusammen nicht größer als 2,5 MB sein. Sollte Body und Anhang vorhanden sein, wird zuerst der Text in der und als Folgeseiten das PDF-Dokument gefaxt. Das Gateway unterstützt keine HTML- s, nutzen Sie nur Text-only/plain-text s. Die Empfängerrufnummer kann in folgenden Formaten angegeben werden: Bindestriche (-),Querstriche (/) und runde Klammern sollten wenn möglich nicht in der Rufnummer angegeben werden. In der Regel werden diese jedoch vom Gateway ignoriert. fullsms.de Faxversand Stand: Seite 1/5

2 Konfigurations-Möglichkeiten und Versand aus dem Webportal Wenn Sie sich im Webportal von fullsms.de angemeldet haben, stehen Ihnen unter dem Menüpunkt Fax senden folgende Unterpunkte zur Verfügung: Einstellungen Fax für Statusberichte: Absendername: Absendernummer: An diese adresse werden die Statusberichte gesendet, wenn Sie einen Faxauftrag über unser Webportal erstellen. Standardmäßig ist hier die adresse hinterlegt, die Sie bei der Anmeldung angegeben haben. Die Absenderkennung, die standardmäßig im Fax-Header angezeigt werden soll (kann man je Faxauftrag auch manuell setzen). Die Absendernummer, die standardmäßig im Fax-Header angezeigt werden soll (kann man je Faxauftrag auch manuell setzen). Einzelversand Fax Hier haben Sie die Möglichkeit ganz schnell ein Fax über unser Webportal zu versenden. Wählen Sie einfach den Empfänger aus dem Adressbuch oder tragen diesen manuell ein und laden ein PDF-Dokument hoch. Die Felder Absendername und Absendernummer werden vorbelegt, wenn Sie diese unter dem Menüpunkt Einstellungen Fax hinterlegt haben. Sie erhalten über die Webseite nur eine Bestätigung, dass der Auftrag angenommen wurde. Zusätzlich erhalten Sie diese Bestätigung auch noch per . Den späteren Statusbericht bekommen Sie ebenfalls als an die adresse gesendet, die Sie unter Einstellungen Fax definiert haben. Massenversand Fax Diese Option steht Ihnen derzeit noch nicht zur Verfügung! -Schnittstelle Betreffzeile Diese Schnittstelle ist sehr einfach für Einsteiger zu verwenden. Senden Sie einfach eine an mit folgender Betreffzeile: Also z.b.: Username;Passwort;Empfängerrufnummer benutzer;123pw456; Der komplette -Text im Body der und eventuelle Anhänge werden an die Empfängerrufnummer gefaxt. Sie haben die Möglichkeit im Kundenlogin für diese Schnittstelle eine Standard-Absenderrufnummer und Standard-Kopfzeile zu speichern, die dann immer verwendet wird. Sollten Sie hier selber keine Einstellung vorgenommen haben, wird standardmäßig die Absenderkennung und die Kopfzeile Faxgateway verwendet. fullsms.de Faxversand Stand: Seite 2/5

3 Wichtig sind hier die Semikolons (;), die die einzelnen Teile Username, Passwort und Empfängerrufnummer trennen. Diese müssen auf jedenfall verwendet werden und es dürfen keine Leerzeichen zwischen den Teilen existieren. -Schnittstelle Body Die Schnittstelle bietet Ihnen die Möglichkeit bei jeder einzelnen alle Variablen, wie z.b. Absenderkennung oder Kopfzeile individuell anzugeben. Desweiteren haben Sie die Möglichkeit jeweils eine Fax-ID zu definieren. Die Fax-ID darf nummerisch oder alphanumerisch sein und wird in jeder Antwort- vom Gateway mitgesendet und dient dazu, die Antwort- s z.b. automatisch auswerten zu lassen oder besser zuordnen zu können. Senden Sie einfach eine an mit folgendem Inhalt im -Body. Die Betreffzeile wird bei dieser Schnittstelle nicht berücksichtigt: <request> <auth> <account>username</account> <password>passwort</password> </auth> <fax> <fax-id>ihre_id</fax-id> <to>empfängernummer</to> <from>absenderkennung</from> <header>header</header> </fax> </request> Text unterhalb von </request> wird per Fax verschickt. Ebenso eventuelle Anhänge. Die Zeile <to> </to> können Sie beliebig oft untereinander verwenden, wenn Sie ein Massenfax versenden möchten. Pro Zeile geben Sie dann eine Rufnummer innerhalb von <to> und </to> an. Die roten Teile müssen durch Sie ersetzt werden: account: Hier Ihren Usernamen, bzw. Ihre Kundennummer einsetzen (z.b ) password: Hier das Passwort des jeweiligen Users eintragen. fax-id: Sie haben die Möglichkeit eine ID zu defnieren für das Fax. Die Fax-ID wird Ihnen in jeder Antwort- des Gateways als Referenz angegeben. Sie haben so die Möglichkeit die Antwort- s automatisch verarbeiten zu lassen. to: Die Empfängerrufnummer. from: Die Absenderkennung / Absenderrufnummer header: Die Kopfzeile, in der Regel z.b. Ihr Name -Schnittstelle Domain Über diese -Schnittstelle kann der Faxversand auch in größere Umgebung mit vielen Mitarbeitern einfach eingebunden werden. fullsms.de Faxversand Stand: Seite 3/5

4 Bei uns wird einmalig die Absenderdomain, sowie der sendende Mailserver bei uns hinterlegt. Danach steht allen Benutzern, die eine entsprechende adresse besitzen die Möglichkeit offen eine an zu senden. Die Zielrufnummer wird einfach in die Betreffzeile geschrieben. Mehr ist nicht notwendig. Gefaxt wird auch hier der Inhalt des Bodys, sowie eventuelle PDF- Anhänge. Der Fax-Header sowie die Absenderkennung können von uns als Standard-Werte ebenfalls hinterlegt werden. Die Schnittstelle steht Ihnen derzeit nur als direkter XaraNet-Kunde zur Verfügung. Leider können wir dies für unsere fullsms.de-user nicht anbieten! Kontaktieren Sie uns bei Interesse einfach: Antwort- s vom Gateway Für jeden Auftrag erhalten Sie insgesammt 2 s vom Gateway zurück. Die erste schicken wir direkt nachdem wir die von Ihnen erhalten haben. Somit haben Sie eine Bestätigung, dass die zeitnah bei uns eingegangen ist. Sollten Sie diese Rückmeldung nicht zeitnah erhalten, lässt dies auf eine Störung eines Mailservers auf Ihrer oder unserer Seite schließen oder ein Verarbeitunsgproblem ist aufgetreten. Bitte beachten Sie, dass wir auch für den -Server des Faxgateways Anti-Spam-Techniken wie Greylisting anwenden. Es kann daher bei der ersten , die Sie an uns senden zu einer Verzögerung der Zustellung und damit auch zu einer Verzögerung der ersten Bestätigungs- kommen. Sollte Ihre ordnungsgemäß von unserem Faxgateway entgegen genommen worden sein, erhalten Sie folgende Bestätigungs- , dass die Nachricht in die Warteschlange gestellt wurde: Hallo, Ihr Auftrag mit der ID»123456«wurde erfolgreich gestartet. Details zum Auftrag: Fax-Auftrag mit der ID»123456«:» Status: In Warteschlange» Gesamtkosten: 0,1600» Empfänger: 1» Seiten je Empfänger: 1 Viele Grüße Ihr Faxgateway Die ID wird nur bei der -Schnittstelle Body übermittelt. Wenn keine ID definiert wurde, wird standardmäßig 1 als Fax-ID übermittelt. Sollte es zu einem Fehler gekommen sein oder als Bestätigung, dass das Fax erfolgreich versendet wurde, erhalten Sie eine mit folgendem Layout: Hallo, Für Ihren Auftrag mit der ID»123456«liegt der Statusbericht vor. fullsms.de Faxversand Stand: Seite 4/5

5 » Empfänger: » Status: SEND-SUCCESS» CODE: 200» Versandzeitpunkt: :07:00 Viele Grüße Ihr Faxgateway Sie erhalten immer den Status in Textform angegeben und den zugehörigen CODE. Die möglichen Rückgabewerte sind in dieser Dokumentation unter dem Punkt Rückgabewerte definiert. Rückgabewerte Die folgenden Werte können zurückgegeben werden: 100 In Warteschlange 200 SEND-SUCCESS 301 User existiert nicht oder Passwort falsch 302 Kein ausreichendes Kreditlimit 303 Benutzer derzeit gesperrt 304 Absender- -Adresse nicht gestattet für Faxversand 401 Syntaxfehler 402 Fehlerhafte Datei im Anhang 403 HTML- , bitte text-only senden 404 Mehr als 3 Dateien im Anhang 405 Datei(en) im Anhang zu groß (Gesamt: max. 2,5MB) 406 Leere Seite, keine Seite zum Faxen vorhanden 407 Empfänger-Nr. ist auf Sperrliste 408 Absenderrufnummer hat ungueltiges Format 501 Leitung besetzt (BUSY) 502 Verbindung wurde getrennt 510 Uebertragungsfehler 511 Uebertragungsfehler (Gegenstelle ist kein FAX-G3-Geraet) 512 Uebertragungsfehler (manueller Abbruch durch Gegenstelle) 513 Uebertragungsfehler (Leistungsmerkmal nicht implementiert) 514 Uebertragungsfehler (fehlerhafte Rufnummer) 530 Rufnummer ist nicht vergeben 531 Keine Verbindung zur Gegenstelle 532 Teilnehmer antwortet nicht / Ruf abgewiesen 533 Rufnummer hat sich geändert 534 Gegenstelle defekt 535 Rufnummer hat ungueltiges Format 590 temporaere Stoerung 591 globale Stoerung 999 Allgemeiner Verarbeitungsfehler (bitte Support kontaktieren) fullsms.de Faxversand Stand: Seite 5/5