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

Update a call recording

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

callId*string (uuid)

The ID for a call

channelId*string (uuid)

The ID for a channel

recordingId*string (uuid)

The ID for a call recording

Body

application/json

statusenum

pausedongoingcompleted

Response

202400404422

Call Recording update accepted

Body

application/json

id*Id-2 (string (uuid))

callId*Id-2 (string (uuid))

channelIdChannelId (string (uuid))

status*CallRecordingStatus (enum)

acceptedongoingpausedcompletedavailableabsentfailed

origin*CallRecordingOrigin (enum)

call-command-recordcall-command-record-callcreate-callbridge-call

durationinteger

stereoboolean

endCausestring

createdAt*string (date-time)

updatedAt*string (date-time)

startedAtstring (date-time)

endedAtstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400404422

{
  "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": 0,
  "stereo": false,
  "endCause": "text",
  "createdAt": "2024-12-30T14:38:30.173Z",
  "updatedAt": "2024-12-30T14:38:30.173Z",
  "startedAt": "2024-12-30T14:38:30.173Z",
  "endedAt": "2024-12-30T14:38:30.173Z"
}

Example 1: Pause a call recording

Request Headers

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}'

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