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.
Controleer voordat u verdergaat of het beoogde teamlid binnen de hiërarchische structuur van het team een lagere positie heeft dan de API-gebruiker. Zoals in de onderstaande schermafbeeldingen te zien is, kan het account van de Test Admin probleemloos verbinding maken met de API, waardoor toegang wordt verkregen tot essentiële informatie en faxbestanden van het Test Member.
Om de lijst van alle zakelijke leden op te halen, stuurt 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]
U kunt de gegevens van het lid raadplegen, waaronder de UID (User ID), die in de opgehaalde gegevens is opgenomen.
Nadat u de gebruikers-ID van het lid hebt verkregen, is het eenvoudig om toegang te krijgen tot de ontvangen faxen. Stuur hiervoor gewoon 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]
De fax-ID kan uit het antwoord worden opgehaald.
Opmerking: Overweeg het instellen van een speciale webhook voor de gebeurtenis „fax_received”. Deze levert u niet alleen de fax-ID van de gebeurtenis, maar biedt ook aanvullende inzichten. Verdiep u hier verder in door extra informatie te raadplegen. Raadpleeg voor meer informatie onze handleiding hier.
Om de bestanden van de fax op te halen, kunt u een HTTP GET-verzoek sturen 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]