Passer au contenu principal
POST
Send fax
Scope requis : FAX_SEND

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.
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.
  • from est 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.
  • file est un PDF envoyé avec le type de contenu application/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

Les autres erreurs, comme un numéro to invalide, sont les mêmes que pour l’envoi d’un SMS. Voir Codes d’erreur.

Autorisations

Authorization
string
header
requis

Scope needed: FAX_SEND

Corps

multipart/form-data
from
string
requis

Allo line to send from, in E.164 format. Must be a line you can use with fax turned on. List your lines with GET /v2/api/numbers.

Exemple:

"+14155550100"

to
string
requis

Fax number of the recipient, in E.164 format.

Exemple:

"+14155551234"

file
file
requis

The document to fax: a PDF (application/pdf) of at most 12 MB.

Réponse

Fax accepted for sending. Returns the new conversation item.

data
object