Faxes

Send a Fax

Send a fax.

Permissions

The API token must include the following scopes: Fax.

post/Accounts/{AccountSid}/Faxes

Path parameters

AccountSidstring uuid required

The Project ID that uniquely identifies the Account.

Request body

MediaUrlstring required

The URL hosting the received media.

Tostring required

The phone number, in E.164 format, the fax was sent to.

Fromstring required

The phone number, in E.164 format, the fax was sent from.

Quality'standard' | 'fine' | 'superfine'

The quality of the fax.

StatusCallbackstring

The URL to send a POST request when the status of a fax changes.

Example request

{
  "MediaUrl": "https://example.com/fax.pdf",
  "To": "+13104456789",
  "From": "+13103383454",
  "Quality": "standard",
  "StatusCallback": "https://your-api-endpoint.com/path"
}

Response

The request has succeeded.

account_sidstring

The unique identifier for the account this fax is associated with.

api_versionstring

The version of the SignalWire API.

date_createdstring

The date and time, in ISO 8601 format, the fax was created.

date_updatedstring

The date and time, in ISO 8601 format, the fax was updated.

direction'inbound' | 'outbound'

Fax direction.

fromstring

The phone number, in E.164 format, the fax was sent from.

media_urlstring

The URL hosting the received media.

media_sidstring

The unique identifier for the media instance associated with the fax instance.

num_pagesstring

The number of pages in the fax document.

pricestring

The cost of the fax.

price_unitstring

The currency, in ISO 4217 format, of the price.

quality'standard' | 'fine' | 'superfine'

Fax quality.

sidstring

The unique identifier of the fax.

Fax status.

tostring

The phone number, in E.164 format, the fax was sent to.

durationinteger

The time, in seconds, it took to deliver a fax.

urlstring

The URL of this resource.

error_codestring

Error code for this resource (if available).

error_messagestring

The description of this error (if available).

Example response

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "api_version": "v1",
  "date_created": "2018-11-26T20:00:00Z",
  "date_updated": "2018-11-27T20:00:00Z",
  "from": "+13103383454",
  "media_url": "https://example.com/fax.pdf",
  "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
  "num_pages": "3",
  "price": "-0.005",
  "price_unit": "USD",
  "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
  "to": "+13104456789",
  "duration": 5000,
  "links": {
    "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
  },
  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
  "error_code": "34004",
  "error_message": "The call dropped prematurely"
}