> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt # List Fax Media GET https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Faxes/{FaxSid}/Media List all media for a fax. #### 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). Reference: https://signalwire.com/docs/compatibility-api/rest/fax-media/list-all-fax-media ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: compatibility version: 1.0.0 paths: /Accounts/{AccountSid}/Faxes/{FaxSid}/Media: get: operationId: list-all-fax-media summary: List Fax Media description: >- List all media for a fax. #### 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). tags: - subpackage_faxMedia parameters: - name: AccountSid in: path description: The Project ID that uniquely identifies the Account. required: true schema: $ref: '#/components/schemas/uuid' - name: FaxSid in: path description: The Fax ID that uniquely identifies the Fax. required: true schema: $ref: '#/components/schemas/uuid' - name: Page in: query description: The page index to retrieve. Zero-indexed. required: false schema: type: integer default: 0 - name: PageSize in: query description: The number of results per page. Default is 50, maximum is 1000. required: false schema: type: integer default: 50 - name: PageToken in: query description: Token for cursor-based pagination. Required when Page > 0. required: false schema: type: string - name: Authorization in: header description: >- 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) ``` required: true schema: type: string responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/FaxMediaListResponse' '400': description: >- The request was invalid or cannot be processed. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '401': description: Authentication failed. Please verify your credentials and try again. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '404': description: >- The requested resource was not found. Please verify the resource identifier. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' '422': description: >- The request could not be processed due to validation errors. Check the error details for more information. content: application/json: schema: $ref: '#/components/schemas/CompatibilityErrorResponse' servers: - url: https://YOUR_SPACE.signalwire.com/api/laml/2010-04-01 description: SignalWire Compatibility API components: schemas: uuid: type: string format: uuid description: Universal Unique Identifier. title: uuid FaxMedia: type: object properties: account_sid: type: string description: The unique identifier for the account. content_type: type: string description: The content type of the media. date_created: type: string description: The date, in ISO 8601 format, this media was created. date_updated: type: string description: The date, in ISO 8601 format, this media was updated. fax_sid: type: string description: The unique identifier for the fax. sid: type: string description: The unique identifier for the media. uri: type: string description: The URI for the media. url: type: string description: The URL for the media. required: - account_sid - content_type - date_created - date_updated - fax_sid - sid - uri - url description: Fax media model. title: FaxMedia FaxMediaListResponse: type: object properties: uri: type: string description: The URI of the current page. first_page_uri: type: string description: The URI of the first page. next_page_uri: type: - string - 'null' description: The URI of the next page, or null if there are no more pages. previous_page_uri: type: - string - 'null' description: The URI of the previous page, or null if this is the first page. page: type: integer description: The current page number. page_size: type: integer description: The number of items per page. media: type: array items: $ref: '#/components/schemas/FaxMedia' description: List of media. fax_media: type: array items: $ref: '#/components/schemas/FaxMedia' description: List of fax media (alias for media). required: - uri - first_page_uri - next_page_uri - previous_page_uri - page - page_size - media - fax_media description: Response containing a list of fax media. title: FaxMediaListResponse CompatibilityErrorResponse: type: object properties: code: type: integer description: Error code. message: type: string description: Error message. more_info: type: string description: URL for more information about the error. status: type: integer description: HTTP status code. required: - code - message - more_info - status description: Error response model. title: CompatibilityErrorResponse securitySchemes: SignalWireBasicAuth: type: http scheme: basic description: >- 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) ``` ``` ## Examples **Response** ```json { "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" } ] } ``` **SDK Code** ```python import requests url = "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/laml/2010-04-01/Accounts/AccountSid/Faxes/FaxSid/Media")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```