Telnyx

{ "data": [ { "record_type": "fax", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "connection_id": "c-1", "direction": "outbound", "from": "+123", "to": "+456", "media_url": "http://www.example.com/fax.pdf", "store_media": true, "stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51", "preview_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b_preview.tiff?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51", "quality": "high", "webhook_url": "http://www.example.com/webhooks", "webhook_failover_url": "", "status": "queued", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "created_at": "2020-05-05T09:59:12", "updated_at": "2020-05-05T09:59:12" } ], "meta": { "page_number": 2, "page_size": 1, "total_pages": 3, "total_results": 3 } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[created_at][gte], filter[created_at][gt], filter[created_at][lte], filter[created_at][lt], filter[direction][eq], filter[from][eq], filter[to][eq]

Show child attributes

filter[created_at]

object

Date range filtering operations for fax creation timestamp

Show child attributes

filter[created_at][gte]

string<date-time>

ISO 8601 date time for filtering faxes created after or on that date

Example:

"2020-02-02T22:25:27.521992Z"

filter[created_at][gt]

string<date-time>

ISO 8601 date time for filtering faxes created after that date

Example:

"2020-02-02T22:25:27.521992Z"

filter[created_at][lte]

string<date-time>

ISO 8601 formatted date time for filtering faxes created on or before that date

Example:

"2020-02-02T22:25:27.521992Z"

filter[created_at][lt]

string<date-time>

ISO 8601 formatted date time for filtering faxes created before that date

Example:

"2020-02-02T22:25:27.521992Z"

filter[direction]

object

Direction filtering operations

Show child attributes

filter[direction][eq]

string

The direction, inbound or outbound, for filtering faxes sent from this account

Example:

"inbound"

filter[from]

object

From number filtering operations

Show child attributes

filter[from][eq]

string

The phone number, in E.164 format for filtering faxes sent from this number

Example:

"+13127367276"

filter[to]

object

To number filtering operations

Show child attributes

filter[to][eq]

string

The phone number, in E.164 format for filtering faxes sent to this number

Example:

"+13127367276"

page

object

Consolidated pagination parameter (deepObject style). Originally: page[size], page[number]

Show child attributes

page[size]

integer

Number of fax resources for the single page returned

Example:

2

page[number]

integer

Number of the page to be retrieved

Example:

2

Response

List faxes response

data

object[]

Show child attributes

data.record_type

enum<string>

Identifies the type of the resource.

Available options:

fax

Example:

"fax"

data.id

string<uuid>

Identifies the type of resource.

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.connection_id

string

The ID of the connection used to send the fax.

Example:

"234423"

data.direction

enum<string>

The direction of the fax.

Available options:

inbound,

outbound

Example:

"outbound"

data.media_url

string

The URL (or list of URLs) to the PDF used for the fax's media. media_url and media_name/contents can't be submitted together.

Example:

"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"

data.media_name

string

The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.

Example:

"my_media_uploaded_to_media_storage_api"

data.to

string

The phone number, in E.164 format, the fax will be sent to or SIP URI

Example:

"+13127367276"

data.from

string

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

Example:

"+13125790015"

data.from_display_name

string

The string used as the caller id name (SIP From Display Name) presented to the destination (to number).

Example:

"Company Name"

data.quality

enum<string>

default:high

The quality of the fax. The ultra settings provides the highest quality available, but also present longer fax processing times. ultra_light is best suited for images, wihle ultra_dark is best suited for text.

Available options:

normal,

high,

very_high,

ultra_light,

ultra_dark

Example:

"high"

data.status

enum<string>

Status of the fax

Available options:

queued,

media.processed,

originated,

sending,

delivered,

failed,

initiated,

receiving,

media.processing,

received

Example:

"queued"

data.webhook_url

string

URL that will receive fax webhooks

data.webhook_failover_url

string

Optional failover URL that will receive fax webhooks if webhook_url doesn't return a 2XX response

data.store_media

boolean

Should fax media be stored on temporary URL. It does not support media_name.

data.stored_media_url

string

If store_media was set to true, this is a link to temporary location. Link expires after 10 minutes.

data.preview_url

string

If store_preview was set to true, this is a link to temporary location. Link expires after 10 minutes.

data.client_state

string

State received from a command.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

data.created_at

string<date-time>

ISO 8601 timestamp when resource was created

data.updated_at

string<date-time>

ISO 8601 timestamp when resource was updated

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup