Faxes

Retrieve a Fax

Changed on

Retrieves one managed fax by SID so you can inspect its delivery progress, result, and document media. Use List all Faxes to discover SIDs; use Get fax log when you only need a historical log entry.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Fax.

Learn more about API scopes.

get/Accounts/{AccountSid}/Faxes/{Sid}

Request

  • Base URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
  • URL
    https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Faxes/{Sid}
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

Sidstring uuid required

Universal Unique Identifier.

The Fax ID that uniquely identifies the Fax.

Response

The request has succeeded.

account_sidstring required

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

api_versionstring required

The version of the SignalWire API.

date_createdstring required

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

date_updatedstring required

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

direction'inbound' | 'outbound' required

Fax direction.

fromstring required

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

media_urlstring nullable required

The URL hosting the received media, or null if not available.

media_sidstring required

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

num_pagesstring nullable required

The number of pages in the fax document, or null if not yet determined.

pricestring nullable required

The cost of the fax, or null if not yet calculated.

price_unitstring required

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

quality'standard' | 'fine' | 'superfine' required

Fax quality.

sidstring required

The unique identifier of the fax.

status'queued' | 'processing' | 'sending' | 'delivered' | 'receiving' | 'received' | 'no-answer' | 'busy' | 'failed' | 'canceled' required

Fax status.

tostring required

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

durationinteger required

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

urlstring required

The URL of this resource.

error_codestring nullable required

Error code for this resource, or null if no error.

error_messagestring nullable required

The description of this error, or null if no error.

Example response

{
  "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
  "api_version": "v1",
  "date_created": "2018-11-26T20:00:00Z",
  "date_updated": "2018-11-27T20:00:00Z",
  "from": "+13103383454",
  "media_url": "https://example.com/fax.pdf",
  "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
  "num_pages": "3",
  "price": "-0.005",
  "price_unit": "USD",
  "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
  "to": "+13104456789",
  "duration": 5000,
  "links": {
    "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
  },
  "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx"
}

Changes

  • 5344c0c93a4cRevision changes
    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the response body for the status

    • info

      added 'unevaluatedProperties' constraint to the //// response property for the status

  • 2e516ba2383fRevision changes
    • breaking

      response property error_code list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property error_message list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property media_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property num_pages list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property price list-of-types was widened by adding types null to media type application/json of response 200