Fax Media

List Fax Media

Changed on

Returns the document media associated with one fax. Use it when a fax SID is known and you need the media SID or metadata; Message Media contains MMS attachments and is a separate collection.

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/{FaxSid}/Media

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/{FaxSid}/Media
  • Auth
    HTTP basic

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

The Project ID that uniquely identifies the Account.

FaxSidstring uuid required

Universal Unique Identifier.

The Fax ID that uniquely identifies the Fax.

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.

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/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50",
  "first_page_uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50",
  "page_size": 50,
  "media": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "content_type": "application/pdf",
      "date_created": "2018-11-26T20:00:00Z",
      "date_updated": "2018-11-27T20:00:00Z",
      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
    }
  ],
  "fax_media": [
    {
      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
      "content_type": "application/pdf",
      "date_created": "2018-11-26T20:00:00Z",
      "date_updated": "2018-11-27T20:00:00Z",
      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
    }
  ]
}

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 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 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