Update a call recording

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

Example 1: Pause a call recording

curl -X "PATCH" "https://nest.messagebird.one/workspaces/8bc02f53-87ac-48d2-b4fd-c2cf856a305f/channels/880d8171-cbab-47bb-81b6-b1a0902da136/calls/0b4cbfa2-813f-4b93-8007-265875bb88bb/recordings/32b98cd8-db4b-4a47-816e-ff7ff72b1da6" \
     -H 'Authorization: Bearer {Token}'

{
  "status": "paused"
}

{
  "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"
}

Last updated 1 year ago

Was this helpful?

Update call recording

Update a call recording

patch

/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}

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 · enum

Options: paused, ongoing, completed

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "paused"
  }'

202

400

404

422

{
  "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-03-09T02:07:18.230Z",
  "updatedAt": "2025-03-09T02:07:18.230Z",
  "startedAt": "2025-03-09T02:07:18.230Z",
  "endedAt": "2025-03-09T02:07:18.230Z"
}

Call Recording update accepted