Fax-API Konten verwalten

Für die Nutzung unserer Fax-API benötigen Sie ein Fax-API-Konto.

Im Menüpunkt Fax-API Konten verwalten wird Ihnen bei der Anmeldung bereits ein Testkonto erstellt. Dieses Testkonto können Siebearbeiten oder Sie legen ein neues Fax-API Konto an.

Neues Fax-API-Konto anlegen

Bezeichnung

Beschreibung

Konto

Beim Fax-API-Kontonamen wählen sie einen beliebigen Namen. Der Name dient Ihnen zur Unterscheidung für den Fall, dass Sie mehrere Fax-API-Konten anlegen und verwalten.

Faxvorlage speichern

Vorlage speichern: ja

Sie können unter Auftragsübersicht die Details Ihrer Faxaufträge einsehen. Dazu gehören auch die Faxvorschau und Ihre Faxvorlage. Wenn keine andere Vereinbarung der Speicherung getroffen wurde, werden diese Dokumente automatisch nach 14 Tagen gelöscht.

Vorlage speichern: nein

Die Faxvorschau und Ihre Faxvorlage werden sofort nach dem abgeschlossenen Faxversand gelöscht und sind nicht einsehbar.

Fax-API-Konto anlegen bzw. verwalten

Mit der Anlage und Speicherung des Fax-API-Kontos werden der Autorisierungs-Schlüssel und die notwendigsten Daten standardmäßig hinterlegt. Sie benötigen zwingend den Autorisierungs-Schlüssel für die Nutzung unserer Fax-API.

Ihr Fax-API-Konto bietet Ihnen noch weitere Eingabemöglichkeiten. Bei der Anlage bzw. Bearbeitung Ihres Fax-API-Kontos finden Sie die Rubriken Basisdaten und Benachrichtigungen.

Basisdaten

Wenn Sie das erste Fax-API-Konto anlegen, sind die nachfolgenden Einstellungen defaultmäßig hinterlegt. Im Zuge der Bearbeitung Ihres Fax-API-Kontos können Sie alle Einstellungen Ihren Bedürfnissen anpassen.

Bezeichnung	Beschreibung
Konto	Beim Fax-API-Kontonamen wählen sie einen beliebigen Namen. Der Name dient Ihnen zur Unterscheidung für den Fall, dass Sie mehrere Fax-API-Konten anlegen und verwalten.
Status	Beim Anlegen Ihres Kontos ist der Status aktiv. Sobald Sie den Status deaktivieren, wird dieser auf inaktiv gesetzt. Über inaktive Konten kann kein Fax mehr versendet werden. Sie können den Status aber jederzeit wieder aktivieren.
Autorisierungs-Schlüssel	Der Autorisierungs-Schlüssel ist für jedes Fax-API-Konto eindeutig. Er wird bei der Konfiguration des Fax-API-Kontos hinterlegt. Bei jedem Faxauftrag über unsere Fax-API wird der Autorisierungs-Schlüssel automatisch übermittelt und dient als Authentifizierung und Zuordnung zu Ihrem Fax-API-Konto.
Kopfzeile	Die Kopfzeile steht am oberen Rand (dem Kopf) von Textseiten und gibt dem Faxempfänger z. B. Auskunft darüber, von wem das Fax gesendet wurde. Möchten Sie eine Kopfzeile haben, wählen Sie Kopfzeile – ja – aus. In dem Moment öffnen sich zwei Eingabefelder. Im Eingabefeld Text 1 (Links) geben Sie die Daten ein, die in der Kopfzeile links stehen sollen. Genauso verfahren Sie mit Text 2 (Mitte). Die in Text 2 eingegebenen Daten stehen dann in der Mitte der Kopfzeile. Der dritte und vierte Bereich der Kopfzeile wird automatisch vom System ausgefüllt. Im dritten Bereich steht die Empfängerfaxnummer und im vierten Bereich erscheint die Seitenzahl. weitere Informationen
Station ID	Die Station ID ist die Absenderkennung, die während der Übertragung angezeigt wird und auch auf dem Empfangsprotokoll erscheint. Die Station ID kann Buchstaben, Ziffern und folgende Sonderzeichen (+:;_- ) enthalten. Die Anzahl der Zeichen ist auf 20 Zeichen begrenzt.
CLIP	Die CLIP (englische Abkürzung für Calling Line Identification Presentation) ist die Rufnummer, die vor der Übertragung des Faxdokuments übermittelt wird. Bitte teilen Sie unserem Support Ihre Absenderfaxnummern (CLIPs) mit. Die gewünschten Absenderfaxnummern stehen Ihnen dann nach Überprüfung als Auswahl zur Verfügung.
Standortvorwahl	Die Standortvorwahl gibt an, welche Ländervorwahl automatisch Faxnummern ohne Ländervorwahl vorangestellt wird. Haben Sie für ein Kundenprofil beispielsweise die Standortvorwahl ‚0043‘ gewählt, wird beim Hochladen der Faxnummer ‚0525187929399‘ automatisch die führende Null durch die Ländervorwahl ‚0043‘ ersetzt.
Kostenstelle	Die frei definierbaren Kostenstellen sind ein rein organisatorischer Bestandteil der Faxsuite. Durch die Angabe von Kostenstellen haben Sie die Möglichkeit die im Rahmen der Faxsendungen entstandenen Kosten direkt den Kostenstellen in Ihrem Unternehmen zuzuordnen.
Faxvorlage speichern	Vorlage speichern: ja Sie können unter Auftragsübersicht die Details Ihrer Faxaufträge einsehen. Dazu gehören auch die Faxvorschau und Ihre Faxvorlage. Wenn keine andere Vereinbarung der Speicherung getroffen wurde, werden diese Dokumente automatisch nach 14 Tagen gelöscht. Vorlage speichern: nein Die Faxvorschau und Ihre Faxvorlage werden sofort nach dem abgeschlossenen Faxversand gelöscht und sind nicht einsehbar.

