List Fax Media | SignalWire

{
  "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",
  "next_page_uri": null,
  "previous_page_uri": null,
  "page": 0,
  "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"
    }
  ]
}

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.

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](/docs/compatibility-api/rest/message-media/list-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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"

The Project ID that uniquely identifies the Account.

FaxSidstringRequiredformat: "uuid"

The Fax ID that uniquely identifies the Fax.

Query parameters

PageintegerOptional>=0Defaults to 0

The page index to retrieve. Zero-indexed.

PageSizeintegerOptional1-1000Defaults to 50

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

PageTokenstringOptional

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

Response

The request has succeeded.

uristring

The URI of the current page.

first_page_uristring

The URI of the first page.

next_page_uristring or null

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

previous_page_uristring or null

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

pageinteger

The current page number.

page_sizeinteger

The number of items per page.

medialist of objects

List of media.

fax_medialist of objects

List of fax media (alias for media).

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error