Get a call by ID

GET

call

{callId}

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.call.getById('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "660e8400-e29b-41d4-a716-446655440001",
    "callDirection": "INBOUND",
    "startedAt": "2024-01-15T10:00:00Z",
    "title": "Customer support inquiry",
    "summary": "Customer inquired about billing and payment options",
    "status": "ENDED",
    "endedAt": "2024-01-15T10:30:00Z",
    "durationMs": 1800000,
    "endedStatus": "AGENT_ENDED_CALL",
    "recordingUrl": "https://s3.amazonaws.com/bucket/recording.mp3?...",
    "simulationJobId": "880e8400-e29b-41d4-a716-446655440003",
    "supersededByCallId": "990e8400-e29b-41d4-a716-446655440004",
    "createdAt": "2024-01-15T10:31:00Z",
    "updatedAt": "2024-01-15T10:31:00Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

callId

string<uuid>

required

Response

Call retrieved successfully

data

CallResponse · object

required

Response containing call information

Show child attributes

data.id

string<uuid>

required

Unique identifier for the call

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.projectId

string<uuid>

required

ID of the project this call belongs to

Example:

"660e8400-e29b-41d4-a716-446655440001"

data.callDirection

enum<string>

required

Direction of the call (inbound or outbound)

Available options:

INBOUND,

OUTBOUND

Example:

"INBOUND"

data.startedAt

string

required

Timestamp when the call started

Example:

"2024-01-15T10:00:00Z"

data.title

string | null

Auto-generated title for the call based on content

Example:

"Customer support inquiry"

data.summary

string | null

Auto-generated summary of the call conversation

Example:

"Customer inquired about billing and payment options"

data.status

enum<string> | null

Current status of the call

Available options:

RINGING,

IN_PROGRESS,

ENDED

Example:

"ENDED"

data.endedAt

string | null

Timestamp when the call ended

Example:

"2024-01-15T10:30:00Z"

data.durationMs

number | null

Duration of the call in milliseconds

Example:

1800000

data.endedStatus

enum<string> | null

Status indicating how the call ended

Available options:

PARTICIPANTS_DID_NOT_SPEAK,

AGENT_DID_NOT_ANSWER,

AGENT_DID_NOT_SPEAK,

AGENT_STOPPED_SPEAKING,

AGENT_ENDED_CALL,

AGENT_TRANSFERRED_CALL,

AGENT_BUSY,

AGENT_ERROR,

CUSTOMER_ENDED_CALL,

VOICE_MAIL_REACHED,

SILENCE_TIME_OUT,

PHONE_CALL_PROVIDER_CONNECTION_ERROR,

CUSTOMER_DID_NOT_ANSWER,

CUSTOMER_DID_NOT_SPEAK,

CUSTOMER_STOPPED_SPEAKING,

CUSTOMER_BUSY,

DIAL_ERROR,

MAX_DURATION_REACHED,

UNKNOWN

Example:

"AGENT_ENDED_CALL"

data.recordingUrl

string | null

Pre-signed URL to the call recording (expires in 1 hour)

Example:

"https://s3.amazonaws.com/bucket/recording.mp3?..."

data.simulationJobId

string<uuid> | null

ID of the simulation job if this call was generated by a simulation

Example:

"880e8400-e29b-41d4-a716-446655440003"

data.supersededByCallId

string<uuid> | null

ID of the call that superseded this one (if applicable)

Example:

"990e8400-e29b-41d4-a716-446655440004"

data.createdAt

string | null

Timestamp when the call record was created

Example:

"2024-01-15T10:31:00Z"

data.updatedAt

string | null

Timestamp when the call record was last updated

Example:

"2024-01-15T10:31:00Z"

Get call evaluation runsFetch all evaluation run results for a specific call.

⌘I

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.call.getById('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.data);

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "660e8400-e29b-41d4-a716-446655440001",
    "callDirection": "INBOUND",
    "startedAt": "2024-01-15T10:00:00Z",
    "title": "Customer support inquiry",
    "summary": "Customer inquired about billing and payment options",
    "status": "ENDED",
    "endedAt": "2024-01-15T10:30:00Z",
    "durationMs": 1800000,
    "endedStatus": "AGENT_ENDED_CALL",
    "recordingUrl": "https://s3.amazonaws.com/bucket/recording.mp3?...",
    "simulationJobId": "880e8400-e29b-41d4-a716-446655440003",
    "supersededByCallId": "990e8400-e29b-41d4-a716-446655440004",
    "createdAt": "2024-01-15T10:31:00Z",
    "updatedAt": "2024-01-15T10:31:00Z"
  }
}

API Reference

Health

Integrations

Call

Chat

Evaluation

Simulation

Persona

Metric Definitions

Authorizations

Path Parameters

Response