Skip to main content
GET
/
v1
/
calls
/
recordings
/
{recordingId}
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/calls/recordings/{recordingId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "call_rec_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "callId": "call_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "status": "completed",
  "format": "mp4",
  "duration": 120,
  "fileUrl": "<string>",
  "fileSize": 123,
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

​
recordingId
string
required

Unique identifier for a Call Recording. Format: call_rec_[test_]{ksuid}

Pattern: ^call_rec_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"call_rec_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Recording details

​
id
string
required

Unique identifier for a Call Recording. Format: call_rec_[test_]{ksuid}

Pattern: ^call_rec_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"call_rec_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
callId
string
required

Unique identifier for a Call. Format: call_[test_]{ksuid}

Pattern: ^call_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"call_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
status
enum<string>
required

Recording status

Available options:
recording,
processing,
completed,
failed
Example:

"completed"

​
format
enum<string>
required
Available options:
mp4,
ogg,
webm
Example:

"mp4"

​
duration
number | null
required

Recording duration in seconds

Example:

120

​
fileUrl
string | null
required

URL to download the recording

​
fileSize
number | null
required

File size in bytes

​
startedAt
string<date-time> | null
required
​
endedAt
string<date-time> | null
required
​
createdAt
string<date-time>
required