The Recordings API lets an external system collect CCaaS call recordings programmatically — for archiving, quality assurance, compliance retention, or analysis in a third-party tool. Collection is a two-step process: list the recordings for a time range to get each recording's metadata and recordingKey, then download the audio for each recording one at a time.

Overview

Authentication

Every request requires a Service User bearer token in the Authorization header:

Authorization: Bearer <api_bearer_token>

Service Users are created under API Enablement > API Service Users. See API Service Users.

Endpoints

List Recordings

GET /v2/recordings

Returns the metadata for every call recording within a time range. Each record describes the recording — the parties, call direction, skill, agent, and file size — but does not include the audio itself. Use each record's recordingKey with Download Recording Audio to download the audio.

GET https://<hostname>.xima.cloud/rest/api/v2/recordings

Parameters

Responses

See API Limits & Statuses for statuses shared by every CCaaS API.

Example Request

curl -L -X GET 'https://<hostname>.xima.cloud/rest/api/v2/recordings?startTime=2026-11-02T08:00:00.000-07:00&endTime=2026-11-02T17:00:00.000-07:00' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <api_bearer_token>'

Example Response — 200 OK

[
  {
    "recordingKey": "af66cf94-29fc-43f8-8228-b5640379578d-1793638800000",
    "callKey": "b4c3911a-7128-4da1-9ed6-d590f7c1a2b7-1793638776000-1793639868000",
    "startTime": 1793638800000,
    "duration": 1068993,
    "size": 0,
    "eventId": 99390,
    "recordingSystemId": 0,
    "status": "PENDING",
    "callingParty": "15550100147",
    "receivingParty": "Jane Doe(101)",
    "tenantName": "example-ns",
    "tagData": "Default",
    "callDirection": "INBOUND",
    "skill": "Sales",
    "agent": "Jane Doe(101)"
  }
]

Download Recording Audio

GET /v2/recordings/{hostname}/{recording_key}/audio

Returns the audio file for a single recording as an OGG-encoded binary stream. The recording_key comes from the recordingKey field, and hostname from the tenantName field, of a Recording returned by List Recordings.

GET https://<hostname>.xima.cloud/rest/api/v2/recordings/{hostname}/{recording_key}/audio

Parameters

Responses

Example Request

curl -L -X GET 'https://<hostname>.xima.cloud/rest/api/v2/recordings/example-ns/af66cf94-29fc-43f8-8228-b5640379578d-1793638800000/audio' \
-H 'Content-Type: audio/ogg' \
-H 'Authorization: Bearer <api_bearer_token>' \
--output recording.ogg

Example Response — 200 OK

A binary OGG audio stream. Save the response body to a file, as the --output option does above.

Models

Recording

One call recording, as returned by List Recordings.

Limits

See API Limits & Statuses for full details.

Related Pages

• Data APIs
• Active Recording Management — pause and resume an agent's active call recording
• API Service Users
• API Limits & Statuses