Skip to main content

List all Faxes

The ability to read all of the faxes that are associated with your Account. This will be returned as a list of faxes.

Path Parameters
AccountSid uuid REQUIRED

The Project ID that uniquely identifies the Account to retrieve.

Query Parameters
DateCreatedAfter string

Filter the returned list of faxes to only those that were created after the specified date.

DateCreatedOnOrBefore string

Filter the returned list of faxes to only those that were created on or before the specified date.

From string

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

To string

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

Responses
200

OK

Schema
meta object
uri string
first_page_uri string
next_page_uri string
previous_page_uri string
page integer
page_size integer
key

The name of the object

faxes object[]
account_sid string

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

api_version string

The version of the SignalWire API.

date_created string

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

date_updated string

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

direction string

Possible values: [inbound, outbound]

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

from string

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

media_url string

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

media_sid string

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

num_pages string

The number of pages in the fax document.

price string

The cost of the fax.

price_unit string

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

quality string

Possible values: [standard, fine, superfine]

The quality of the fax.

sid string

The unique identifier of the fax.

status string

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

The status of the fax.

to string

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

duration integer

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

links object

The URL links for resources associated with the fax.

media string

Media associated with this fax.

url string

The URL of this resource.