Faxes

List all Faxes

Changed on

Lists the account's fax resources. Each fax has a SID used for delivery inspection, cancellation, deletion, or media access. Use Fax logs for read-only historical reporting.

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

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
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

Query parameters

Pageinteger

The page index to retrieve. Zero-indexed.

PageSizeinteger

The number of results per page. Default is 50, maximum is 1000.

PageTokenstring

Token for cursor-based pagination. Required when Page > 0.

DateCreatedAfterstring

The date, in ISO 8601 format, after which the fax was sent.

DateCreatedOnOrBeforestring

The date, in ISO 8601 format, on or before which the fax was sent.

Fromstring

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

Tostring

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

Response

The request has succeeded.

uristring required

The URI of the current page.

first_page_uristring required

The URI of the first page.

next_page_uristring nullable required

The URI of the next page, or null if there are no more pages.

previous_page_uristring nullable required

The URI of the previous page, or null if this is the first page.

pageinteger required

The current page number.

page_sizeinteger required

The number of items per page.

Example response

{
  "uri": "/fax/v1/Faxes?Page=0&PageSize=50",
  "first_page_uri": "/fax/v1/Faxes?PageSize=50",
  "next_page_uri": "/fax/v1/Faxes?Page=1&PageSize=50&PageToken=PAb3877c40da604998",
  "page_size": 50,
  "faxes": [
    {
      "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

    • info

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

  • 2e516ba2383fRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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