/outbox

This resource is used to send faxes through the etherFAX network to a destination fax number (or etherFAX endpoint).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Specifies the number to be dialed. This may be a long distance human readable number or E.164 (+18005551234) format.

string

(Optional) Sets the fax id (CSID) for the send request. This is the fax CSID displayed by the remote fax system. This field supports up to 21 characters.

string

(Optional) Sets the caller id for this send request. Where possible, this number will appear as the calling party/id to the remote system. For maximum effectiveness within carrier networks, a "toll" DID is highly recommended.

int32

Specifies the total number of pages in the fax image file.

string

Specifies the time zone offset of the originator. This value is used to maintain the local time of the originator in the fax header (i.e. -5 for Eastern Standard Time).

string

Tag (Optional) Sets a user defined string associated with the fax request. This string will appear in FaxStatus responses making it easier for applications to track their fax messages. This field supports up to 64 characters.

string

Contains the base64 encoded string representing the binary image data (tiff, pdf or other supported document format).

string

Specifies the header format string displayed at the top of each page of this fax job. Keywords and examples are shown below.

string

Specifies the time zone offset of the originator and functions similar to TimeZoneOffset. However, this parameter also supports Linux style time zones such as "America/Chicago", "America/New_York", etc. Using this parameter overrides the TimeZoneOffset value (if specified) and automatically adjusts for daylight savings for the time zone.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json