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 anfänglichen Authentifizierungsprozess abgeschlossen und sich erfolgreich bei der API angemeldet haben. Weitere Anweisungen finden Sie in unserer Anleitung hier.

Schritt 1: Rufen Sie die Liste Ihrer Teammitglieder ab

Bevor Sie fortfahren, stellen Sie bitte sicher, dass das gewünschte Teammitglied innerhalb der Hierarchiestruktur des Teams eine niedrigere Position als der API-Benutzer innehat. Wie in den folgenden Screenshots dargestellt, kann sich das Konto des Test-Admins nahtlos mit der API verbinden und erhält dadurch Zugriff auf wichtige Informationen und Faxdateien des Testmitglieds.

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 auf die Daten des Mitglieds zugreifen, einschließlich der UID (Benutzer-ID), die in den abgerufenen Daten enthalten ist.

Schritt 2: Greifen Sie auf die von Ihrem Teammitglied empfangenen Faxe zu
Nachdem Sie die Benutzer-ID des Mitglieds erhalten haben, wird der Zugriff auf dessen empfangene Faxe zu einem unkomplizierten Prozess. 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 kann aus der Antwort entnommen werden.

Hinweis: Sie sollten in Erwägung ziehen, einen dedizierten Webhook für das Ereignis „fax_received“ einzurichten, der Ihnen nicht nur die Fax-ID des Ereignisses liefert, sondern auch weitere Einblicke bietet. Weitere Informationen finden Sie in unserer Anleitung hier.

Schritt 3: Laden Sie die von Ihrem Teammitglied empfangenen Faxe herunter

Um die Dateien aus dem Fax abzurufen, können Sie eine HTTP-GET-Anfrage an die folgende URL senden:
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
More Articles in this section