Pour envoyer un fax en utilisant l'API, vous devez d'abord télécharger les fichiers souhaités, suivis par la préparation de ces dossiers pour la télécopie et la planification de leur transmission.
Une fois que votre fax est planifié, vous pouvez implémenter un serveur HTTP et utiliser un mécanisme de webhook. Cette approche garantit qu'un message HTTP est envoyé à la fois en cas de réussite de la transmission de fax et en cas de défaillance de la transmission.
Note: Assurez-vous que vous avez terminé le processus d'authentification initial et que vous vous êtes connecté avec succès à l'API. Pour plus d'instructions, reportez-vous à notre guide ici.
Pour télécharger un fichier, lancez une requête HTTP POST à l'URL suivante : https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[format de fichier, 'pdf' ou 'tiff']
Assurez-vous d'inclure les en-têtes suivants dans votre requête :
-
- Type de contenu:
multi-pièces/données de forme
- Type de contenu:
-
- Autorisation :
Porteur [jeton d'accès]
- Autorisation :
-
- x-fax-clientid:
[ID du client]
- x-fax-clientid:
Pour le corps :
{
"fax_file": [file]
}
Dans l'exemple suivant, "self" est utilisé comme identifiant utilisateur pour représenter l'identification unique de l'utilisateur actuellement connecté :
Une fois que le fichier a été téléchargé 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 télécopie pour l'envoi de. Pour lancer le processus, effectuez une requête HTTP POST vers l'URL suivante :
https://restapi.fax. lus/v3/accounts/[user ID]/outbox
Assurez-vous d'inclure les en-têtes suivants dans votre requête :
-
- Autorisation :
Porteur [jeton d'accès]
- x-fax-clientid:
[ID du client]
- Autorisation :
Pour le corps de la requête :
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Une fois le télécopieur programmé avec succès, vous recevrez un identifiant de boîte de réception. Cet identifiant peut être utilisé pour effectuer des modifications ou supprimer le fax avant qu'il ne soit réellement envoyé.
Note: Les fax sont associés à plusieurs IDs avec notre API. Cette conception est en place parce que la transmission de fax fonctionne de manière asynchrone. Plus précisément, un fax sortant sera identifié par deux identifiants distincts : l'ID de la boîte de réception, qui sert son but jusqu'à ce que le fax soit envoyé avec succès, et numéro de fax, qui devient l'identifiant définitif de la télécopie une fois qu'elle a été transmise avec succès.
Après avoir planifié le fax, vous pouvez surveiller son état en examinant la liste des télécopies situées dans la boîte de réception ou la catégorie envoyée.
Alternativement, vous avez la possibilité d'établir un serveur HTTP et d'utiliser un webhook. Cela déclenchera un message HTTP à envoyer lorsque le fax est envoyé avec succès ou s'il y a un échec dans l'envoi.
Suivez ces étapes pour configurer le Webhook:
- Connectez-vous à votre compte Fax.Plus et allez dans la section Profilde votre tableau de bord.
- Sous l'onglet Integrations, trouvez la boîte pour les WebHooks.
- Find Incoming Faxes and Incoming Faxes. Cliquer sur Gérer pour modifier le Webhook.
Une fois que vous aurez configuré le Webhook, vous recevrez la notification suivante une fois qu'un fax sortant aura été traité :
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example. om/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxx",
"cost": 1,
"status": "success"
}
Ce message vous fournira le temps de transmission, indiquez le succès de la transmission de fax (via le champ "statut") et fournissez le numéro de télécopieur unique. Cet ID de fax peut être utilisé pour récupérer le fichier de fax ou obtenir un rapport de confirmation de fax.