Fax-Integration API

Fax-Integration API

Die WIRECLOUD Fax-Integration API ermöglicht es Ihnen, Faxe programmatisch zu versenden und zu verwalten. Damit können Sie den Faxversand in Ihre eigenen Anwendungen, CRM-Systeme oder Geschäftsprozesse integrieren.

Voraussetzungen

Für die Nutzung der Fax-API benötigen Sie einen gültigen Auth-Token und Ihre Account-ID aus dem WIRECLOUD Portal. Informationen zur Authentifizierung finden Sie unter Howto: Auth Token.

Faxe auflisten

Um eine Liste der versendeten Faxe abzurufen, verwenden Sie den folgenden API-Endpunkt:

Methode: GET
URL: /api/v1/accounts/{account_id}/faxes/outgoing

Optionale Parameter:
user_id – Filtert nach einem bestimmten Benutzer
created_from – Startdatum (in Gregorianischen Sekunden)
created_to – Enddatum (in Gregorianischen Sekunden)

Fax versenden

Um ein neues Fax über die API zu versenden, nutzen Sie den folgenden Endpunkt:

Methode: PUT
URL: /api/v1/accounts/{account_id}/faxes

Der Request-Body muss das Fax-Dokument als Base64-codierte PDF-Datei sowie die Ziel-Faxnummer enthalten. Stellen Sie sicher, dass die Datei im PDF- oder TIFF-Format vorliegt und keine Sonderzeichen im Dateinamen enthält.

Faxstatus abfragen

Nach dem Versand können Sie den Status eines bestimmten Faxes abrufen:

Methode: GET
URL: /api/v1/accounts/{account_id}/faxes/{fax_id}

Der Faxstatus enthält Informationen über den Zustellungserfolg, Zeitstempel und eventuelle Fehlermeldungen.

Authentifizierung

Alle API-Aufrufe müssen mit einem gültigen Auth-Token im Header authentifiziert werden. Weitere Details zur API-Authentifizierung finden Sie in der Auth-Token Dokumentation.

Weitere Informationen: Besuchen Sie die Fax-Übersicht für grundlegende Informationen zum Fax-Service, die Fax per Upload versenden Anleitung für manuellen Versand oder die REST API Dokumentation für weitere API-Endpunkte.