Update a call recording

Update a call recording status during the call, a call recording status can be changed to paused, ongoing, or completed.

Update call recording

patch

Update a call recording

Authorizations
Path parameters
workspaceIdstring · uuidRequired

The ID of the workspace

callIdstring · uuidRequired

The ID for a call

channelIdstring · uuidRequired

The ID for a channel

recordingIdstring · uuidRequired

The ID for a call recording

Body
statusstring · enumOptionalPossible values:
Responses
202
Call Recording update accepted
application/json
patch
PATCH /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "paused"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "origin": "call-command-record",
  "duration": 1,
  "stereo": true,
  "endCause": "text",
  "createdAt": "2025-07-12T01:43:05.990Z",
  "updatedAt": "2025-07-12T01:43:05.990Z",
  "startedAt": "2025-07-12T01:43:05.990Z",
  "endedAt": "2025-07-12T01:43:05.990Z"
}

Example 1: Pause a call recording

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

Last updated

Was this helpful?