Leistungsbeschreibung Click2Fax 1.0

Transkript

1 Leistungsbeschreibung Click2Fax 1.0 Kontakt bei Fragen: oder 0800-MaTelSo Der Dienst ermöglicht das Versenden von Faxen über einen Web Service von MaTelSo. Charakteristika: Das zu versendende Fax muß als eine PDF Datei übergeben werden Das Normmaß der Dokumente ist DIN A4 Hochformat oder Querformat Enthält die PDF Datei Seiten, die nicht dem Normmaß entsprechen werden diese automatisch auf das Normmaß skaliert Die Antwort des Web Service beschränkt sich in der Version 1.0 auf dessen erfolgreichen Aufruf (Benutzerautentifizierung). Statusmeldung bzgl. des eigentlichen Faxauftrags werden per an den Benutzer oder Administrator geschickt (s.u.) Seite 1/5

2 Aufruf des Dienstes Der Aufruf des Dienstes zum Faxversand erfolgt über eine SOAP Schnittstelle unter: Parameter: PartnerId: PartnerPassword: Account: BillId: RefId: SessionId_Partner: Destination: PDFFile: FaxStationInfo: FaxStationNumber: retrycount: Adress: [string] Ihre Partner-Id [string] Ihr Partner-Kennwort [short] Welches Konto soll verwendet werden: Sie können für jedes Konto in der Initialkonfiguration eigene Basiseinstellungen angeben [string] Zielrufnummer: an welche Nummer soll das Fax geschickt werden [base64binary] PDF Datei, die als Fax verschickt werden soll [string] Name des Absenders* [string] Absender Nummer ggf. f. ein Antwortfax* Akzeptierte Formate: E164: z.b. Deutschland: oder für Frankreich: Userformat: z.b. Deutschland 0711 oder für Frankreich 0033 [int] Anzahl Wahlwiederholungen bei fehlgeschlagener Übertragung. Hinweis: Die Mail wird nach der letzten Wahlwiederholung mit dem letzten Ergebnis verschickt. [string] an welche Adresse sollen die Statusmeldungen des Auftrags geschickt werden: in der Regel der Benutzer oder Administrator * Diese Werte erscheinen beim Empfänger des Faxes in der Kopfzeile des Faxes. Ebenso fügt das System automatisch Datum und Uhrzeit des Versandzeitpunktes hinzu. Seite 2/5

3 Rückmeldungen Beim Aufruf des Web Services werden folgende Meldungen zurück gegeben: Erfolgsmeldung: Originate successfully Fehlermeldungen: 1. IP incorrect: verwendete IP-Adresse stimmt nicht mit hinterlegter IP überein. 2. Login incorrect: Kennwort falsch. 3. Error processing PDF: Fehler bei der Umwandlung/Skalierung. 4. Error queueing Fax: Allgemeiner Übertragungsfehler Statusmeldungen per Auftragsbestätigung Nach Eingang des Fax-Auftrags im eigentlichen Faxsystem wird an die per Web Service übergebene Adresse eine Auftragsbestätigung gesendet. Folgend wird davon ausgegangen, dass der Benutzer die deutsche Standard-Sprachversion nutzt. Die Auftragsbestätigung hat im Erfolgsfall folgende Struktur / Inhalte: Ausprägung Absender click2fax.faxmanagement@matelso.de + Fax-Auftrag Fax-ID: an erfolgreich angenommen. Betreff Bedeutung: +: Auftrag angenommen Fax-ID: Identifikationsnummer des Auftrags : Zielrufnummer Body Enthält Informationen über: Auftragsdaten Absender-Einstellungen Abrechnungsdaten Anhang Kopie des übertragenen PDF Dokumentes Fehlerfall: Dem Betreff ist ein - vorangestellt und es werden entsprechend angepasste Textbausteine verwendet. Seite 3/5

4 Verarbeitung Das PDF Dokument wird in ein Fax-Dokument konvertiert und an den angegebenen Empfänger versandt. Dieser Vorgang kann in Abhängigkeit des Auftrags-Aufkommens bei MaTelSo und der Erreichbarkeit der Zielrufnummer (Wahlwiederholungen) einige Minuten dauern. Sendebericht Nach der Verarbeitung des Click2Fax-Auftrags wird an die per Web Service übergebene Adresse ein Sendebericht gesendet. Folgend wird davon ausgegangen, dass der Benutzer die deutsche Standard-Sprachversion nutzt. Der Sendebericht hat im Erfolgsfall folgende Struktur / Inhalte: Ausprägung Absender click2fax.faxmanagement@matelso.de + Fax-Versand Fax-ID: 1234 erfolgreich an Betreff (Bsp.) Bedeutung: +: Versand erfolgreich Fax-ID: Identifikationsnr. d. Auftrags : Zielrufnummer Body Enthält Informationen mit qualifiziertem Sendebericht über: Auftragsergebnis Versanddaten Absender-Einstellungen Abrechnungsdaten Anhang Kopie des versandten Faxdokuments im PDF-Format Fehlerfall: Dem Betreff ist ein - vorangestellt und es werden entsprechende Textbausteine verwendet, um den Fehler zu kennzeichnen. Der Sendebericht enthält einen Hinweis auf mögliche Fehlerursachen. Eine Kopie des erzeugten Faxdokuments im PDF-Format ist angehängt. Seite 4/5

5 Stammdaten, die pro Partner_ID und Account definiert werden können CallerId: Rufnummer, die beim Empfänger im Telefon- bzw. Faxdisplay angezeigt wird (Standard: anonym) Auswahl der Sprachversion (Standard: Deutsch) individuelle Statusberichte auf Anfrage Kommunikationsverhalten des Click2Fax-Systems: Auftragsbestätigung senden: ja/nein Sendebericht im Erfolgsfall senden: ja/nein Sendebericht im Fehlerfall senden: ja/nein Seite 5/5