Fax Media

List Fax Media

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

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

Changed in 5 of the 40 revisions of this API.638

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-body-unevaluated-properties-added

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

      response-property-unevaluated-properties-added

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

      response-property-unevaluated-properties-added

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

      response-property-list-of-types-widened

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

      response-property-list-of-types-widened

  • d5fbaaddfa3e222See the full diff
    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • added the new optional query request parameter Page

      new-optional-request-parameter

    • added the new optional query request parameter PageSize

      new-optional-request-parameter

    • added the new optional query request parameter PageToken

      new-optional-request-parameter

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property // became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • added the required property to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the response property became nullable for the status

      response-property-became-nullable

  • 3c88f14db21e19See the full diff
    • the response's body type changed from no type to object for status

      response-body-type-changed

    • removed subschema #2 from the response body allOf list for the response status

      response-body-all-of-removed

    • added the non-success response with the status

      response-non-success-status-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog