Wie kann ich die Faxe eines Teammitglieds über die API herunterladen?

Wer kann diese Funktion nutzen?

Verfügbar für den Enterprise-Tarif.

Alle Mitglieder.

Die Fax.Plus-API bietet eine leistungsstarke Lösung, um nahtlos Informationen und empfangene Faxdateien von Ihren Teammitgliedern zu sammeln, sofern diese eine niedrigere Position in der Hierarchiestruktur des Teams innehaben.

Hinweis: Stellen Sie sicher, dass Sie den ersten Authentifizierungsprozess abgeschlossen und sich erfolgreich bei der API angemeldet haben. Weitere Anweisungen finden Sie in unserer Anleitung hier.

Schritt 1: Die Liste Ihrer Teammitglieder abrufen

Bevor Sie fortfahren, prüfen Sie bitte, ob das gewünschte Teammitglied innerhalb der Teamhierarchie eine untergeordnete Position gegenüber dem API-Nutzer innehat. Wie die folgenden Screenshots zeigen, kann sich das Konto des Test Admin problemlos mit der API verbinden und erhält dadurch Zugriff auf wichtige Informationen und Fax-Dateien des Test Member.

FAX.PLUS-API-Member-Fax-Access-1.png

 

Um die Liste aller Unternehmensmitglieder abzurufen, senden Sie eine HTTP-GET-Anfrage an die folgende URL: https://restapi.fax.plus/v3/accounts/.

 

Stellen Sie sicher, dass Sie die folgenden Header in Ihre Anfrage aufnehmen:

  • Content-Type: 

    multipart/form-data
    
  • Authorization: 

    Bearer [access token]
  • x-fax-clientid: 

    [client ID]


FAX.PLUS-API-Member-Fax-Access-2.png

FAX.PLUS-API-Member-Fax-Access-3.png

 

Sie können die Details des Mitglieds einsehen, darunter die UID (Benutzer-ID), die in den abgerufenen Daten enthalten ist.

Schritt 2: Auf die von Ihrem Teammitglied empfangenen Faxe zugreifen

Sobald Sie die Benutzer-ID des Mitglieds haben, ist der Zugriff auf dessen empfangene Faxe ein unkomplizierter Vorgang. Senden Sie dazu einfach eine HTTP-GET-Anfrage an die folgende URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.

Stellen Sie sicher, dass Sie die folgenden Header in Ihre Anfrage aufnehmen:
 

  • Authorization: 

    Bearer [access token]
  • x-fax-clientid: 

    [client ID]


FAX.PLUS-API-Member-Fax-Access-4.png

 

Die Fax-ID können Sie der Antwort entnehmen.

Hinweis: Erwägen Sie, einen eigenen Webhook für das Ereignis „fax_received“ einzurichten. Dieser liefert Ihnen nicht nur die Fax-ID des Ereignisses, sondern auch weitere Informationen. Weitere Details dazu finden Sie in unserer Anleitung hier.

Schritt 3: Die empfangenen Faxe Ihres Teammitglieds herunterladen

Um die Dateien des Faxes abzurufen, senden Sie eine HTTP-GET-Anfrage an die folgende URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.

 

Stellen Sie sicher, dass Sie die folgenden Header in Ihre Anfrage aufnehmen:

  • Authorization: 

    Bearer [access token]
  • x-fax-clientid: 

    [client ID]


FAX.PLUS-API-Member-Fax-Access-5.png

War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich
Weitere Artikel in diesem Abschnitt