Télécharger un fax de la boîte de réception ou d’envoi

Choisir un document entrant ou sortant

Ce point de terminaison de compatibilité récupère un document fax appartenant à votre compte. Utilisez un compte API MultiTEL activé via HTTPS, avec les identifiants et les restrictions d’adresses IP configurés pour ce compte. Il n’envoie ni ne renvoie de fax.

Ces valeurs doivent figurer dans le chemin. La route est /v3/fax_file/{type}/{id}, et non fax_download avec des segments de chemin supplémentaires. L’empreinte du fax entrant n’est ni l’identifiant numérique de l’enregistrement ni un identifiant de tâche sortante. Copiez l’identifiant depuis la liste de la boîte correspondante ; il ne remplace pas l’authentification.

Télécharger un fax reçu

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

L’empreinte de l’exemple représente l’enregistrement fictif 12 de la boîte de réception. Récupérez votre propre valeur à partir de fax_inbox. Le téléchargement d’un enregistrement entrant existant le marque comme consulté. Cela se produit avant la vérification de la disponibilité du fichier ; une erreur signalant un fichier indisponible peut donc tout de même laisser viewed défini sur true. N’utilisez pas ce point de terminaison uniquement pour vérifier l’existence d’un fax reçu si vous souhaitez conserver son état de consultation inchangé.

Le gestionnaire privilégie un fichier PDF stocké. À défaut, il utilise le fichier TIFF stocké et tente une conversion en PDF lorsque le convertisseur est disponible. Si la conversion est indisponible ou déclenche une exception prise en charge, il renvoie le fichier TIFF à la place. Vérifiez toujours le Content-Type renvoyé au lieu de supposer qu’il s’agit d’un fichier PDF.

Télécharger un fax sortant

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

Utilisez la valeur uuid provenant de fax_outbox. Ce téléchargement de compatibilité privilégie un objet binaire PDF stocké, puis un objet binaire TIFF, puis un fichier PDF, un fichier TIFF ou le fichier source d’origine disponible. Son ordre de préférence diffère de celui du gestionnaire actuel de téléchargement sortant fax_download. Pour les nouvelles intégrations utilisant send_fax, utilisez ce parcours de téléchargement actuel avec son paramètre job_id.

Un fichier source d’origine peut être renvoyé avec le type application/octet-stream plutôt qu’au format PDF ou TIFF. Le nom du fichier joint peut conserver l’extension du fichier source. Le téléchargement sortant de compatibilité ne marque aucun enregistrement de la boîte de réception comme consulté, ne modifie pas l’état d’une tâche et ne crée aucune transmission.

Traiter séparément les octets et les erreurs

En cas de succès, la réponse renvoie les octets bruts du document avec les en-têtes Content-Type, Content-Disposition indiquant une pièce jointe et Content-Length. Il ne s’agit pas d’une enveloppe JSON contenant des données en Base64. Enregistrez les en-têtes et les octets séparément comme indiqué, vérifiez le type de réponse, puis seulement attribuez un nom approprié au fichier ou traitez-le. Une extension source autorisée ne garantit pas que le document soit valide ou converti.

Le code API 400 signifie qu’une valeur obligatoire du chemin est absente ou que type est invalide. Le code API 404 signifie que l’enregistrement rattaché au compte ou son fichier est indisponible. Les erreurs utilisent l’enveloppe JSON status/response habituelle et peuvent être renvoyées avec HTTP 200. Vérifiez le Content-Type de la réponse et la valeur status.code du JSON afin de ne pas ouvrir un corps de réponse d’erreur comme un document.

Confidentialité et disponibilité

Les fax peuvent contenir des informations sensibles. Stockez les fichiers téléchargés uniquement dans des emplacements accessibles à leurs destinataires prévus et évitez d’inclure l’intégralité des octets des documents dans les journaux. La présence d’un enregistrement dans une boîte ne garantit pas que son fichier restera disponible. Aucune durée de conservation des fichiers ni aucune garantie de compatibilité couvrant tous les anciens documents stockés n’a été établie.