Skip to main content

VoiceCallRead

Voice-call metadata attached one-to-one to a dialogue.

dialogue_idDialogue Idrequired

ID of the dialogue (conversation) this record relates to.

external_call_idExternal Call Idrequired

Stable call identifier assigned by the voice runtime.

providerProviderrequired

Voice provider identifier. Public API value is voice.

Constant value: voice
sip_call_id objectrequired

Optional SIP-side call identifier, when the call used SIP.

anyOf
string
sip_code objectrequired

Optional SIP status or termination code reported by the voice runtime.

anyOf
integer
statusStatusrequired

Voice call lifecycle status — active, completed, or failed.

Possible values: [active, completed, failed]

direction objectrequired

Whether the call is inbound or outbound.

anyOf
string

Possible values: [inbound, outbound]

started_atdate-timerequired

When the voice call started (UTC).

ended_at objectrequired

When the voice call ended (UTC), if it has ended.

anyOf
date-time
duration_seconds objectrequired

Total call duration in seconds, if known.

anyOf
integer
recording_s3_key objectrequired

S3 object key for the call recording, if one was produced.

anyOf
string
usage_metadata objectrequired

Free-form usage metrics reported by the voice runtime, for example token, audio, or provider usage counters.

property name*any

Free-form usage metrics reported by the voice runtime, for example token, audio, or provider usage counters.

latency_metadata objectrequired

Free-form latency metrics reported by the voice runtime, for example STT, LLM, TTS, or end-to-end timing.

property name*any

Free-form latency metrics reported by the voice runtime, for example STT, LLM, TTS, or end-to-end timing.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

VoiceCallRead
{
"dialogue_id": 0,
"external_call_id": "string",
"provider": "voice",
"sip_call_id": "string",
"sip_code": 0,
"status": "active",
"direction": "inbound",
"started_at": "2024-07-29T15:51:28.071Z",
"ended_at": "2024-07-29T15:51:28.071Z",
"duration_seconds": 0,
"recording_s3_key": "string",
"usage_metadata": {},
"latency_metadata": {},
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}