Benachrichtigungen

Sie können unsere Funktion „Benachrichtigung“ nutzen, um über die Ergebnisse der Ausführung Ihrer Faxaufträge informiert zu werden.

Mit einem Klick auf den Button „+ Neue Benachrichtigung erstellen“, öffnet sich das nachfolgende Eingabefenster.

Eingabefeld	Beschreibung
Typ (Dropdown-Auswahl)	Nach Abschluss Ihres Faxauftrags bekommen Sie eine Benachrichtigung an die hinterlegte E-Mail-Adresse. Es stehen Ihnen für die Benachrichtigung unterschiedliche Typen zur Auswahl (siehe unten).
E-Mail-Adresse	Hier hinterlegen Sie die E-Mail-Adresse, an die die Benachrichtigung versendet werden soll.
Benachrichtigung bei	Bitte beachten Sie, dass Sie nur bei gesetzten Haken eine Benachrichtigung bekommen. Entfernen Sie beide Haken, erhalten Sie keine Benachrichtigung. Bei „Versand erfolgreich“ und „Versand fehlerhaft“ sind bei der Voreinstellung die Haken gesetzt. In diesem Fall bekommen Sie die gewünschte Benachrichtigung nach jeder abgeschlossenen Faxaussendung.

Sie können für ein Fax-API-Konto auch mehrere Benachrichtigungen hinterlegen.

Eingabefeld Typ (Dropdown-Auswahl)
E-Mail (Klartext mit Anhang)	kurze Information über das Versandergebnis Ihres Faxauftrags. Im Anhang finden Sie das versendete Fax als PDF.	Beispiel: Infotext Der Einzelfaxauftrag an 0525187929399 wurde erfolgreich zugestellt. Mit freundlichen Grüßen Ihr Faxverteiler.com – Team + versendetes Fax als PDF-Anhang
E-Mail (Klartext)	kurze Information über das Versandergebnis Ihres Faxauftrags.	Beispiel: Infotext Der Einzelfaxauftrag an 0525187929399 wurde erfolgreich zugestellt. Mit freundlichen Grüßen Ihr Faxverteiler.com – Team
E-Mail (Version 2 mit Anhang)	detaillierte Information über das Versandergebnis Ihres Faxauftrags. Im Anhang finden Sie das versendete Fax als PDF.	Beispiel: Infotext Der Einzelfaxauftrag an 0525187929399 wurde erfolgreich zugestellt. Details: Titel: Seminarfax Faxnummer: 05251682710100 Faxnummer (norm): 00495251682710100 Empfängerkennung: Zustellzeit: 31.05.2022 15:01:01 Konto: Schulungen Kostenstelle: Seminar Seiten: 1 Fehlercode: 0 Versandergebnis: erfolgreich + versendetes Fax als PDF-Anhang
E-Mail (Version 2)	detaillierte Information über das Versandergebnis Ihres Faxauftrags.	Beispiel: Infotext Der Einzelfaxauftrag an 0525187929399 wurde erfolgreich zugestellt. Details: Titel: Seminarfax Faxnummer: 05251682710100 Faxnummer (norm): 00495251682710100 Empfängerkennung: Zustellzeit: 31.05.2022 15:01:01 Konto: Schulungen Kostenstelle: Seminar Seiten: 1 Fehlercode: 0 Versandergebnis: erfolgreich
E-Mail (XML)	detaillierte Information über das Versandergebnis Ihres Faxauftrags als Textdatei (XML)	Beispiel: E-Mail (XML)
URL Aufruf	Der URL-Aufruf dient dazu die Versandergebnisse pro Empfänger automatisiert in Ihr System einzuspielen und weiterzuverarbeiten.	Bei Fragen wenden Sie sich bitte an unseren Support.