View a fax

GET 
/faxes/:id

View a fax

Request

Path Parameters

id uuidrequired

The unique identifier of a fax.

Responses

200: Get fax response

application/json

• Schema
• Example (from schema)

Schema

data

object

record_type string

Possible values: [fax]

Identifies the type of the resource.

id uuid

Identifies the type of resource.

connection_id ConnectionId (string)

The ID of the connection used to send the fax.

direction Direction (string)

Possible values: [inbound, outbound]

The direction of the fax.

media_url MediaUrl (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.

media_name MediaName (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.

to To (string)

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

from From (string)

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

from_display_name string

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

quality Quality (string)

Possible values: [normal, high, very_high, ultra_light, ultra_dark]

Default value: 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.

status string

Possible values: [queued, media.processed, originated, sending, delivered, failed, initiated, receiving, media.processing, received]

Status of the fax

webhook_url string

URL that will receive fax webhooks

webhook_failover_url string

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

store_media boolean

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

stored_media_url string

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

created_at datetime

ISO 8601 timestamp when resource was created

updated_at datetime

ISO 8601 timestamp when resource was updated

{
  "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",
    "quality": "high",
    "webhook_url": "http://www.example.com/webhooks",
    "webhook_failover_url": "",
    "status": "queued",
    "created_at": "2020-05-05T09:59:12",
    "updated_at": "2020-05-05T09:59:12"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...