The Fax API sends a PDF as a fax from one of your Allo lines. Sent and received faxes then appear in your conversations, next to calls and SMS.
What you need to send a fax
- Fax on your account. Faxing is not available on every account. Without it, the API returns
403with codeFAX_NOT_AVAILABLE: contact Allo support to get it enabled. - A line that supports fax. The line must be a US or Canada local number. Toll-free numbers and sender IDs cannot send faxes.
- Fax turned on for the line. Turn on Send and receive faxes in the number settings in the Allo app. The API cannot change this setting.
- Message credits. Each faxed page uses credits, the same balance that pays for SMS.
How faxes appear in conversations
A fax is a conversation item of type SMS with message_type FAX. Its ID starts with msg-, like any message.
attachmentsholds the faxed PDF, with adownload_urlvalid for 30 minutes.page_countis the number of pages, ornullwhile it is not known yet.statusof a sent fax starts atPENDINGand changes as the fax goes through.
To list only faxes, call Search conversation items with type: "FAX". With type: "SMS", faxes are included with the other messages.
Send fax
Send a PDF as a fax from an Allo line