Skip to main content

Send a Fax

Send a fax.

Permissions

The API token must include the following scopes: Fax.

Path Parameters
AccountSid uuid REQUIRED

The Project ID that uniquely identifies the Account to retrieve.

Request Body
MediaUrl string REQUIRED

The URL hosting the received media. Can use this URL to download incoming media.

To string REQUIRED

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

From string

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

Quality string

Possible values: [standard, fine, superfine]

The quality of the fax.

StatusCallback string

The URL to send a POST request when the status of a fax changes. See here for the list of parameters passed back to your endpoint.

Responses
200

OK

Schema OPTIONAL
account_sid string OPTIONAL

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

api_version string OPTIONAL

The version of the SignalWire API.

date_created string OPTIONAL

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

date_updated string OPTIONAL

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

direction string OPTIONAL

Possible values: [inbound, outbound]

The direction of the fax. Possible values are inbound or outbound.

from string OPTIONAL

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

media_url string OPTIONAL

The URL hosting the received media. Can use this URL to download incoming media.

media_sid string OPTIONAL

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

num_pages string OPTIONAL

The number of pages in the fax document.

price string OPTIONAL

The cost of the fax.

price_unit string OPTIONAL

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

quality string OPTIONAL

Possible values: [standard, fine, superfine]

The quality of the fax.

sid string OPTIONAL

The unique identifier of the fax.

status string OPTIONAL

Possible values: [queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, canceled]

The status of the fax.

to string OPTIONAL

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

duration integer OPTIONAL

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

links object OPTIONAL

The URL links for resources associated with the fax.

media string OPTIONAL

Media associated with this fax.

url string OPTIONAL

The URL of this resource.