Retrieve a call recording
GET/recordings/:recording_id
Retrieves the details of an existing call recording.
Request
Path Parameters
Uniquely identifies the recording by id.
Responses
200: A response with recording resource.
- application/json
- Schema
- Example (from schema)
Schema
data
object
Unique identifier and token for controlling the call.
ID that is unique to the call and can be used to correlate webhook events.
ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call.
Possible values: [single
, dual
]
When dual
, final audio file has the first leg on channel A, and the rest on channel B.
Uniquely identifies the conference.
ISO 8601 formatted date indicating when the resource was created.
download_urls
object
The links to download the recording files.
Link to download the recording in mp3 format.
Link to download the recording in wav format.
The links to download the recording files.
The duration of the recording in milliseconds.
Uniquely identifies the recording.
Possible values: [recording
]
ISO 8601 formatted date of when the recording started.
ISO 8601 formatted date of when the recording ended.
Possible values: [conference
, call
]
The kind of event that led to this recording being created.
Possible values: [completed
]
The status of the recording. Only resources for completed
recordings are currently supported.
ISO 8601 formatted date indicating when the resource was updated.
{
"data": {
"call_control_id": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw",
"call_leg_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
"call_session_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
"channels": "dual",
"conference_id": "84a97d76-e40f-11ed-9074-02420a0daa69",
"created_at": "2018-02-02T22:25:27.521Z",
"download_urls": {
"mp3": "string",
"wav": "string"
},
"duration_millis": 60000,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "recording",
"recording_started_at": "2019-01-23T18:10:02.574Z",
"recording_ended_at": "2019-01-23T18:10:02.574Z",
"source": "conference",
"status": "completed",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
default: Unexpected error.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}