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

useraccessKey

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

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

patch

HTTPcURLJavaScriptPython

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-20T02:05:26.954Z",
  "updatedAt": "2025-07-20T02:05:26.954Z",
  "startedAt": "2025-07-20T02:05:26.954Z",
  "endedAt": "2025-07-20T02:05:26.954Z"
}

Example 1: Pause a call recording

Request Headers

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

Request Body

{
  "status": "paused"
}

Response

{​
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",​
  "channelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",​
  "status": "accepted",​
  "origin": "call-command-record",​
  "duration": 0,​
  "stereo": true,​
  "endCause": "string",​
  "createdAt": "2023-10-25T14:36:18.580Z",​
  "updatedAt": "2023-10-25T14:36:18.580Z",​
  "startedAt": "2023-10-25T14:36:18.580Z",​
  "endedAt": "2023-10-25T14:36:18.580Z"​
​}