eFax

Send a fax

Send an outbound fax to one or more recipients with up to 20 documents, optionally with a system cover page. The post-transport combined decoded-document limit is 100 MiB (104857600 bytes). Hosted requests are also limited to 1 MiB (1048576 bytes) of total JSON before decoding, so base64 documents and JSON overhead must fit within that envelope and the effective document capacity may be lower. Mirrors POST /v1/faxes. The server uploads documents to the eFax API as multipart/form-data. To add a c

Get fax status

Return a single fax — its composed lifecycle status and metadata — by fax_id. Works for sent and received faxes. Document content is retrieved separately via get-fax-content. Mirrors GET /v1/faxes/{fax_id}.

List faxes

List inbound and outbound faxes with optional filtering and zero-based page-index pagination. The page value selects a page (0 is the first page), not an item offset. Mirrors GET /v1/faxes.

Get fax content

Download the document content for a fax by fax_id. The eFax API streams the document in its stored format (inbound as PDF, outbound as TIFF); there is no format selection and no transcoding. Mirrors GET /v1/faxes/{fax_id}/content.

List cover pages

List the system cover page templates available for an outbound fax, including each template's required and optional fields. To compose send-fax arguments, choose a template, copy its name exactly to cover_page.cover_page_name, and create cover_page.fields as a string map containing every exact key in required_fields; keys from optional_fields may also be supplied. Preserve field spelling and casing. Ask the user for required values that were not provided instead of inventing them. Example transf