REST Client Methods

Faxes

View as Markdown

A Fax is a fax that has been sent to or received by a SignalWire phone number.

Properties

account_sidstringRequired
The unique identifier for the account this fax is associated with.
api_versionstringRequired
The version of the SignalWire API.
date_createdstringRequired
The date and time, in ISO 8601 format, the fax was created.
date_updatedstringRequired
The date and time, in ISO 8601 format, the fax was updated.
directionenumRequired
The direction of the fax.
Allowed values:
fromstringRequired
The phone number, in E.164 format, the fax was sent from.
media_urlstring or nullRequired
The URL hosting the received media, or null if not available.
media_sidstringRequired
The unique identifier for the media instance associated with the fax instance.
num_pagesstring or nullRequired
The number of pages in the fax document, or null if not yet determined.
pricestring or nullRequired
The cost of the fax, or null if not yet calculated.
price_unitstringRequired
The currency, in ISO 4217 format, of the price.
qualityenumRequired
The quality of the fax.
Allowed values:
sidstringRequired
The unique identifier of the fax.
statusenumRequired
The status of the fax.
tostringRequired
The phone number, in E.164 format, the fax was sent to.
durationintegerRequired
The time, in seconds, it took to deliver a fax.
urlstringRequired
The URL of this resource.
error_codestring or nullRequired
Error code for this resource, or null if no error.
error_messagestring or nullRequired
The description of this error, or null if no error.

Example object

The Fax Object
1{
2  "account_sid": "string",
3  "api_version": "string",
4  "date_created": "string",
5  "date_updated": "string",
6  "direction": "inbound",
7  "from": "string",
8  "media_url": "string",
9  "media_sid": "string",
10  "num_pages": "string",
11  "price": "string",
12  "price_unit": "string",
13  "quality": "standard",
14  "sid": "string",
15  "status": "queued",
16  "to": "string",
17  "duration": 0,
18  "links": {
19    "media": "string"
20  },
21  "url": "string",
22  "error_code": "string",
23  "error_message": "string"
24}

Quality

The quality attribute has the following values:

Value
standardA low quality (204x98) fax resolution. This quality should be supported by all devices.
fineA medium quality (204x196) fax resolution.
superfineA high quality (204x392) fax resolution.

Status

The status attribute has the following values:

Value
queuedThe fax is queued and waiting for processing.
processingThe fax is being uploaded, downloaded, or converted to a different format.
sendingThe fax is being sent.
deliveredThe fax has been successfully sent.
receivingThe fax is being received.
receivedThe fax has been successfully received.
no-answerThe fax failed because the recipient didn’t pick up.
busyThe fax failed because the receiving machine sent back a busy signal.
failedThe fax failed to send or receive.
canceledThe fax was canceled.