List call recordings of a call

This endpoint lists all active call recordings of an active call. If you want to list recordings from a completed call, you should use the Recordings API.

Command record a call

type: object
title: ChannelCallRecordingList
description: A list of channel call recordings
properties:
  results:
    type: array
    items:
      $ref: './CallRecording.yml'

Get call recordings from a call

Get a list of recordings from a channel call

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

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

Query parameters

Response

200404422

OK

Body

application/json

resultsarray of ChannelCallRecording

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurl

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

Response

{
  "results": [
    {
      "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-29T13:34:53.214Z",
      "updatedAt": "2024-04-29T13:34:53.214Z",
      "startedAt": "2024-04-29T13:34:53.214Z",
      "endedAt": "2024-04-29T13:34:53.214Z"
    }
  ],
  "nextPageToken": "text"
}

Example 1: Get the list of call recordings

You might consider filtering the recording list based on a limit for example.

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" \
     -H 'Authorization: Bearer {Token}'

Request Body

// N/A

Response

{
  "results": [
    {
      "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"
    }
  ]
}