Pour envoyer un fax en utilisant l'API, vous devez d'abord téléverser les fichiers requis, puis préparer ces fichiers pour l'envoi par fax et planifier leur transmission.
Une fois votre fax planifié, vous pouvez mettre en place un serveur HTTP et exploiter un mécanisme de webhook. Cette approche garantit qu'un message HTTP est envoyé aussi bien en cas de transmission réussie du fax qu'en cas d'échec de la transmission.
Remarque : assurez-vous d'avoir terminé le processus d'authentification initial et de vous être connecté avec succès à l'API. Pour obtenir des instructions supplémentaires, consultez notre guide ici.
Pour téléverser un fichier, lancez une requête HTTP POST vers l'URL suivante : https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
Veillez à inclure les en-têtes suivants dans votre requête :
-
- Content-Type :
multipart/form-data
- Content-Type :
-
- Authorization :
Bearer [access token]
- Authorization :
-
- x-fax-clientid :
[client ID]
- x-fax-clientid :
Pour le corps de la requête :
{
"fax_file": [file]
}
Dans l'exemple suivant, « self » est utilisé comme identifiant utilisateur (user ID) pour représenter l'identification unique de l'utilisateur actuellement connecté :
Une fois le fichier téléversé avec succès, vous recevrez un chemin menant à l'emplacement temporaire du fichier sur Fax.Plus.
Une fois les téléversements terminés, vous pouvez commencer à préparer votre fax pour l'envoi. Pour lancer le processus, effectuez une requête HTTP POST vers l'URL suivante :
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Veillez à inclure les en-têtes suivants dans votre requête :
-
- Authorization :
Bearer [access token]
- x-fax-clientid :
[client ID]
- Authorization :
Pour le corps de la requête :
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Une fois le fax planifié avec succès, un identifiant Outbox (Outbox ID) vous sera fourni. Cet identifiant peut être utilisé pour modifier ou supprimer le fax avant qu'il ne soit réellement envoyé.
Remarque : plusieurs identifiants sont associés à un fax dans notre API. Cette conception existe car la transmission des fax fonctionne de manière asynchrone. Plus précisément, un fax sortant sera identifié par deux identifiants distincts : l'Outbox ID, qui sert jusqu'à ce que le fax soit envoyé avec succès, et le Fax ID, qui devient l'identifiant définitif du fax une fois qu'il a été transmis avec succès.
Après avoir planifié le fax, vous pouvez suivre son statut en consultant la liste des fax dans l'outbox ou dans la catégorie des fax envoyés.
Vous avez également la possibilité de mettre en place un serveur HTTP et d'utiliser un webhook. Cela déclenchera l'envoi d'un message HTTP lorsque le fax est envoyé avec succès ou en cas d'échec de l'envoi.
Suivez ces étapes pour configurer le webhook :
- Connectez-vous à votre compte Fax.Plus, puis rendez-vous dans la section Paramètres de votre tableau de bord.
- Sous l'onglet Integrations, recherchez le bloc WebHooks.
- Repérez Incoming Faxes et Incoming Faxes. Cliquez sur Manage pour modifier le webhook.
Une fois le webhook configuré, vous recevrez la notification suivante lorsqu'un fax sortant aura été traité :
{
"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"
}
}
Ce message vous fournira l'heure de transmission, indiquera le succès de la transmission du fax (via le champ « status ») et vous communiquera l'identifiant unique du fax. Cet identifiant de fax peut être utilisé pour récupérer le fichier du fax ou obtenir un rapport de confirmation de fax.