List all Faxes

GET 
/Accounts/:AccountSid/Faxes

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

Permissions

The API token must include the following scopes: Fax.

Request

Path Parameters

AccountSid uuidrequired

The Project ID that uniquely identifies the Account to retrieve.

Query Parameters

DateCreatedAfter string
DateCreatedOnOrBefore string
From string
To string

Responses

200

OK

application/json

Schema

Schema

meta

object

uristring

first_page_uristring

next_page_uristring

previous_page_uristring

pageinteger

page_sizeinteger

key

The name of the object

Example: faxes

faxes

object[]

Array [

account_sidstring

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

Example: b3877c40-da60-4998-90ad-b792e98472ac

api_versionstring

The version of the SignalWire API.

Example: v1

date_createdstring

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

Example: 2018-11-26T20:00:00Z

date_updatedstring

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

Example: 2018-11-27T20:00:00Z

directionstring

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

Possible values: [inbound, outbound]

Example: outbound

fromstring

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

Example: +13103383454

media_urlstring

The URL hosting the received media. Can use this URL to download incoming media. Optionally pass a username and password using the format "https://user:pass@example.com/path/to/fax.pdf".

Example: https://example.com/fax.pdf

media_sidstring

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

Example: b3877c40-da60-4998-90ad-b792e98472me

num_pagesstring

The number of pages in the fax document.

Example: null

pricestring

The cost of the fax.

Example: null

price_unitstring

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

Example: null

qualitystring

The quality of the fax.

Possible values: [standard, fine, superfine]

Example: standard

sidstring

The unique identifier of the fax.

Example: b3877c40-da60-4998-90ad-b792e98472fx

statusstring

The status of the fax.

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

Example: queued

tostring

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

Example: +13104456789

durationinteger

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

Example: 5000

links

object

The URL links for resources associated with the fax.

mediastring

Media associated with this fax.

Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media

urlstring

The URL of this resource.

Example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx

error_codestring

Error code for this resource (if available).

Example: 34004

error_messagestring

The description of this error (if available).

Example: The call dropped prematurely

]

Example (from schema)

{
  "meta": {
    "uri": "string",
    "first_page_uri": "string",
    "next_page_uri": "string",
    "previous_page_uri": "string",
    "page": 0,
    "page_size": 0,
    "key": "faxes"
  },
  "faxes": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "api_version": "v1",
      "date_created": "2018-11-26T20:00:00Z",
      "date_updated": "2018-11-27T20:00:00Z",
      "direction": "outbound",
      "from": "+13103383454",
      "media_url": "https://example.com/fax.pdf",
      "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
      "num_pages": "null",
      "price": "null",
      "price_unit": "null",
      "quality": "standard",
      "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
      "status": "queued",
      "to": "+13104456789",
      "duration": "5000",
      "links": {
        "media": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
      },
      "url": "/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
      "error_code": "34004",
      "error_message": "The call dropped prematurely"
    }
  ]
}