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

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

Query parameters

limitinteger · min: 1 · max: 1000 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/recordings' \
  --header 'Authorization: Bearer jwt'

200

404

422

200

{
  "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",
      "duration": 1,
      "stereo": true,
      "endCause": "text",
      "createdAt": "2025-02-21T18:03:09.563Z",
      "updatedAt": "2025-02-21T18:03:09.563Z",
      "startedAt": "2025-02-21T18:03:09.563Z",
      "endedAt": "2025-02-21T18:03:09.563Z"
    }
  ],
  "nextPageToken": "text"
}

OK

Example 1: Get the list of call recordings

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

Request Headers

curl "/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/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"
    }
  ]
}