REST ClientCompatFaxes

list_media

View as MarkdownOpen in Claude

List media items attached to a fax.

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

uristringRequired
The URI of the current page.
first_page_uristringRequired
The URI of the first page.
next_page_uristring or nullRequired
The URI of the next page, or null if there are no more pages.
previous_page_uristring or nullRequired
The URI of the previous page, or null if this is the first page.
pageintegerRequired
The current page number.
page_sizeintegerRequired
The number of items per page.
medialist of objectsRequired
List of media.
fax_medialist of objectsRequired
List of fax media (alias for media).

Response Example

Response
1{
2  "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50",
3  "first_page_uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50",
4  "page": 0,
5  "page_size": 50,
6  "media": [
7    {
8      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
9      "content_type": "application/pdf",
10      "date_created": "2018-11-26T20:00:00Z",
11      "date_updated": "2018-11-27T20:00:00Z",
12      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
13      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
14      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
15      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
16    }
17  ],
18  "fax_media": [
19    {
20      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
21      "content_type": "application/pdf",
22      "date_created": "2018-11-26T20:00:00Z",
23      "date_updated": "2018-11-27T20:00:00Z",
24      "fax_sid": "b3877c40-da60-4998-90ad-b792e98472fx",
25      "sid": "b3877c40-da60-4998-90ad-b792e98472me",
26      "uri": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json",
27      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json"
28    }
29  ]
30}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9media = client.compat.faxes.list_media("FX...")