Hoe kan ik een fax versturen via de API?

Bijgewerkt 29 september 2026 20:11

Wie kan deze functie gebruiken?

Beschikbaar met het Enterprise-abonnement.

Alle leden.

Om een fax via de API te versturen, moet u eerst de benodigde bestanden uploaden. Daarna maakt u deze bestanden klaar voor het faxen en plant u de verzending ervan.

Zodra uw fax is gepland, kunt u een HTTP-server implementeren en gebruikmaken van een webhook-mechanisme. Op deze manier wordt een HTTP-bericht verzonden, zowel bij een geslaagde verzending van de fax als bij een mislukte verzending.

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

Stap 1: Bestanden uploaden die u wilt faxen

Om een bestand te uploaden, start u een HTTP POST-verzoek naar de volgende URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']

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]
```

Voor de inhoud van het verzoek:

{
  "fax_file": [file]
}

‍

In het volgende voorbeeld wordt „self” gebruikt als gebruikers-ID om de unieke identificatie van de momenteel ingelogde gebruiker weer te geven:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

Zodra het bestand met succes is geüpload, ontvangt u een pad naar de tijdelijke locatie van het bestand op Fax.Plus.

Stap 2: Een fax versturen via de API

Zodra de uploads zijn voltooid, kunt u beginnen met het voorbereiden van uw fax voor verzending. Om het proces te starten, voert u een HTTP POST-verzoek uit naar de volgende URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

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

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

Voor de inhoud van het verzoek:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

Nadat de fax succesvol is ingepland, ontvangt u een Outbox-ID. Met dit ID kunt u wijzigingen aanbrengen in de fax of de fax verwijderen voordat deze daadwerkelijk wordt verzonden.

Opmerking: Faxen zijn in onze API aan meerdere ID's gekoppeld. Dit ontwerp is er omdat het verzenden van een fax asynchroon verloopt. Een uitgaande fax wordt namelijk aan de hand van twee verschillende ID's geïdentificeerd: het Outbox-ID, dat geldt totdat de fax succesvol is verzonden, en het Fax-ID, dat de definitieve identificatie van de fax wordt zodra deze succesvol is verzonden.

Stap 3: Webhooks gebruiken om de status van uw verzonden fax te controleren

Na het inplannen van de fax kunt u de status volgen door de lijst met faxen in het Postvak UIT of de categorie Verzonden te bekijken.

U kunt ook een HTTP-server opzetten en een webhook gebruiken. Daarmee wordt een HTTP-bericht verzonden wanneer de fax succesvol is verzonden of wanneer het verzenden mislukt.

Volg deze stappen om de webhook in te stellen:

Log in op uw Fax.Plus-account en ga naar de sectie Instellingen op uw dashboard.
Zoek onder het tabblad Integraties het vak voor webhooks.
Zoek Inkomende faxen en Inkomende faxen. Klik op Beheren om de webhook te wijzigen.

Nadat u de webhook hebt ingesteld, ontvangt u de volgende melding zodra een uitgaande fax is verwerkt:

{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}

Dit bericht geeft u de verzendtijd, geeft aan of de faxverzending is geslaagd (via het veld „status”) en levert u het unieke Fax-ID. Dit Fax-ID kan worden gebruikt om het faxbestand op te halen of een faxbevestigingsrapport op te vragen.

Need Support?