Um ein Fax mit der API zu senden, müssen Sie zuerst die benötigten Dateien hochladen gefolgt von der Vorbereitung der Dateien für das Faxen und die Terminplanung ihrer Übertragung.
Sobald Ihr Fax geplant ist, können Sie einen HTTP-Server implementieren und einen Webhook Mechanismus nutzen. Dieser Ansatz stellt sicher, dass eine HTTP-Nachricht sowohl bei erfolgreicher Faxübertragung als auch im Falle eines Übertragungsausfalls versandt wird.
Hinweis: Stellen Sie sicher, dass Sie den ersten Authentifizierungsprozess abgeschlossen haben und sich erfolgreich in der API angemeldet haben. Weitere Anweisungen finden Sie in unserem Leitfaden hier.
Um eine Datei hochzuladen, starten Sie eine HTTP-POST-Anfrage auf die folgende URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[Dateiformat, 'pdf' oder 'tiff']
Stellen Sie sicher, dass die folgenden Header in Ihre Anfrage aufgenommen werden:
-
- Inhalt-Typ:
multipart/form-data
- Inhalt-Typ:
-
- Autorisierung:
Bärer [Zugangs-Token]
- Autorisierung:
-
- x-fax-clientid:
[Client-ID]
- x-fax-clientid:
Für den Körper:
{
"fax_file": [file]
}
Im folgenden Beispiel wird "Selbst" als Benutzer-ID verwendet, um die eindeutige Identifikation des angemeldeten Benutzers zu repräsentieren:
Sobald die Datei erfolgreich hochgeladen wurde, erhalten Sie einen Pfad, der zum temporären Speicherort der Datei auf Fax.Plus führt.
Sobald die Uploads abgeschlossen sind, können Sie mit beginnen, Ihr Fax für das Senden von vorzubereiten. Um den Prozess zu starten, führen Sie eine HTTP-POST-Anfrage an die folgende URL:
https://restapi.fax. lus/v3/Accounts/[user ID]/outbox
Stellen Sie sicher, dass Sie folgende Kopfzeilen in Ihre Anfrage einfügen:
-
- Autorisierung:
Bärer [Zugangs-Token]
- x-fax-clientid:
[Client-ID]
- Autorisierung:
Für den Anfragekörper:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Nach erfolgreicher Terminplanung des Faxes erhalten Sie eine Ausgabe-ID. Diese ID kann verwendet werden, um Änderungen vorzunehmen oder das Fax zu löschen, bevor es tatsächlich gesendet wird.
Hinweis: Faxe sind mit mehreren IDs unserer API verknüpft. Diese Konstruktion ist vorhanden, da Faxübertragung asynchron betrieben wird. Konkret wird ein ausgehendes Fax durch zwei unterschiedliche IDs identifiziert: die ausgehende ID, die ihren Zweck erfüllt, bis das Fax erfolgreich gesendet wurde, und Fax-ID, die zum endgültigen Identifikator für das Fax wird, sobald es erfolgreich übertragen wurde.
Nach der Planung des Faxes Sie können den Status überwachen indem Sie die Liste der Faxe im Outbox oder in der Kategorie sehen.
Alternativ haben Sie die Möglichkeit, einen HTTP-Server einzurichten und einen Webhook zu verwenden. Dies wird eine HTTP-Nachricht auslösen, die gesendet werden soll, wenn das Fax erfolgreich gesendet wird oder wenn ein Fehler beim Senden vorliegt.
Folgen Sie diesen Schritten, um den Webhook einzurichten:
- Melden Sie sich bei Ihrem Fax.Plus Konto an und gehen Sie zum ProfilAbschnitt auf Ihrem Dashboard.
- Unter der Registerkarte für Integrationenfinden Sie die Box für Web Hooks.
- Finden Sie eingehende Faxe und eingehende Faxe. Klicken Sie auf Verwalten um den Webhook zu ändern.
Sobald Sie den Webhook eingerichtet haben, erhalten Sie die folgende Benachrichtigung, sobald ein ausgehendes Fax bearbeitet wurde:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example. om/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxx",
"cost": 1,
"status": "success"
}
}
Diese Nachricht wird Ihnen die Sendezeit zur Verfügung stellen geben Sie den Erfolg der Faxübertragung (über das Feld "Status") an und versorgen Sie mit der einzigartigen Fax-ID. This fax ID can be utilized to retrieve the fax file or obtain a fax confirmation report.