List

View as Markdown

Use this endpoint for the Recordings method to fetch all the recordings that are associated with your SignalWire account. This will be returned as a list of recordings.

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this recording.

Query parameters

DateCreatedstringOptional
Filter by recordings created on this exact date (RFC 2822 format).
DateCreated<stringOptional
Filter by recordings created before this date (RFC 2822 format).
DateCreated>stringOptional
Filter by recordings created after this date (RFC 2822 format).
CallSidstringOptionalformat: "uuid"
Filter by recordings associated with a specific call.
ConferenceSidstringOptionalformat: "uuid"
Filter by recordings associated with a specific conference.
PageintegerOptional>=0Defaults to 0
The page number 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 navigating to pages beyond the first.

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. Null if there are no more pages.
previous_page_uristring or nullRequired
The URI of the previous page. Null if this is the first page.
pageintegerRequired
The current page number (zero-indexed).
page_sizeintegerRequired
The number of items per page.
recordingslist of objectsRequired
List of recordings.
Response
1{
2 "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings?Page=0&PageSize=50",
3 "first_page_uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings",
4 "next_page_uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings?Page=1&PageSize=50&PageToken=PA19e436af-5688-4307-b03b-bdb2b42b8142",
5 "previous_page_uri": "string",
6 "page": 0,
7 "page_size": 50,
8 "recordings": [
9 {
10 "sid": "19e436af-5688-4307-b03b-bdb2b42b8142",
11 "account_sid": "720796a0-8ee9-4350-83bd-2d07a3121f1e",
12 "api_version": "2010-04-01",
13 "call_sid": "43bb71ee-553f-4074-bb20-8e2747647cce",
14 "conference_sid": "string",
15 "channel": "1",
16 "channels": "1",
17 "date_created": "Tue, 25 Sep 2018 23:00:00 +0000",
18 "date_updated": "Wed, 26 Sep 2018 23:00:04 +0000",
19 "start_time": "Tue, 25 Sep 2018 23:00:00 +0000",
20 "end_time": "Wed, 26 Sep 2018 23:00:04 +0000",
21 "duration": 4,
22 "price": "-0.0025",
23 "price_unit": "USD",
24 "source": "DialVerb",
25 "status": "queued",
26 "error_code": "string",
27 "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json",
28 "subresource_uris": {
29 "transcriptions": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json"
30 },
31 "encryption_details": "string",
32 "trim": "do-not-trim"
33 }
34 ]
35}

Request examples

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

Request: list all recordings of a call

List All Recordings of a Call.

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.recordings.each({ callSid: '43bb71ee-553f-4074-bb20-8e2747647cce' }, recordings => console.log(recordings.sid));

Request: list all recordings on September 25, 2018

List All Recordings on September 25, 2018

1const { RestClient } = require('@signalwire/compatibility-api')
2const client = RestClient('YourProjectID', 'YourAuthToken', { signalwireSpaceUrl: 'example.signalwire.com' })
3
4client.recordings.each({ dateCreated: new Date(Date.UTC(2018, 9, 25, 0, 0, 0)) }, recordings => console.log(recordings.sid));