Comportement
Envoie un PDF par fax depuis l'une de vos lignes Allo. La requête est en multipart/form-data avec trois parties : from, to et file.
curl -X POST https://api.withallo.com/v2/api/faxes \
-H "Authorization: Api-Key YOUR_API_KEY" \
-F "from=+14155550100" \
-F "to=+14155551234" \
-F "[email protected];type=application/pdf"
La réponse est 201 avec le nouvel élément de conversation : type SMS, message_type FAX, status PENDING, et le PDF dans attachments. Le fax part en arrière-plan. page_count vaut null dans cette réponse et est renseigné une fois le fax envoyé. Récupérez l'élément plus tard avec Obtenir un élément de conversation pour suivre son status.
Prérequis
- Le fax est activé sur votre compte.
fromest un numéro local des États-Unis ou du Canada que vous pouvez utiliser, avec Envoyer et recevoir des fax activé dans les paramètres du numéro, dans l'application Allo. Les numéros gratuits et les sender IDs ne peuvent pas envoyer de fax.fileest un PDF envoyé avec le type de contenuapplication/pdf, de 12 Mo au maximum.- Votre équipe a assez de crédits. Chaque page envoyée utilise des crédits de messages.
Voir la vue d'ensemble du fax pour savoir comment les fax apparaissent dans les conversations.
Erreurs
| Statut | Code | Quand |
|---|---|---|
400 | MISSING_PARAMETER | from, to ou file est absent |
400 | FAX_NOT_SUPPORTED_ON_NUMBER | La ligne from ne peut pas envoyer de fax |
400 | FAX_NOT_ENABLED_ON_LINE | Envoyer et recevoir des fax est désactivé sur la ligne from |
400 | FAX_FILE_NOT_PDF | file n'est pas envoyé en application/pdf |
400 | FAX_FILE_EMPTY | file est vide |
400 | MAX_UPLOAD_SIZE_EXCEEDED | file dépasse 12 Mo |
402 | INSUFFICIENT_CREDITS | Votre équipe n'a pas assez de crédits pour envoyer le fax |
403 | FAX_NOT_AVAILABLE | Le fax n'est pas activé sur votre compte. Contactez le support Allo. |
404 | FROM_NUMBER_NOT_FOUND | from n'est pas une ligne que vous pouvez utiliser |
Les autres erreurs, comme un numéro to invalide, sont les mêmes que pour l'envoi d'un SMS. Voir Codes d'erreur.