REST ClientCompatRecordings

get

View as MarkdownOpen in Claude

Retrieve a single recording by SID.

Path parameters

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

Response

sidstringRequiredformat: "uuid"
The unique identifier for the recording.
account_sidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this recording.
api_versionstringRequired
The version of the SignalWire API.
call_sidstring or nullRequiredformat: "uuid"
The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
conference_sidstring or nullRequiredformat: "uuid"
The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
channelenumRequired
The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
Allowed values:
channelsenumRequired
The number of channels in a recording. Returns '1' for mono or '2' for stereo.
Allowed values:
date_createdstringRequired
The date, in RFC 2822 format, this recording was created.
date_updatedstringRequired
The date, in RFC 2822 format, this recording was updated.
start_timestring or nullRequired
The time, in RFC 2822 format, this recording started.
end_timestring or nullRequired
The time, in RFC 2822 format, this recording ended.
durationintegerRequired>=0
The length, in seconds, of the recording.
pricestring or nullRequired
The cost for the recording.
price_unitstringRequired
The currency of the price of the recording.
sourceenumRequired
How the recording was made.
statusenumRequired
The status of the recording.
error_codestring or nullRequired
Further details about a failed recording.
uristringRequired
The URI of the recording.
subresource_urisobjectRequired
Subresource URIs.
encryption_detailsstring or nullRequired
Encryption details. Always null.
trimstringRequired
Whether leading and trailing silence is trimmed from a recording.

Response Example

Response
1{
2  "sid": "19e436af-5688-4307-b03b-bdb2b42b8142",
3  "account_sid": "720796a0-8ee9-4350-83bd-2d07a3121f1e",
4  "api_version": "2010-04-01",
5  "call_sid": "43bb71ee-553f-4074-bb20-8e2747647cce",
6  "channel": "1",
7  "channels": "1",
8  "date_created": "Tue, 25 Sep 2018 23:00:00 +0000",
9  "date_updated": "Wed, 26 Sep 2018 23:00:04 +0000",
10  "start_time": "Tue, 25 Sep 2018 23:00:00 +0000",
11  "end_time": "Wed, 26 Sep 2018 23:00:04 +0000",
12  "duration": 4,
13  "price": "-0.0025",
14  "price_unit": "USD",
15  "source": "DialVerb",
16  "status": "queued",
17  "uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json",
18  "subresource_uris": {
19    "transcriptions": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json"
20  },
21  "trim": "do-not-trim"
22}

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
9recording = client.compat.recordings.get("RE...")