DokumentationEngagement Platform API
Sign inGet started
Guides
API

Update a call recording

Update a call recording status during the call, a call recording status can be changed to paused, ongoing, or completed.
PATCH
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}
Update a call recording
Anfrage-Payload
status
string
Possible values: paused, ongoing, completed
Antwort-Payload
id
string
erforderlich
callId
string
erforderlich
channelId
string
status
string
erforderlich
Possible values: accepted, ongoing, paused, completed, available, absent, failed
origin
string
erforderlich
Possible values: call-command-record, call-command-record-call, create-call, bridge-call
duration
integer
stereo
boolean
endCause
string
createdAt
string
erforderlich
updatedAt
string
erforderlich
startedAt
string
endedAt
string
Codebeispiel
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Pause a call recording

Codebeispiel
curl -X PATCH "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"