Skip to main content
POST
Send fax
Required scope: FAX_SEND

Behavior

Sends a PDF as a fax from one of your Allo lines. The request is multipart/form-data with three parts: from, to and file.
The response is 201 with the new conversation item: type SMS, message_type FAX, status PENDING, and the PDF in attachments. The fax goes out in the background. page_count is null in this response and is set once the fax has been sent. Fetch the item later with Get conversation item to follow its status.

Requirements

  • Fax is enabled on your account.
  • from is a US or Canada local number you can use, with Send and receive faxes turned on in its number settings in the Allo app. Toll-free numbers and sender IDs cannot send faxes.
  • file is a PDF sent with content type application/pdf, of at most 12 MB.
  • Your team has enough credits. Each faxed page uses message credits.
See Fax overview for how faxes appear in conversations.

Errors

Other errors, such as an invalid to number, are the same as for sending an SMS. See Error codes.

Authorizations

Authorization
string
header
required

Scope needed: FAX_SEND

Body

multipart/form-data
from
string
required

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.

Example:

"+14155550100"

to
string
required

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

Example:

"+14155551234"

file
file
required

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

Response

Fax accepted for sending. Returns the new conversation item.

data
object