/v1/Faxes - Twilio

Retrieve a list of all faxes.

{ "faxes": [ { "account_sid": "stringstringstringstringstringstri", "api_version": "string", "date_created": "2019-08-24T14:15:22Z", "date_updated": "2019-08-24T14:15:22Z", "direction": "inbound", "duration": 0, "from": "string", "links": {}, "media_sid": "stringstringstringstringstringstri", "media_url": "string", "num_pages": 0, "price": 0, "price_unit": "string", "quality": "standard", "sid": "stringstringstringstringstringstri", "status": "queued", "to": "string", "url": "http://example.com" } ], "meta": { "first_page_url": "http://example.com", "key": "string", "next_page_url": "http://example.com", "page": 0, "page_size": 0, "previous_page_url": "http://example.com", "url": "http://example.com" } }

Request

Query Params

From

string

optional

Retrieve only those faxes sent from this phone number, specified in E.164 format.

string

optional

Retrieve only those faxes sent to this phone number, specified in E.164 format.

DateCreatedOnOrBefore

string

optional

Retrieve only those faxes with a date_created that is before or equal to this value, specified in ISO 8601 format.

DateCreatedAfter

string

optional

Retrieve only those faxes with a date_created that is later than this value, specified in ISO 8601 format.

PageSize

integer

optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Responses

🟢200OK

application/json

Body

faxes

array[object (fax.v1.fax) {18}]

optional

account_sid

string | null

optional

The SID of the Account that created the resource

>= 34 characters<= 34 characters

Match pattern:

^AC[0-9a-fA-F]{32}$

api_version

string | null

optional

The API version used to transmit the fax

date_created

string <date-time> | null

optional

The ISO 8601 formatted date and time in GMT when the resource was created

date_updated

string <date-time> | null

optional

The ISO 8601 formatted date and time in GMT when the resource was last updated

direction

enum<string> | enum<null>

optional

The direction of the fax

Allowed values:

inboundoutbound

duration

integer | null

optional

The time it took to transmit the fax

from

string | null

optional

The number the fax was sent from

links

object | null

optional

The URLs of the fax's related resources

media_sid

string | null

optional

The SID of the FaxMedia resource that is associated with the Fax

>= 34 characters<= 34 characters

Match pattern:

^ME[0-9a-fA-F]{32}$

media_url

string | null

optional

The Twilio-hosted URL that can be used to download fax media

num_pages

integer | null

optional

The number of pages contained in the fax document

price

number | null

optional

The fax transmission price

price_unit

string <currency> | null

optional

The ISO 4217 currency used for billing

quality

enum<string> | enum<null>

optional

The quality of the fax

Allowed values:

standardfinesuperfine

sid

string | null

optional

The unique string that identifies the resource

>= 34 characters<= 34 characters

Match pattern:

^FX[0-9a-fA-F]{32}$

status

enum<string> | enum<null>

optional

The status of the fax

Allowed values:

queuedprocessingsendingdeliveredreceivingreceivedno-answerbusyfailedcanceled

string | null

optional

The phone number that received the fax

url

string <uri> | null

optional

The absolute URL of the fax resource