Skip to main content
GET
Get a call

Authorizations

Authorization
string
header
required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Path Parameters

projectId
string
required

Project id

id
string
required

Call id

Response

The call.

id
string
required
project_id
string
required
platform_id
string | null
platform_name
string | null
conversation_id
string | null

The conversation this call belongs to; null for a scheduled call that has not started.

participant_identity
string | null

The call's participant identity in the media room.

originator
object
receiver
object
did
string | null

Our side phone (DID) when PSTN

remote_number
string | null

Far end phone when PSTN

status
enum<string> | null
Available options:
scheduled,
accepted,
ringing,
ongoing,
completed,
busy,
no-answer,
failed,
cancelled
reason
object | null
direction
enum<string> | null
Available options:
incoming,
outgoing
type
enum<string> | null

Call type / channel

Available options:
pstn,
webrtc,
sip,
whatsapp
duration
integer<int64> | null
context
object | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
ringing_at
string<date-time> | null
answered_at
string<date-time> | null
ended_at
string<date-time> | null
signalling_metrics
object | null
media_metrics
object | null
media_insights
object | null

Caller-side network statistics (round-trip time, jitter, loss) reported by the web widget. Null for phone calls.

hangup_reason
string | null
hangup_sip_code
string | null
scheduled_for
string<date-time> | null
amd_result
object | null
tags
string[] | null
room_name
string | null

Name of the media room backing this call. Distinct from platform_id (the room's id).

agent_id
string | null

The agent that handled the call's conversation.

region_profile
string | null

The regional deployment profile that served the call; null for the default.

eval_submission_id
string | null

The evaluation run this call belongs to, for evaluation calls.

eval_scenario_id
string | null

The evaluation scenario this call played, for evaluation calls.

eval_run_index
integer | null
eval_temp_sheet_ids
object | null
warnings
object[]

In-call warnings raised on the call's conversation (list endpoint only).

live_monitor
object | null

Only present on GET .../calls?status=ongoing.

assist
object | null

Only present on GET .../calls?status=ongoing; null unless the call's agent is a Voice Assist agent.