DokumentationEngagement Platform API
Sign inGet started
Guides
API

List Recordings

In order to retrieve all recordings you can use this request.
GET
/workspaces/{workspaceId}/recordings
List recordings
Abfrageparameter
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
sourceId
string
channelId
string
id
string
direction
string
Direction of the call
Possible values: incoming, outgoing
startAt
string
Start date for the query
endAt
string
End date for the query
from
string
From number of the call
to
string
To number of the call
status
string
Possible values: accepted, completed, ongoing, paused, available, absent, failed
Antwort-Payload
results
array of object
Untergeordnete Attribute anzeigen
results.id
string
erforderlich
The ID for the recording.
results.source
string
erforderlich
Possible values: call, conference
results.sourceId
string
erforderlich
The ID for the source.
results.channelId
string
The ID for the channel.
results.status
string
erforderlich
Possible values: accepted, completed, ongoing, paused, available, absent, failed
results.direction
string
Possible values: incoming, outgoing
results.originator
object
Untergeordnete Attribute anzeigen
results.originator.contact
object
Untergeordnete Attribute anzeigen
results.originator.contact.id
string
erforderlich
results.originator.contact.identifierKey
string
erforderlich
results.originator.contact.identifierValue
string
erforderlich
results.originator.number
object
erforderlich
Untergeordnete Attribute anzeigen
results.originator.number.type
string
erforderlich
Possible values: pstn, webrtc
results.originator.number.number
string
erforderlich
results.originator.number.anonymous
boolean
results.originator.number.callerIdName
string
results.originator.number.identity
string
results.originator.number.countryIsoCode
string
results.receiver
object
Untergeordnete Attribute anzeigen
results.receiver.contact
object
Untergeordnete Attribute anzeigen
results.receiver.contact.id
string
erforderlich
results.receiver.contact.identifierKey
string
erforderlich
results.receiver.contact.identifierValue
string
erforderlich
results.receiver.number
object
erforderlich
Untergeordnete Attribute anzeigen
results.receiver.number.type
string
erforderlich
Possible values: pstn, webrtc
results.receiver.number.number
string
erforderlich
results.receiver.number.anonymous
boolean
results.receiver.number.callerIdName
string
results.receiver.number.identity
string
results.receiver.number.countryIsoCode
string
results.origin
string
erforderlich
Possible values: call-command-record, call-command-record-call, create-call, bridge-call
results.duration
integer
results.stereo
boolean
erforderlich
results.format
string
erforderlich
results.transcription
boolean
erforderlich
results.conferenceId
string
The ID for the conference.
results.url
string
results.roomInfoUrl
string
results.createdAt
string
erforderlich
results.updatedAt
string
erforderlich
results.endedAt
string
results.startedAt
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}/recordings' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
Codebeispiel
curl "/workspaces/{workpaceId}/recordings" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'