Send a fax

post

https://api.emaktalk.com/api/v1/fax/send

Transmits a fax from one of your fax servers and creates its entry in your fax list; the response carries that new entry, so you do not need to refetch it. Supply the document through files or final_file, and include coversheet to have a coversheet generated and placed in front of it. Authorization is checked against fax_server_id itself — a fax server you do not have access to is rejected with 403. Sending is billable and cannot be undone once the fax is queued.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

fax_server_id

string

required

Id of the fax server to send from. Your access is checked against this value.

to_number

string

required

Destination fax number. It is converted to E.164 further down the send path.

to_name

string | null

required

Display name for the recipient; may be null.

quality

string

ultra_dark (the default) or ultra_light for superfine.

subject

string

Subject line recorded for the fax.

coversheet

object

{ subject?: string, message?: string }. When present, a coversheet is generated and prepended to the document.

language

string

One of en-us, fr-ca, en-uk or fr-fr. Defaults to your account's language setting, then English.

timezone

string

IANA timezone used for timestamps on the coversheet. Defaults to your account's setting, then America/Toronto.

files

array of strings

Storage keys of the uploaded documents to merge into the outgoing fax.

files

already_previewed

boolean

true to transmit an already-rendered document instead of processing it again.

original_media_url

string

Location of the already-rendered source document, used with already_previewed.

final_file

string

Key of the finished merged document to transmit.

is_verified

boolean

Caller-ID verification result. When present it replaces the live verification lookup and is trusted as sent.

sender_uuid

string

User the fax is recorded as being sent on behalf of, in place of the key's own user.

callback_webhook_url

string

URL to receive delivery-status callbacks. Rejected with 400 if it matches the platform's own callback URL.

preview_only

string

Render the preview document and return its URL without transmitting anything.

Responses

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The fax was queued and its entry created; the new entry is returned.

400The fax server is unknown or incomplete, the callback URL is invalid, there is nothing to send, the coversheet or merge failed, the fax was rejected, or the entry could not be written.

403The request is not authenticated, or you are not authorized for fax_server_id.

500Fax sending is not configured, moving the document to permanent storage failed, or the send failed unexpectedly.