Fetch a specific fax

GET /v1/Faxes/{Sid}

TODO: Resource-level docs

Fetch a specific fax.

Path parameters

  • Sid string Required

    The Twilio-provided string that uniquely identifies the Fax resource to fetch.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • api_version string | null

      The API version used to transmit the fax

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • direction string | null

      The direction of the fax

      Values are inbound or outbound.

    • duration integer | null

      The time it took to transmit the fax

    • from string | null

      The number the fax was sent from

    • links object(uri-map) | null

      The URLs of the fax's related resources

    • media_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ME[0-9a-fA-F]{32}$.

    • media_url string | null

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

    • num_pages integer | null

      The number of pages contained in the fax document

    • price number | null

      The fax transmission price

    • price_unit string(currency) | null

      The ISO 4217 currency used for billing

    • quality string | null

      The quality of the fax

      Values are standard, fine, or superfine.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^FX[0-9a-fA-F]{32}$.

    • status string | null

      The status of the fax

      Values are queued, processing, sending, delivered, receiving, received, no-answer, busy, failed, or canceled.

    • to string | null

      The phone number that received the fax

    • url string(uri) | null

      The absolute URL of the fax resource
GET /v1/Faxes/{Sid} 
curl \
 -X GET https://fax.twilio.com/v1/Faxes/{Sid} \
 --user "username:password"
Response examples (200) 
{
  "account_sid": "string",
  "api_version": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "direction": "inbound",
  "duration": 42,
  "from": "string",
  "links": {},
  "media_sid": "string",
  "media_url": "string",
  "num_pages": 42,
  "price": 42.0,
  "price_unit": "string",
  "quality": "standard",
  "sid": "string",
  "status": "queued",
  "to": "string",
  "url": "https://example.com"
}