Hoe kan ik de faxen van een teamlid downloaden via de API?

Wie kan deze functie gebruiken?

Beschikbaar met het Enterprise-abonnement.

Alle leden.

De Fax.Plus API biedt een krachtige oplossing om moeiteloos informatie en ontvangen faxbestanden van uw teamleden op te halen, mits zij een lagere positie binnen de hiërarchische structuur van het team bekleden.

Opmerking: Zorg ervoor dat u het eerste authenticatieproces hebt voltooid en succesvol bent ingelogd bij de API. Raadpleeg voor aanvullende instructies onze handleiding hier.

Stap 1: Haal de lijst met uw teamleden op

Controleer voordat u verdergaat of het beoogde teamlid een positie heeft die ondergeschikt is aan die van de API-gebruiker binnen de hiërarchische structuur van het team. Zoals in de onderstaande schermafbeeldingen te zien is, kan het account van de Test Admin probleemloos verbinding maken met de API en zo toegang krijgen tot cruciale informatie en faxbestanden van het Test Member.

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

Om de lijst met alle bedrijfsleden op te halen, verstuurt u een HTTP GET-verzoek naar de volgende URL: https://restapi.fax.plus/v3/accounts/.

 

Zorg ervoor dat u de volgende headers in uw verzoek opneemt:

    • 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

U kunt de gegevens van het lid bekijken, waaronder de UID (gebruikers-ID), die in de opgehaalde gegevens is opgenomen.

Stap 2: Open de faxen die uw teamlid heeft ontvangen
Zodra u de gebruikers-ID van het lid hebt, is het openen van de ontvangen faxen van dat lid een eenvoudig proces. Verstuur hiervoor een HTTP GET-verzoek naar de volgende URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.

Zorg ervoor dat u de volgende headers in uw verzoek opneemt:
    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]

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

De fax-ID kunt u uit het antwoord halen.

Opmerking: Overweeg om een speciale webhook in te stellen voor de gebeurtenis „fax_received”, die u niet alleen de fax-ID van de gebeurtenis geeft, maar ook aanvullende inzichten biedt. Verdiep u hierin door aanvullende informatie te raadplegen. Raadpleeg voor meer informatie onze handleiding hier.

Stap 3: Download de ontvangen faxen van uw teamlid

Om de bestanden van de fax op te halen, kunt u een HTTP GET-verzoek versturen naar de volgende URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.

 

Zorg ervoor dat u de volgende headers in uw verzoek opneemt:

    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]


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

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 0 van 0
More Articles in this section