API du PBX hébergé : historique des fax et envoi

Utilisez HTTPS et l'authentification HTTP Basic avec des identifiants API approuvés. Conservez les identifiants sur votre serveur d'application. Ces points de terminaison Hosted PBX utilisent /hpbx/ sur api.multitel.net ; n'insérez pas /v3. Vérifiez à la fois le résultat HTTP et le statut applicatif dans la réponse JSON.

Lire les enregistrements de fax

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"

Remplacez le code de facturation par celui de votre PBX. Les enregistrements renvoyés indiquent l’heure du fax, son sens, sa source, sa destination, son état de livraison, les tentatives, les erreurs et le nombre de pages. L’acceptation d’une demande d’envoi ne signifie pas nécessairement que le fax a déjà été livré.

Envoi de paramètres

Le point de terminaison d'envoi est POST /hpbx/fax/send/{billing_code}. L’envoi exécute une opération réelle. Préparez le fichier et la destination autorisée par le compte avant de soumettre ; ne réessayez pas aveuglément un envoi incertain.

ChampSignification
numberNuméro de fax de destination.
cidnumIdentifiant d’appelant approuvé pour l’émission.
scheduleHeure d'envoi planifiée, le cas échéant.
faxquality / pagesize / pagerotateOptions prises en charge pour la qualité, le format de papier et la rotation.
statusemailAdresse autorisée pour les notifications de livraison.
deleteaftersendIndique si le fichier importé et conservé doit être supprimé après l’envoi.
filenameLa référence de document attendue par ce flux de travail de télécopie ; il ne s'agit pas d'un chemin de fichier local arbitraire.

Suivi de l'achèvement

Après l'envoi, vérifiez le statut, les tentatives et l'erreur de l'enregistrement de fax. Confirmez la livraison plutôt que d'interpréter l'acceptation comme une livraison. La référence du fax du portail documente son flux actuel de téléversement et d'envoi ; ses chemins et son authentification sont distincts du point de terminaison ci-dessus.

Rechercher dans la documentation