Fax

Fax endpoints are used to send new faxes, as well as to retrieve information or delete previously sent faxes.

The Fax object returned by these endpoints can be used to reference request-specific data including the recipient phone number or email address, cover page message, and timestamps for when the fax was sent.

To sign up and send faxes, contact support to upgrade to the Fax API plan: Submit a Ticket

Fax Endpoints

Summary	Endpoint	Description
Get Fax	/fax/{fax_id}	Return the Fax specified by the `fax_id` parameter.
List Faxes	/fax/list	Return a list of Faxes that you can access.
Download Files	/fax/files/{fax_id}	Obtain a copy of the current documents specified by the `fax_id` parameter.
Send Fax	/fax/send	Create and send a new fax with the submitted documents.
Delete Fax	/fax/{fax_id}	Delete the fax specified by the `fax_id` parameter.

Fax Status

Making a request to the Send Fax starts the sending process. Receiving a 200 HTTP response does not guarantee the fax was sent successfully for a number of reasons (i.e. a file conversion error or busy signal). Once the status_code updates, you’ll receive a POST to the callback URL you provided.

Fax Status Codes

List and details of possible Fax status codes that can be returned:

Status	Description
`transmitting`	Transmitting/sending
`success`	Successfully sent
`on_hold`	On hold - account is unconfirmed

Fax Error Codes

List and details of possible Fax errors that can be returned:

Error	Description
`error_busy`	Busy signal
`error_no_answer`	No answer
`error_could_not_fax`	Unable to fax (usually due to a bad connection)
`error_disconnected`	Line disconnected or unreachable
`error_bad_destination`	The line is has been banned (should not happen for US numbers)
`error_unknown`	Unknown error (usually occurs if someone picks up the line or an error occurred during transmission)
`error_file`	Error processing the provided file