REST Client MethodsFaxes

List

View as Markdown

Use this endpoint for the Fax method to list all faxes on your SignalWire account.

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.

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.
DateCreatedAfterstringOptional
The date, in ISO 8601 format, after which the fax was sent.
DateCreatedOnOrBeforestringOptional
The date, in ISO 8601 format, on or before which the fax was sent.
FromstringOptional
The phone number, in E.164 format, the fax was sent from.
TostringOptional
The phone number, in E.164 format, the fax was sent to.

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.
faxeslist of objectsRequired
List of faxes.
Response
1{
2  "uri": "/fax/v1/Faxes?Page=0&PageSize=50",
3  "first_page_uri": "/fax/v1/Faxes?PageSize=50",
4  "next_page_uri": "/fax/v1/Faxes?Page=1&PageSize=50&PageToken=PAb3877c40da604998",
5  "previous_page_uri": "string",
6  "page": 0,
7  "page_size": 50,
8  "faxes": [
9    {
10      "account_sid": "b3877c40-da60-4998-90ad-b792e98472ac",
11      "api_version": "v1",
12      "date_created": "2018-11-26T20:00:00Z",
13      "date_updated": "2018-11-27T20:00:00Z",
14      "direction": "inbound",
15      "from": "+13103383454",
16      "media_url": "https://example.com/fax.pdf",
17      "media_sid": "b3877c40-da60-4998-90ad-b792e98472me",
18      "num_pages": "3",
19      "price": "-0.005",
20      "price_unit": "USD",
21      "quality": "standard",
22      "sid": "b3877c40-da60-4998-90ad-b792e98472fx",
23      "status": "queued",
24      "to": "+13104456789",
25      "duration": 5000,
26      "links": {
27        "media": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media"
28      },
29      "url": "/fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx",
30      "error_code": "string",
31      "error_message": "string"
32    }
33  ]
34}

Request examples

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.fax.faxes.each(faxes => console.log(faxes.sid));