DokumentationEngagement Platform API
Sign inGet started
Guides
API

List call recordings of a call

This endpoint lists all active call recordings of an active call. If you want to list recordings from a completed call, you should use the Recordings API.
GET
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings
Get a list of recordings from a channel call
Abfrageparameter
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
Antwort-Payload
results
array of object
Untergeordnete Attribute anzeigen
results.id
string
erforderlich
results.callId
string
erforderlich
results.channelId
string
results.status
string
erforderlich
Possible values: accepted, ongoing, paused, completed, available, absent, failed
results.origin
string
erforderlich
Possible values: call-command-record, call-command-record-call, create-call, bridge-call
results.duration
integer
results.stereo
boolean
results.endCause
string
results.createdAt
string
erforderlich
results.updatedAt
string
erforderlich
results.startedAt
string
results.endedAt
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Get the list of call recordings

You might consider filtering the recording list based on a limit for example.
Codebeispiel
curl "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"