Get a call recording

In order to retrieve a active recording metadata, you can use the following endpoint.

Get channel call recording

Get a channel call recording

GET/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

Response

200404

OK

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

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings/{recordingId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "callId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "origin": "call-command-record",
  "stereo": false,
  "endCause": "text",
  "createdAt": "2024-04-29T16:34:46.429Z",
  "updatedAt": "2024-04-29T16:34:46.429Z",
  "startedAt": "2024-04-29T16:34:46.429Z",
  "endedAt": "2024-04-29T16:34:46.429Z"
}

Example 1: Get a specific call recording

Request Headers

curl "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

// N/A

Response

{
  "id": "32b98cd8-db4b-4a47-816e-ff7ff72b1da6",
  "channelId": "880d8171-cbab-47bb-81b6-b1a0902da136",
  "callId": "0b4cbfa2-813f-4b93-8007-265875bb88bb",
  "status": "available",
  "origin": "create-call",
  "duration": 0,
  "stereo": false,
  "createdAt": "2023-10-26T18:28:55.646Z",
  "updatedAt": "2023-10-26T18:28:55.646Z",
  "startedAt": "2023-10-26T18:28:55.373Z",
  "endedAt": "0001-01-01T00:00:00Z"
}