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 d'être bien connecté à l'API. Pour obtenir des instructions supplémentaires, consultez notre guide ici.
Pour importer un fichier, envoyez une requête HTTP POST à l'URL suivante\u00a0: 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\u00a0:
-
Content-Type:
multipart/form-data
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
Pour le corps de la requête\u00a0:
{
"fax_file": [file]
}
Dans l'exemple suivant, «\u00a0self\u00a0» est utilisé comme ID utilisateur pour représenter l'identifiant unique de l'utilisateur actuellement connecté\u00a0:
Une fois le fichier importé, vous recevez le chemin de son emplacement temporaire sur Fax.Plus.
Une fois les importations terminées, vous pouvez commencer à préparer votre fax pour l'envoi. Pour lancer la procédure, effectuez une requête HTTP POST vers l'URL suivante\u00a0:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Veillez à inclure les en-têtes suivants dans votre requête\u00a0:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
Pour le corps de la requête\u00a0:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Une fois le fax programmé, vous recevez un Outbox ID. Cet identifiant permet de modifier ou de supprimer le fax avant son envoi effectif.
Remarque\u00a0: dans notre API, un fax est associé à plusieurs identifiants. Cette conception s'explique par le fait que la transmission des fax est asynchrone. Concrètement, un fax sortant est identifié par deux ID distincts\u00a0: l'Outbox ID, valable jusqu'à l'envoi réussi du fax, et le Fax ID, qui devient l'identifiant définitif du fax une fois celui-ci transmis avec succès.
Après avoir programmé le fax, vous pouvez suivre son statut en consultant la liste des fax présents dans la boîte d'envoi ou dans la catégorie Envoyés.
Vous pouvez également configurer un serveur HTTP et utiliser un webhook. Un message HTTP vous sera alors transmis lorsque le fax aura été envoyé avec succès ou en cas d'échec de l'envoi.
Procédez comme suit pour configurer le webhook\u00a0:
- Connectez-vous à votre compte Fax.Plus, puis accédez à la section Paramètres de votre tableau de bord.
- Dans l'onglet Integrations, repérez 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 dès qu'un fax sortant aura été traité\u00a0:
{
"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 indique l'heure de transmission, précise si la transmission du fax a réussi (via le champ «\u00a0status\u00a0») et fournit l'ID unique du fax. Cet ID de fax permet de récupérer le fichier du fax ou d'obtenir un rapport de confirmation de fax.