Retrieve a Recording
Changed onRetrieves one voice recording's metadata, such as duration, cost, and status. Use this account-level route for saved call or conference media; Video Room recordings are separate resources.
Request the recording URI with a .json extension to get the metadata.
GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
Access
Access to the recording URI, for metadata and audio alike, follows the project's Protect Recording Media URLs setting. New projects have it turned on. See Media URL protection.
- On: authenticate with your Project ID and an API token that has the Management scope. A request without valid credentials, or with a token that lacks the scope, gets a 401.
- Off: anyone with the URI can retrieve the recording without authenticating, which lets external applications embed recording URLs without exposing your API credentials. Recording URIs contain long random IDs, which makes them difficult to guess unless you reveal them.
Learn more about API scopes.
Recording audio
The same recording URI also returns the recording audio, depending on the extension. Without an extension, the response follows the request's Accept header: application/json returns the metadata, and a generic value such as */* returns the audio.
The audio URLs respond with a 302 redirect to the audio file, so your client must follow redirects. When the recording has no audio to return, for example because its status isn't completed, they respond with 404 and an empty body.
Retrieve WAV file
When a recording URI has a .wav extension, or no extension and a generic Accept header, the request redirects to a WAV version of the recording file.
GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.wav
GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}
Retrieve MP3 file
Setting an extension of ".mp3" on the URI redirects to an MP3 version of the recording. For example:
GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.mp3
Request
- Base URLhttps://YOUR_SPACE.signalwire.com/api/laml/2010-04-01
- URLhttps://YOUR_SPACE.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
- AuthHTTP basic
Path parameters
Universal Unique Identifier.
The unique identifier for the account that is associated with this recording.
Universal Unique Identifier.
The unique identifier for the recording.
Response
The request has succeeded.
Example response
{
"api_version": "2010-04-01",
"channel": "1",
"channels": "1",
"date_created": "Tue, 25 Sep 2018 23:00:00 +0000",
"date_updated": "Wed, 26 Sep 2018 23:00:04 +0000",
"start_time": "Tue, 25 Sep 2018 23:00:00 +0000",
"end_time": "Wed, 26 Sep 2018 23:00:04 +0000",
"duration": 4,
"price": 0.0025,
"price_unit": "USD",
"uri": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json",
"subresource_uris": {
"transcriptions": "/api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json"
},
"trim": "do-not-trim"
}Changes
- breaking
removed the media type
application/jsonfor the response with the status - info
added the media type
text/plainfor the response with the status
- breaking
- info
removed from the
response propertyallOflist for the response status - info
added
subschema #2to theresponse propertyanyOflist for the response status
- info