Skip to content
RevoxRevox
Get started
API Reference
Call

Get call by ID

client.call.retrieve(stringid, RequestOptionsoptions?): CallRetrieveResponse { call }
GET/call/{id}

Retrieve the full details of a call order by its unique ID. The response includes the call status, call attempts, transcript, recording URL, timestamps, and metadata. Use this endpoint to poll for call completion or inspect results after a call has finished.

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
CallRetrieveResponse { call }
call: Call { id, assignee, assistant, 30 more }

This represent a call “order” that was requested by the user. A call order can be resolved over multiple call attempts spanning up to a few days.

id: string

The ID of the call.

assignee: Assignee | null

The team member responsible for following up on this call.

id: string

The database user id of the assignee.

email: string
first_name: string | null
last_name: string | null
assistant: Assistant | null
id: string
background_sound: "audio/office.ogg" | null

Ambient background sound to play during the call. null disables it.

background_sound_volume: number

Volume of the ambient background sound (0 = silent, 1 = max).

minimum0
maximum1
cal: Cal | null
connection_id: string

The connection ID representing the link between your Cal.com account and Revox.

event_type_id: string

The ID of the Cal.com event type to schedule. (eg: 7081322)

calendly: Calendly | null
connection_id: string

The connection ID representing the link between your Calendly account and Revox.

event_type_id: string

The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

call_retry_config: CallRetryConfig | null

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>

Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.

One of the following:
"monday"
"tuesday"
"wednesday"
"thursday"
"friday"
"saturday"
"sunday"
call_twice_in_a_row: boolean

If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

calling_windows: Array<CallingWindow>
calling_window_end_time: string

End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.

calling_window_start_time: string

Start time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘09:00’, ‘10am’. Default: ‘10:00’.

retry_delay_seconds: unknown

Delay between retry attempts in seconds. Values below the 15-minute minimum are raised to it: a shorter delay means calling someone again minutes after they declined. For one deliberate immediate second dial, use call_twice_in_a_row. Default: 7200 (2 hours).

max_retry_attempts: number

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0
maximum9007199254740991
timezone?: string | null

Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient’s phone number country code. Examples: ‘America/New_York’, ‘Europe/Paris’.

cartesia_dictionary_pronunciation_id: string | null

Optional Cartesia pronunciation dictionary ID linked to this assistant.

created_at: unknown
custom_tools: Array<CustomTool> | null
body_template: string | null

JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values

description: string

Human-readable description of what the tool does, used by the LLM to decide when to call it

minLength1
headers: Array<Header>

HTTP headers to include in the request. Values support {{variable}} placeholders

key: string
minLength1
value: string
input_schema: Array<InputSchema>

Schema defining the parameters the LLM should extract from the conversation to pass to this tool

name: string
minLength1
required: boolean
type: "string" | "number" | "boolean" | 3 more
One of the following:
"string"
"number"
"boolean"
"enum"
"date"
"datetime"
description?: string
enum_options?: Array<string>
method: "GET" | "POST" | "PUT" | 2 more

HTTP method to use when calling the API endpoint

One of the following:
"GET"
"POST"
"PUT"
"PATCH"
"DELETE"
name: string

Unique tool name in lowercase_snake_case (e.g. check_inventory)

minLength1
query_params: Array<QueryParam>

Query string parameters appended to the URL. Values support {{variable}} placeholders

key: string
minLength1
value: string
url: string

Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic values

minLength1
end_of_call_sentence: string | null
first_sentence: string | null
first_sentence_delay_ms: number

Delay in milliseconds before speaking the first sentence. Default: 400.

minimum-9007199254740991
maximum9007199254740991
first_sentence_mode: "generated" | "static" | "none"
One of the following:
"generated"
"static"
"none"
from_phone_number: string | null

Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.

hubspot: Hubspot | null
connection_id: string

The Nango connection ID linking the org’s HubSpot account to Revox.

precall_lookup_enabled: boolean

Resolve the caller against HubSpot contacts before answering an inbound call, filling the contact_* prompt variables (contact_name, contact_owner, contact_lead_status, contact_has_open_deal). Off by default: it costs API calls before the phone is picked up.

post_call_sync?: PostCallSync { enabled, field_mapping }

Sends call data back to HubSpot after the call. Off until set: connecting HubSpot to book meetings must not start writing to the CRM. Always present in responses; omit it on update to leave the current setting untouched.

enabled: boolean

Records calls in HubSpot after they end: the contact is created or updated from the phone number and the call is logged on its timeline. By default every call a person answered is recorded. When the post-call prompt talks about the CRM (in plain words or by mentioning the crm_push_call tool), the post-call agent decides instead which calls are recorded and what the logged call says.

field_mapping: Array<FieldMapping>

Maps extracted call fields (structured_output / prompt variables) onto HubSpot contact properties.

hubspot_property: string

Destination HubSpot contact property, by internal name (e.g. ‘email’, ‘company’, or a custom ‘budget’).

minLength1
source: string

Source key to read from the call: a structured_output field name, falling back to a prompt variable of the same name.

minLength1
human_transfer_mode: "warm" | "cold" | null

Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.

One of the following:
"warm"
"cold"
ivr_navigation_enabled: boolean

Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

krisp_viva_filter_enabled: boolean

When true, the agent’s noise-cancellation filter is Krisp VIVA Tel instead of the legacy BVCTelephony.

llm_model: Recommended { type } | UnionMember1 { name, type } | UnionMember2 { openrouter_model_id, openrouter_provider, type } | 4 more
One of the following:
Recommended { type }
type: "recommended"

The LLM Revox currently recommends for voice agents, chosen server-side and upgraded without any change on your side. No per-assistant configuration.

UnionMember1 { name, type }
name: "gpt-4.1" | "ministral-3-8b-instruct"
One of the following:
"gpt-4.1"
"ministral-3-8b-instruct"
type: "dedicated-instance"
UnionMember2 { openrouter_model_id, openrouter_provider, type }
openrouter_model_id: string

The model ID to use from OpenRouter. eg: openai/gpt-4.1

openrouter_provider: string

The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

type: "openrouter"

Use a model from OpenRouter.

UnionMember3 { api_key, api_url, model_name, type }
api_key: string

API key sent as Bearer token to the custom endpoint.

minLength1
api_url: string

Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1

formaturi
model_name: string

Model name as expected by the provider, e.g. meta-llama/llama-3-70b

minLength1
type: "custom"

OpenAI-compatible chat completions API (bring your own endpoint and key).

Type { type }
type: "gemma-4-31b-racing"

gemma-4-31b raced between two pinned OpenRouter endpoints (modelrun/fp4 and crusoe/bf16), first chunk wins. Served with the server-side OPENROUTER_API_KEY; no per-assistant configuration.

UnionMember5 { model_name, type, reasoning_effort }
model_name: string

Fireworks model id, e.g. accounts/fireworks/models/qwen3-235b-a22b or a dedicated deployment id.

minLength1
type: "fireworks"

Fireworks AI model, served with the server-side FIREWORKS_API_KEY (no key stored per-assistant).

reasoning_effort?: "none" | "low" | "medium" | "high"

Reasoning effort sent with each request. Hybrid-reasoning models (e.g. gemma-4-31b) think by default, which adds latency and can eat the whole token budget before any speakable text: voice agents want ‘none’. Omit for models that reject the knob.

One of the following:
"none"
"low"
"medium"
"high"
UnionMember6 { provider, realtime_model_id, type, realtime_voice_id }
provider: "openai" | "google"

The provider to use from Realtime. eg: openai, google.

One of the following:
"openai"
"google"
realtime_model_id: string

The model ID to use from Realtime. eg: gpt-4.1

type: "realtime"

Use a model from Realtime.

realtime_voice_id?: string

Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).

minLength1
logo_url: string | null

Public URL of the brand logo shown on the assistant’s demo page. Null when unset.

max_call_duration_secs: number

The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

max_duration_end_message: string | null

Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.

maxLength150
name: string
organization_id: string
position: Position | null
x: number
y: number
post_call_prompt: string | null
precall_lookup_headers: Array<PrecallLookupHeader> | null

HTTP headers sent with the pre-call lookup request. Null when none are configured.

key: string
maxLength200
value: string
minLength1
maxLength4000
precall_lookup_url: string | null

URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.

prompt: string
slack: Slack | null
channels: Array<Channel>

The Slack channels the post-call agent may post to. It resolves the channel it was told to use against this list and cannot reach any other.

id: string

The Slack channel ID (e.g. ‘C01234567’).

name?: string | null

Human-readable Slack channel name, cached for display in the UI and given to the LLM when the agent prompt routes by channel name.

connection_id: string

The Nango connection ID linking the org’s Slack workspace to Revox.

start_step_name: string | null
structured_output_config: Array<StructuredOutputConfig> | null

The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

name: string
minLength1
required: boolean
type: "string" | "number" | "boolean" | 3 more
One of the following:
"string"
"number"
"boolean"
"enum"
"date"
"datetime"
description?: string
enum_options?: Array<string>
structured_output_prompt: string | null

Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.

stt_bvc_filter_enabled: boolean

When false, the agent transcribes the raw caller track instead of the BVC noise-cancellation output.

stt_context: SttContext | null

Assistant-level speech-to-text context: structured general key/value pairs plus a list of domain terms. Prompt-derived context is merged in without replacing existing entries.

general: Array<General>
key: string
minLength1
value: string
minLength1
terms: Array<string>
stt_endpoint_latency_level: number | null

Soniox endpoint latency adjustment level (0 to 3). Null: Soniox default.

minimum-9007199254740991
maximum9007199254740991
stt_endpoint_sensitivity: number | null

Soniox endpoint sensitivity (-1 to 1). Null: Soniox default.

stt_model: "stt-rt-v4" | "stt-rt-v5"

Transcriber (speech-to-text) model used for the assistant.

One of the following:
"stt-rt-v4"
"stt-rt-v5"
teams: Teams | null
channels: Array<Channel>

The Teams channels the post-call agent may post to. It resolves the channel it was told to use against this list and cannot reach any other.

id: string

The Microsoft Teams channel ID (e.g. ‘19:561fbdbb…@thread.tacv2’).

team_id: string

The ID of the team the channel belongs to. Needed to post.

name?: string | null

Human-readable channel name, cached for display in the UI and given to the LLM when the agent prompt routes by channel name.

team_name?: string | null

Human-readable team name. Channel names repeat across teams (every team has a ‘General’), so the team name is what tells two of them apart.

connection_id: string

The Nango connection ID linking a Microsoft Teams account to Revox. Messages are posted as that account.

thinking_sound: "city-ambience.ogg" | "forest-ambience.ogg" | "office-ambience.ogg" | 4 more | null

Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.

One of the following:
"city-ambience.ogg"
"forest-ambience.ogg"
"office-ambience.ogg"
"crowded-room.ogg"
"keyboard-typing.ogg"
"keyboard-typing2.ogg"
"hold_music.ogg"
thinking_sound_probability: number

Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.

minimum0
maximum1
thinking_sound_volume: number

Volume of the thinking sound (0 = silent, 1 = max).

minimum0
maximum1
transfer_destinations: Array<TransferDestination> | null

Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.

label: string
minLength1
maxLength60
phone_number: string
type: "standalone" | "multi-step" | "sub-assistant"
One of the following:
"standalone"
"multi-step"
"sub-assistant"
updated_at: unknown
voice: Voice | null
id: string

The ID of the voice.

minLength1
provider: "cartesia" | "elevenlabs" | "gradium"

The provider of the voice.

One of the following:
"cartesia"
"elevenlabs"
"gradium"
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"

Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.

One of the following:
"sonic-3"
"sonic-3.5"
"sonic-3.6"
speed?: number

The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2, Gradium 0.6–1.5. Default is 1.0.

minimum0.6
maximum1.5
volume?: number

Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other providers.

minimum0.5
maximum2
voice_languages: Array<VoiceLanguage> | null

Extra languages for a multilingual assistant, each with its own voice. Calls pick one through their language value, else the phone number’s country; other calls use the assistant’s voice.

language: "en" | "fr" | "es" | 5 more

The language contacts are called in with this voice.

One of the following:
"en"
"fr"
"es"
"de"
"it"
"pt"
"ru"
"zh"
voice: Voice { id, provider, model, 2 more }

The voice used for contacts whose language is this language.

id: string

The ID of the voice.

minLength1
provider: "cartesia" | "elevenlabs" | "gradium"

The provider of the voice.

One of the following:
"cartesia"
"elevenlabs"
"gradium"
model?: "sonic-3" | "sonic-3.5" | "sonic-3.6"

Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.

One of the following:
"sonic-3"
"sonic-3.5"
"sonic-3.6"
speed?: number

The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2, Gradium 0.6–1.5. Default is 1.0.

minimum0.6
maximum1.5
volume?: number

Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other providers.

minimum0.5
maximum2
voicemail_message: string | null

If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

warm_transfer_summary_instructions: string | null

Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.

warm_transfer_voice_speed: number | null

Warm transfer only: voice speed of the briefing to the human colleague; null when it follows voice.speed, not configured, or cold transfer.

minimum0.6
maximum1.5
webhook_url: string | null

The webhook URL to call when the call is completed.

zoho: Zoho | null
connection_id: string

The Nango connection ID linking the org’s Zoho CRM account to Revox.

field_mapping: Array<FieldMapping>

Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.

source: string

Source key to read from the call: a structured_output field name, falling back to a prompt variable of the same name.

minLength1
zoho_field: string

Destination Zoho field API name on the upserted record (e.g. ‘Email’, ‘Company’, or a custom ‘Budget__c’).

minLength1
log_call_activity: boolean

When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).

module: string

Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).

minLength1
template?: string | null

Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.

created_by?: CreatedBy | null

The user who created the assistant.

id: string

The database user id of the creator.

email: string
first_name: string | null
last_name: string | null
is_inbound_receptionist?: boolean
is_realestate_assistant?: boolean
call_attempts: Array<CallAttempt>

All call attempts for this call order, ordered by most recent first.

id: string

The ID of the call attempt.

answered_at: unknown

The time the call was answered.

dial_error: "number_non_attributed" | "too_many_calls" | "busy" | 7 more | null

The SIP error that occurred.

One of the following:
"number_non_attributed"
"too_many_calls"
"busy"
"temporarily_unavailable"
"no_answer"
"rejected"
"blocked"
"no_international_permission"
"precondition_failed"
"non_classified_error"
ended_at: unknown

The time the call ended.

handled_by_ai: boolean

Whether the AI agent conducted the conversation on this attempt. False for a silent speed-dial probe (whose agent only detects a human) and for attempts that were never answered.

handled_by_human: boolean

Whether a human conducted (part of) this attempt — a jump-in / speed-dial takeover, or a transfer to a rep.

handled_by_user: HandledByUser | null

The team member responsible for following up on this call.

id: string

The database user id of the assignee.

email: string
first_name: string | null
last_name: string | null
phone_number: string

The phone number that was called. Formatted in E.164 format. Example: +1234567890

recording_url: string | null

The URL of the audio recording of the call.

result: "IVR" | "voicemail" | "human" | 2 more | null
One of the following:
"IVR"
"voicemail"
"human"
"unknown"
"screening-filter"
started_at: unknown

The time the call started.

status: "queued" | "ringing" | "ongoing" | 2 more

The status of the call attempt.

One of the following:
"queued"
"ringing"
"ongoing"
"completed"
"error"
actions?: Array<Action> | null

Tools the agent ran for this attempt, in call and after it, ordered oldest first. This is the decision trail — the delivery trail lives in sms_log / email_log.

id: string
arguments: Record<string, unknown>
created_at: unknown

When the tool ran.

error: string | null
phase: "in_call" | "post_call"
One of the following:
"in_call"
"post_call"
status: "succeeded" | "failed"
One of the following:
"succeeded"
"failed"
tool_name: string
assistant_names?: Record<string, string>

Names of the assistants in assistants_used, keyed by id. Only set when the attempt went through several assistants (a multi-step call).

assistants_used?: Array<string> | null

Assistant node ids entered during this attempt, in traversal order.

email_log?: Array<EmailLog> | null

Notification emails sent in connection with the call, ordered oldest first (from/to addresses, subject, sent time).

id: string
calendar_invite_at: unknown

Start of the callback or meeting the attached calendar invitation (invite.ics) was for. Null when the email carried no invitation.

created_at: unknown

When the email was sent.

from_address: string
resend_message_id: string | null
subject: string
to_emails: Array<string>
end_reason?: "client_initiated" | "connection_timeout" | "human_takeover" | 13 more | null

Reason for ending the call when ended_by is ‘agent’. E.g. ‘tool_end_call’, ‘voicemail’, ‘transfer’, ‘ivr_no_navigate’.

One of the following:
"client_initiated"
"connection_timeout"
"human_takeover"
"ivr_no_navigate"
"max_duration"
"participant_removed"
"tool_end_call"
"transfer"
"user_inactive"
"user_rejected"
"user_unavailable"
"voicemail"
"speed_dial_abandoned"
"speed_dial_operator_missed"
"speed_dial_timeout"
"speed_dial_hangup"
ended_by?: "agent" | "user" | "system" | null

Who ended the call: ‘agent’ (AI agent), ‘user’ (caller/callee hung up), or ‘system’ (e.g. max duration limit).

One of the following:
"agent"
"user"
"system"
post_call_transcript?: Array<PostCallTranscript> | null

Higher-quality transcript generated after the call via Soniox async STT. Null until generated or when no recording is available.

content: string
role: "user" | "assistant" | "human_agent" | "tool"
One of the following:
"user"
"assistant"
"human_agent"
"tool"
tool_arguments?: Record<string, unknown> | string
One of the following:
Record<string, unknown>
string
tool_is_error?: boolean
tool_name?: string
tool_output?: string
sms_log?: Array<SMSLog> | null

Automatic SMS sent after the call (voicemail and after-call), ordered oldest first. The in-call send_sms is excluded — it already appears in the transcript as a tool call.

id: string
created_at: unknown

When the SMS was sent.

message_body: string
provider: "twilio" | "vonage"
One of the following:
"twilio"
"vonage"
provider_error_code: string | null

The provider’s numeric reason for a terminal failure (e.g. Twilio 30034). Null unless the message failed.

provider_message_id: string | null
provider_status: string | null

Delivery status in the provider’s own vocabulary (Twilio queued/sent/delivered/failed/undelivered), so only interpretable alongside provider. Null when the provider hasn’t reported one — always the case for Vonage, whose receipts we don’t yet parse.

to_phone_number: string
type: "in_call" | "voicemail" | "after_call"
One of the following:
"in_call"
"voicemail"
"after_call"
speech_events?: Array<SpeechEvent> | null

Per-turn speech segments (VAD-derived) with timing and pipeline latencies, ordered by started_speaking_at_ms. Empty for calls recorded before this was tracked or for realtime sessions that don’t emit them.

id: string
is_real_turn: boolean

False when the segment was flagged as noise/blip rather than a meaningful turn.

llm_system_prompt: string | null

Agent-only: despite the name, the whole prompt the LLM was given for this turn — system instructions plus conversation history — as JSON.

llm_ttft_ms: number | null

Agent-only: LLM time-to-first-token for the reply, in ms.

llm_winner_model: string | null

Agent-only: the model that produced the reply — the winning leg when the LLM is a race, which is also the model llm_ttft_ms describes.

speaker: "user" | "agent"

Who was speaking during this segment.

One of the following:
"user"
"agent"
started_speaking_at_ms: number

Milliseconds since session start when speech began.

stopped_speaking_at_ms: number | null

Milliseconds since session start when speech ended. Null when the session ended before the turn closed.

stt_transcription_delay_ms: number | null

User-only: time from end-of-speech to final transcript, in ms.

transcript: string | null

Recognized text for this segment, when available.

tts_ttfb_ms: number | null

Agent-only: TTS time-to-first-audio-byte for the reply, in ms.

was_cut: boolean | null

Agent-only: true when the agent’s audio was interrupted (real or auto-resumed). Null on user segments.

structured_output?: Record<string, unknown> | null

The data extracted from the call, using the structured output config from the parent call object.

transcript?: Array<Transcript> | null

The live transcript of the call, built in real time.

content: string
role: "user" | "assistant" | "human_agent" | "tool"
One of the following:
"user"
"assistant"
"human_agent"
"tool"
tool_arguments?: Record<string, unknown> | string
One of the following:
Record<string, unknown>
string
tool_is_error?: boolean
tool_name?: string
tool_output?: string
transferred_to?: string | null

The number the call was transferred to, in E.164 format (e.g. +33123456789). Recorded by the agent from the destination it actually dialled, so it is the destination itself and not a name read off the transcript. Null when the call was not transferred, and on transfers placed before this was tracked.

call_retry_config: CallRetryConfig | null

Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

allowed_days: Array<"monday" | "tuesday" | "wednesday" | 4 more>

Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.

One of the following:
"monday"
"tuesday"
"wednesday"
"thursday"
"friday"
"saturday"
"sunday"
call_twice_in_a_row: boolean

If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn’t reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

calling_windows: Array<CallingWindow>
calling_window_end_time: string

End time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘17:00’, ‘6pm’. Default: ‘18:00’.

calling_window_start_time: string

Start time for the calling window in the recipient’s timezone (or timezone_override if provided). Format: ‘HH:mm’ (24-hour) or ‘H:mma’ (12-hour). Examples: ‘09:00’, ‘10am’. Default: ‘10:00’.

retry_delay_seconds: unknown

Delay between retry attempts in seconds. Values below the 15-minute minimum are raised to it: a shorter delay means calling someone again minutes after they declined. For one deliberate immediate second dial, use call_twice_in_a_row. Default: 7200 (2 hours).

max_retry_attempts: number

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0
maximum9007199254740991
timezone?: string | null

Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient’s phone number country code. Examples: ‘America/New_York’, ‘Europe/Paris’.

calls_count: number

The number of call attempts made.

campaign: Campaign | null
id: string
name: string
status: "running" | "paused" | "completed"
One of the following:
"running"
"paused"
"completed"
channel: "phone" | "web"

web for a test call taken in the browser: its phone number is a placeholder, never dialed.

One of the following:
"phone"
"web"
contact: Contact { company, email, first_name, 2 more }

Magic contact variables (prospect identity) extracted from the call’s input data and transcript.

company: string | null
email: string | null
first_name: string | null
job_title: string | null
last_name: string | null
created_at: unknown

The time the call order was created.

direction: "inbound" | "outbound"

Whether the call is inbound or outbound.

One of the following:
"inbound"
"outbound"
first_sentence_delay_ms: number

Delay in milliseconds before speaking the first sentence. Default: 400.

minimum-9007199254740991
maximum9007199254740991
from_phone_number: string

The phone number that made the call. Formatted in E.164 format. Example: +1234567890

is_cancelled: boolean

DEPRECATED: Whether the call has been cancelled. This is derived from status. Use status instead.

is_completed: boolean

DEPRECATED: Whether the call has completed. This is derived from status. Use status instead.

last_call_attempt: LastCallAttempt | null

This represent a single call attempt. A call attempt is a single call made to the phone number.

id: string

The ID of the call attempt.

answered_at: unknown

The time the call was answered.

dial_error: "number_non_attributed" | "too_many_calls" | "busy" | 7 more | null

The SIP error that occurred.

One of the following:
"number_non_attributed"
"too_many_calls"
"busy"
"temporarily_unavailable"
"no_answer"
"rejected"
"blocked"
"no_international_permission"
"precondition_failed"
"non_classified_error"
ended_at: unknown

The time the call ended.

handled_by_ai: boolean

Whether the AI agent conducted the conversation on this attempt. False for a silent speed-dial probe (whose agent only detects a human) and for attempts that were never answered.

handled_by_human: boolean

Whether a human conducted (part of) this attempt — a jump-in / speed-dial takeover, or a transfer to a rep.

handled_by_user: HandledByUser | null

The team member responsible for following up on this call.

id: string

The database user id of the assignee.

email: string
first_name: string | null
last_name: string | null
phone_number: string

The phone number that was called. Formatted in E.164 format. Example: +1234567890

recording_url: string | null

The URL of the audio recording of the call.

result: "IVR" | "voicemail" | "human" | 2 more | null
One of the following:
"IVR"
"voicemail"
"human"
"unknown"
"screening-filter"
started_at: unknown

The time the call started.

status: "queued" | "ringing" | "ongoing" | 2 more

The status of the call attempt.

One of the following:
"queued"
"ringing"
"ongoing"
"completed"
"error"
actions?: Array<Action> | null

Tools the agent ran for this attempt, in call and after it, ordered oldest first. This is the decision trail — the delivery trail lives in sms_log / email_log.

id: string
arguments: Record<string, unknown>
created_at: unknown

When the tool ran.

error: string | null
phase: "in_call" | "post_call"
One of the following:
"in_call"
"post_call"
status: "succeeded" | "failed"
One of the following:
"succeeded"
"failed"
tool_name: string
assistant_names?: Record<string, string>

Names of the assistants in assistants_used, keyed by id. Only set when the attempt went through several assistants (a multi-step call).

assistants_used?: Array<string> | null

Assistant node ids entered during this attempt, in traversal order.

email_log?: Array<EmailLog> | null

Notification emails sent in connection with the call, ordered oldest first (from/to addresses, subject, sent time).

id: string
calendar_invite_at: unknown

Start of the callback or meeting the attached calendar invitation (invite.ics) was for. Null when the email carried no invitation.

created_at: unknown

When the email was sent.

from_address: string
resend_message_id: string | null
subject: string
to_emails: Array<string>
end_reason?: "client_initiated" | "connection_timeout" | "human_takeover" | 13 more | null

Reason for ending the call when ended_by is ‘agent’. E.g. ‘tool_end_call’, ‘voicemail’, ‘transfer’, ‘ivr_no_navigate’.

One of the following:
"client_initiated"
"connection_timeout"
"human_takeover"
"ivr_no_navigate"
"max_duration"
"participant_removed"
"tool_end_call"
"transfer"
"user_inactive"
"user_rejected"
"user_unavailable"
"voicemail"
"speed_dial_abandoned"
"speed_dial_operator_missed"
"speed_dial_timeout"
"speed_dial_hangup"
ended_by?: "agent" | "user" | "system" | null

Who ended the call: ‘agent’ (AI agent), ‘user’ (caller/callee hung up), or ‘system’ (e.g. max duration limit).

One of the following:
"agent"
"user"
"system"
post_call_transcript?: Array<PostCallTranscript> | null

Higher-quality transcript generated after the call via Soniox async STT. Null until generated or when no recording is available.

content: string
role: "user" | "assistant" | "human_agent" | "tool"
One of the following:
"user"
"assistant"
"human_agent"
"tool"
tool_arguments?: Record<string, unknown> | string
One of the following:
Record<string, unknown>
string
tool_is_error?: boolean
tool_name?: string
tool_output?: string
sms_log?: Array<SMSLog> | null

Automatic SMS sent after the call (voicemail and after-call), ordered oldest first. The in-call send_sms is excluded — it already appears in the transcript as a tool call.

id: string
created_at: unknown

When the SMS was sent.

message_body: string
provider: "twilio" | "vonage"
One of the following:
"twilio"
"vonage"
provider_error_code: string | null

The provider’s numeric reason for a terminal failure (e.g. Twilio 30034). Null unless the message failed.

provider_message_id: string | null
provider_status: string | null

Delivery status in the provider’s own vocabulary (Twilio queued/sent/delivered/failed/undelivered), so only interpretable alongside provider. Null when the provider hasn’t reported one — always the case for Vonage, whose receipts we don’t yet parse.

to_phone_number: string
type: "in_call" | "voicemail" | "after_call"
One of the following:
"in_call"
"voicemail"
"after_call"
speech_events?: Array<SpeechEvent> | null

Per-turn speech segments (VAD-derived) with timing and pipeline latencies, ordered by started_speaking_at_ms. Empty for calls recorded before this was tracked or for realtime sessions that don’t emit them.

id: string
is_real_turn: boolean

False when the segment was flagged as noise/blip rather than a meaningful turn.

llm_system_prompt: string | null

Agent-only: despite the name, the whole prompt the LLM was given for this turn — system instructions plus conversation history — as JSON.

llm_ttft_ms: number | null

Agent-only: LLM time-to-first-token for the reply, in ms.

llm_winner_model: string | null

Agent-only: the model that produced the reply — the winning leg when the LLM is a race, which is also the model llm_ttft_ms describes.

speaker: "user" | "agent"

Who was speaking during this segment.

One of the following:
"user"
"agent"
started_speaking_at_ms: number

Milliseconds since session start when speech began.

stopped_speaking_at_ms: number | null

Milliseconds since session start when speech ended. Null when the session ended before the turn closed.

stt_transcription_delay_ms: number | null

User-only: time from end-of-speech to final transcript, in ms.

transcript: string | null

Recognized text for this segment, when available.

tts_ttfb_ms: number | null

Agent-only: TTS time-to-first-audio-byte for the reply, in ms.

was_cut: boolean | null

Agent-only: true when the agent’s audio was interrupted (real or auto-resumed). Null on user segments.

structured_output?: Record<string, unknown> | null

The data extracted from the call, using the structured output config from the parent call object.

transcript?: Array<Transcript> | null

The live transcript of the call, built in real time.

content: string
role: "user" | "assistant" | "human_agent" | "tool"
One of the following:
"user"
"assistant"
"human_agent"
"tool"
tool_arguments?: Record<string, unknown> | string
One of the following:
Record<string, unknown>
string
tool_is_error?: boolean
tool_name?: string
tool_output?: string
transferred_to?: string | null

The number the call was transferred to, in E.164 format (e.g. +33123456789). Recorded by the agent from the destination it actually dialled, so it is the destination itself and not a name read off the transcript. Null when the call was not transferred, and on transfers placed before this was tracked.

llm_model: Recommended { type } | UnionMember1 { name, type } | UnionMember2 { openrouter_model_id, openrouter_provider, type } | 4 more
One of the following:
Recommended { type }
type: "recommended"

The LLM Revox currently recommends for voice agents, chosen server-side and upgraded without any change on your side. No per-assistant configuration.

UnionMember1 { name, type }
name: "gpt-4.1" | "ministral-3-8b-instruct"
One of the following:
"gpt-4.1"
"ministral-3-8b-instruct"
type: "dedicated-instance"
UnionMember2 { openrouter_model_id, openrouter_provider, type }
openrouter_model_id: string

The model ID to use from OpenRouter. eg: openai/gpt-4.1

openrouter_provider: string

The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

type: "openrouter"

Use a model from OpenRouter.

UnionMember3 { api_key, api_url, model_name, type }
api_key: string

API key sent as Bearer token to the custom endpoint.

minLength1
api_url: string

Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1

formaturi
model_name: string

Model name as expected by the provider, e.g. meta-llama/llama-3-70b

minLength1
type: "custom"

OpenAI-compatible chat completions API (bring your own endpoint and key).

Type { type }
type: "gemma-4-31b-racing"

gemma-4-31b raced between two pinned OpenRouter endpoints (modelrun/fp4 and crusoe/bf16), first chunk wins. Served with the server-side OPENROUTER_API_KEY; no per-assistant configuration.

UnionMember5 { model_name, type, reasoning_effort }
model_name: string

Fireworks model id, e.g. accounts/fireworks/models/qwen3-235b-a22b or a dedicated deployment id.

minLength1
type: "fireworks"

Fireworks AI model, served with the server-side FIREWORKS_API_KEY (no key stored per-assistant).

reasoning_effort?: "none" | "low" | "medium" | "high"

Reasoning effort sent with each request. Hybrid-reasoning models (e.g. gemma-4-31b) think by default, which adds latency and can eat the whole token budget before any speakable text: voice agents want ‘none’. Omit for models that reject the knob.

One of the following:
"none"
"low"
"medium"
"high"
UnionMember6 { provider, realtime_model_id, type, realtime_voice_id }
provider: "openai" | "google"

The provider to use from Realtime. eg: openai, google.

One of the following:
"openai"
"google"
realtime_model_id: string

The model ID to use from Realtime. eg: gpt-4.1

type: "realtime"

Use a model from Realtime.

realtime_voice_id?: string

Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).

minLength1
metadata: Record<string, string> | null

Metadata stored with the call.

organization_id: string

The ID of the organization that owns the call.

prompt_variables: Record<string, string> | null

Variables used to interpolate the prompt.

retries_stopped: boolean

Whether no further attempt will be made for this call: it was cancelled, or its future attempts were stopped while an attempt was already in progress (that attempt still finishes). Unlike is_cancelled, this is true as soon as retries are stopped, before the call reaches a terminal status.

scheduled_at: unknown

The time the call order is scheduled to start.

status: "initializing" | "queued_for_calling" | "calling" | 7 more

The status of the call.

One of the following:
"initializing"
"queued_for_calling"
"calling"
"post_processing"
"not_launched"
"scheduled"
"paused"
"completed"
"cancelled"
"errored"
to_phone_number: string

The phone number that received the call. Formatted in E.164 format. Example: +1234567890

transfer_destinations: Array<TransferDestination> | null

Where this call can be transferred, if anywhere.

label: string
minLength1
maxLength60
phone_number: string
updated_at: unknown

The time the call order was last updated (any state change, retry, or analysis result).

callback_from?: CallbackFrom | null

For an inbound call only: the outbound call this one answers, when the prospect rang us back after we called them. Null for every other call.

call_id: string
created_at: unknown
cancel_reason?: "prospect_called_back" | null

Why the call was cancelled, when it can be told. prospect_called_back: the prospect called back before the next retry, so the pending retry was cancelled and their call is recorded as a separate inbound call. Null for a manual or campaign cancel, and for calls that are not cancelled.

do_not_call?: boolean

True when the prospect’s phone number is on the do-not-call list: it can no longer be called.

outcome?: "not_interested" | "interested" | "completed" | "requested_callback_later" | null

Business outcome of the call. Null if not computed or no transcript.

One of the following:
"not_interested"
"interested"
"completed"
"requested_callback_later"
outcome_summary?: string | null

LLM explanation for the outcome, when outcome was computed from the transcript.

prompt_version?: PromptVersion | null

The assistant prompt version the call’s prompt was compiled from. Null for calls created before versions were tracked, and for calls made with an inline assistant.

id: string

The ID of the assistant prompt version.

latest_number: number

The number of the assistant’s current prompt version. Higher than number when the call was left on an older version, e.g. because it lacks a variable the newer prompt uses.

minimum-9007199254740991
maximum9007199254740991
number: number

The version’s number in the assistant’s prompt history (v1 is the oldest).

minimum-9007199254740991
maximum9007199254740991
visual_number?: number | null

Campaign-scoped display number for the call (“#14” on the live campaign board), assigned when a human answers. Null outside campaigns or before a human picked up. Gaps are normal.

minimum-9007199254740991
maximum9007199254740991

Get call by ID

import Revox from '@revoxai/sdk';

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

const call = await client.call.retrieve('id');

console.log(call.call);
{
  "call": {
    "id": "id",
    "assignee": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "assistant": {
      "id": "id",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "cal": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "calendly": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "call_retry_config": {
        "allowed_days": [
          "monday"
        ],
        "call_twice_in_a_row": true,
        "calling_windows": [
          {
            "calling_window_end_time": "calling_window_end_time",
            "calling_window_start_time": "calling_window_start_time",
            "retry_delay_seconds": {}
          }
        ],
        "max_retry_attempts": 1,
        "timezone": "timezone"
      },
      "cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
      "created_at": {},
      "custom_tools": [
        {
          "body_template": "body_template",
          "description": "x",
          "headers": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "input_schema": [
            {
              "name": "x",
              "required": true,
              "type": "string",
              "description": "description",
              "enum_options": [
                "string"
              ]
            }
          ],
          "method": "GET",
          "name": "name",
          "query_params": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "url": "x"
        }
      ],
      "end_of_call_sentence": "end_of_call_sentence",
      "first_sentence": "first_sentence",
      "first_sentence_delay_ms": -9007199254740991,
      "first_sentence_mode": "generated",
      "from_phone_number": "from_phone_number",
      "hubspot": {
        "connection_id": "connection_id",
        "meeting_links": [
          {
            "booking_url": "booking_url",
            "duration_ms": 1,
            "is_fallback": true,
            "label": "x",
            "slug": "x"
          }
        ],
        "precall_lookup_enabled": true,
        "post_call_sync": {
          "enabled": true,
          "field_mapping": [
            {
              "hubspot_property": "x",
              "source": "x"
            }
          ]
        }
      },
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "krisp_viva_filter_enabled": true,
      "llm_model": {
        "type": "recommended"
      },
      "logo_url": "logo_url",
      "max_call_duration_secs": 0,
      "max_duration_end_message": "max_duration_end_message",
      "name": "name",
      "organization_id": "organization_id",
      "position": {
        "x": 0,
        "y": 0
      },
      "post_call_prompt": "post_call_prompt",
      "precall_lookup_headers": [
        {
          "key": "key",
          "value": "x"
        }
      ],
      "precall_lookup_url": "precall_lookup_url",
      "prompt": "prompt",
      "slack": {
        "channels": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "connection_id": "connection_id"
      },
      "start_step_name": "start_step_name",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_bvc_filter_enabled": true,
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_endpoint_latency_level": -9007199254740991,
      "stt_endpoint_sensitivity": 0,
      "stt_model": "stt-rt-v4",
      "teams": {
        "channels": [
          {
            "id": "id",
            "team_id": "team_id",
            "name": "name",
            "team_name": "team_name"
          }
        ],
        "connection_id": "connection_id"
      },
      "thinking_sound": "city-ambience.ogg",
      "thinking_sound_probability": 0,
      "thinking_sound_volume": 0,
      "transfer_destinations": [
        {
          "label": "x",
          "phone_number": "phone_number"
        }
      ],
      "type": "standalone",
      "updated_at": {},
      "voice": {
        "id": "x",
        "provider": "cartesia",
        "model": "sonic-3",
        "speed": 0.6,
        "volume": 0.5
      },
      "voice_languages": [
        {
          "language": "en",
          "voice": {
            "id": "x",
            "provider": "cartesia",
            "model": "sonic-3",
            "speed": 0.6,
            "volume": 0.5
          }
        }
      ],
      "voicemail_message": "voicemail_message",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "warm_transfer_voice_speed": 0.6,
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true
    },
    "call_attempts": [
      {
        "id": "id",
        "answered_at": {},
        "dial_error": "number_non_attributed",
        "ended_at": {},
        "handled_by_ai": true,
        "handled_by_human": true,
        "handled_by_user": {
          "id": "id",
          "email": "email",
          "first_name": "first_name",
          "last_name": "last_name"
        },
        "phone_number": "phone_number",
        "recording_url": "recording_url",
        "result": "IVR",
        "started_at": {},
        "status": "queued",
        "actions": [
          {
            "id": "id",
            "arguments": {
              "foo": "bar"
            },
            "created_at": {},
            "error": "error",
            "phase": "in_call",
            "status": "succeeded",
            "tool_name": "tool_name"
          }
        ],
        "assistant_names": {
          "foo": "string"
        },
        "assistants_used": [
          "string"
        ],
        "email_log": [
          {
            "id": "id",
            "calendar_invite_at": {},
            "created_at": {},
            "from_address": "from_address",
            "resend_message_id": "resend_message_id",
            "subject": "subject",
            "to_emails": [
              "string"
            ]
          }
        ],
        "end_reason": "client_initiated",
        "ended_by": "agent",
        "post_call_transcript": [
          {
            "content": "content",
            "role": "user",
            "tool_arguments": {
              "foo": "bar"
            },
            "tool_is_error": true,
            "tool_name": "tool_name",
            "tool_output": "tool_output"
          }
        ],
        "sms_log": [
          {
            "id": "id",
            "created_at": {},
            "message_body": "message_body",
            "provider": "twilio",
            "provider_error_code": "provider_error_code",
            "provider_message_id": "provider_message_id",
            "provider_status": "provider_status",
            "to_phone_number": "to_phone_number",
            "type": "in_call"
          }
        ],
        "speech_events": [
          {
            "id": "id",
            "is_real_turn": true,
            "llm_system_prompt": "llm_system_prompt",
            "llm_ttft_ms": 0,
            "llm_winner_model": "llm_winner_model",
            "speaker": "user",
            "started_speaking_at_ms": 0,
            "stopped_speaking_at_ms": 0,
            "stt_transcription_delay_ms": 0,
            "transcript": "transcript",
            "tts_ttfb_ms": 0,
            "was_cut": true
          }
        ],
        "structured_output": {
          "foo": "bar"
        },
        "transcript": [
          {
            "content": "content",
            "role": "user",
            "tool_arguments": {
              "foo": "bar"
            },
            "tool_is_error": true,
            "tool_name": "tool_name",
            "tool_output": "tool_output"
          }
        ],
        "transferred_to": "transferred_to"
      }
    ],
    "call_retry_config": {
      "allowed_days": [
        "monday"
      ],
      "call_twice_in_a_row": true,
      "calling_windows": [
        {
          "calling_window_end_time": "calling_window_end_time",
          "calling_window_start_time": "calling_window_start_time",
          "retry_delay_seconds": {}
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "calls_count": 0,
    "campaign": {
      "id": "id",
      "name": "name",
      "status": "running"
    },
    "channel": "phone",
    "contact": {
      "company": "company",
      "email": "email",
      "first_name": "first_name",
      "job_title": "job_title",
      "last_name": "last_name"
    },
    "created_at": {},
    "direction": "inbound",
    "first_sentence_delay_ms": -9007199254740991,
    "from_phone_number": "from_phone_number",
    "is_cancelled": true,
    "is_completed": true,
    "last_call_attempt": {
      "id": "id",
      "answered_at": {},
      "dial_error": "number_non_attributed",
      "ended_at": {},
      "handled_by_ai": true,
      "handled_by_human": true,
      "handled_by_user": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "phone_number": "phone_number",
      "recording_url": "recording_url",
      "result": "IVR",
      "started_at": {},
      "status": "queued",
      "actions": [
        {
          "id": "id",
          "arguments": {
            "foo": "bar"
          },
          "created_at": {},
          "error": "error",
          "phase": "in_call",
          "status": "succeeded",
          "tool_name": "tool_name"
        }
      ],
      "assistant_names": {
        "foo": "string"
      },
      "assistants_used": [
        "string"
      ],
      "email_log": [
        {
          "id": "id",
          "calendar_invite_at": {},
          "created_at": {},
          "from_address": "from_address",
          "resend_message_id": "resend_message_id",
          "subject": "subject",
          "to_emails": [
            "string"
          ]
        }
      ],
      "end_reason": "client_initiated",
      "ended_by": "agent",
      "post_call_transcript": [
        {
          "content": "content",
          "role": "user",
          "tool_arguments": {
            "foo": "bar"
          },
          "tool_is_error": true,
          "tool_name": "tool_name",
          "tool_output": "tool_output"
        }
      ],
      "sms_log": [
        {
          "id": "id",
          "created_at": {},
          "message_body": "message_body",
          "provider": "twilio",
          "provider_error_code": "provider_error_code",
          "provider_message_id": "provider_message_id",
          "provider_status": "provider_status",
          "to_phone_number": "to_phone_number",
          "type": "in_call"
        }
      ],
      "speech_events": [
        {
          "id": "id",
          "is_real_turn": true,
          "llm_system_prompt": "llm_system_prompt",
          "llm_ttft_ms": 0,
          "llm_winner_model": "llm_winner_model",
          "speaker": "user",
          "started_speaking_at_ms": 0,
          "stopped_speaking_at_ms": 0,
          "stt_transcription_delay_ms": 0,
          "transcript": "transcript",
          "tts_ttfb_ms": 0,
          "was_cut": true
        }
      ],
      "structured_output": {
        "foo": "bar"
      },
      "transcript": [
        {
          "content": "content",
          "role": "user",
          "tool_arguments": {
            "foo": "bar"
          },
          "tool_is_error": true,
          "tool_name": "tool_name",
          "tool_output": "tool_output"
        }
      ],
      "transferred_to": "transferred_to"
    },
    "llm_model": {
      "type": "recommended"
    },
    "metadata": {
      "foo": "string"
    },
    "organization_id": "organization_id",
    "prompt_variables": {
      "foo": "string"
    },
    "retries_stopped": true,
    "scheduled_at": {},
    "status": "initializing",
    "to_phone_number": "to_phone_number",
    "transfer_destinations": [
      {
        "label": "x",
        "phone_number": "phone_number"
      }
    ],
    "updated_at": {},
    "callback_from": {
      "call_id": "call_id",
      "created_at": {}
    },
    "cancel_reason": "prospect_called_back",
    "do_not_call": true,
    "outcome": "not_interested",
    "outcome_summary": "outcome_summary",
    "prompt_version": {
      "id": "id",
      "latest_number": -9007199254740991,
      "number": -9007199254740991
    },
    "visual_number": -9007199254740991
  }
}
Returns Examples
{
  "call": {
    "id": "id",
    "assignee": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "assistant": {
      "id": "id",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "cal": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "calendly": {
        "connection_id": "connection_id",
        "event_type_id": "event_type_id"
      },
      "call_retry_config": {
        "allowed_days": [
          "monday"
        ],
        "call_twice_in_a_row": true,
        "calling_windows": [
          {
            "calling_window_end_time": "calling_window_end_time",
            "calling_window_start_time": "calling_window_start_time",
            "retry_delay_seconds": {}
          }
        ],
        "max_retry_attempts": 1,
        "timezone": "timezone"
      },
      "cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
      "created_at": {},
      "custom_tools": [
        {
          "body_template": "body_template",
          "description": "x",
          "headers": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "input_schema": [
            {
              "name": "x",
              "required": true,
              "type": "string",
              "description": "description",
              "enum_options": [
                "string"
              ]
            }
          ],
          "method": "GET",
          "name": "name",
          "query_params": [
            {
              "key": "x",
              "value": "value"
            }
          ],
          "url": "x"
        }
      ],
      "end_of_call_sentence": "end_of_call_sentence",
      "first_sentence": "first_sentence",
      "first_sentence_delay_ms": -9007199254740991,
      "first_sentence_mode": "generated",
      "from_phone_number": "from_phone_number",
      "hubspot": {
        "connection_id": "connection_id",
        "meeting_links": [
          {
            "booking_url": "booking_url",
            "duration_ms": 1,
            "is_fallback": true,
            "label": "x",
            "slug": "x"
          }
        ],
        "precall_lookup_enabled": true,
        "post_call_sync": {
          "enabled": true,
          "field_mapping": [
            {
              "hubspot_property": "x",
              "source": "x"
            }
          ]
        }
      },
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "krisp_viva_filter_enabled": true,
      "llm_model": {
        "type": "recommended"
      },
      "logo_url": "logo_url",
      "max_call_duration_secs": 0,
      "max_duration_end_message": "max_duration_end_message",
      "name": "name",
      "organization_id": "organization_id",
      "position": {
        "x": 0,
        "y": 0
      },
      "post_call_prompt": "post_call_prompt",
      "precall_lookup_headers": [
        {
          "key": "key",
          "value": "x"
        }
      ],
      "precall_lookup_url": "precall_lookup_url",
      "prompt": "prompt",
      "slack": {
        "channels": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "connection_id": "connection_id"
      },
      "start_step_name": "start_step_name",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_bvc_filter_enabled": true,
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_endpoint_latency_level": -9007199254740991,
      "stt_endpoint_sensitivity": 0,
      "stt_model": "stt-rt-v4",
      "teams": {
        "channels": [
          {
            "id": "id",
            "team_id": "team_id",
            "name": "name",
            "team_name": "team_name"
          }
        ],
        "connection_id": "connection_id"
      },
      "thinking_sound": "city-ambience.ogg",
      "thinking_sound_probability": 0,
      "thinking_sound_volume": 0,
      "transfer_destinations": [
        {
          "label": "x",
          "phone_number": "phone_number"
        }
      ],
      "type": "standalone",
      "updated_at": {},
      "voice": {
        "id": "x",
        "provider": "cartesia",
        "model": "sonic-3",
        "speed": 0.6,
        "volume": 0.5
      },
      "voice_languages": [
        {
          "language": "en",
          "voice": {
            "id": "x",
            "provider": "cartesia",
            "model": "sonic-3",
            "speed": 0.6,
            "volume": 0.5
          }
        }
      ],
      "voicemail_message": "voicemail_message",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "warm_transfer_voice_speed": 0.6,
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true
    },
    "call_attempts": [
      {
        "id": "id",
        "answered_at": {},
        "dial_error": "number_non_attributed",
        "ended_at": {},
        "handled_by_ai": true,
        "handled_by_human": true,
        "handled_by_user": {
          "id": "id",
          "email": "email",
          "first_name": "first_name",
          "last_name": "last_name"
        },
        "phone_number": "phone_number",
        "recording_url": "recording_url",
        "result": "IVR",
        "started_at": {},
        "status": "queued",
        "actions": [
          {
            "id": "id",
            "arguments": {
              "foo": "bar"
            },
            "created_at": {},
            "error": "error",
            "phase": "in_call",
            "status": "succeeded",
            "tool_name": "tool_name"
          }
        ],
        "assistant_names": {
          "foo": "string"
        },
        "assistants_used": [
          "string"
        ],
        "email_log": [
          {
            "id": "id",
            "calendar_invite_at": {},
            "created_at": {},
            "from_address": "from_address",
            "resend_message_id": "resend_message_id",
            "subject": "subject",
            "to_emails": [
              "string"
            ]
          }
        ],
        "end_reason": "client_initiated",
        "ended_by": "agent",
        "post_call_transcript": [
          {
            "content": "content",
            "role": "user",
            "tool_arguments": {
              "foo": "bar"
            },
            "tool_is_error": true,
            "tool_name": "tool_name",
            "tool_output": "tool_output"
          }
        ],
        "sms_log": [
          {
            "id": "id",
            "created_at": {},
            "message_body": "message_body",
            "provider": "twilio",
            "provider_error_code": "provider_error_code",
            "provider_message_id": "provider_message_id",
            "provider_status": "provider_status",
            "to_phone_number": "to_phone_number",
            "type": "in_call"
          }
        ],
        "speech_events": [
          {
            "id": "id",
            "is_real_turn": true,
            "llm_system_prompt": "llm_system_prompt",
            "llm_ttft_ms": 0,
            "llm_winner_model": "llm_winner_model",
            "speaker": "user",
            "started_speaking_at_ms": 0,
            "stopped_speaking_at_ms": 0,
            "stt_transcription_delay_ms": 0,
            "transcript": "transcript",
            "tts_ttfb_ms": 0,
            "was_cut": true
          }
        ],
        "structured_output": {
          "foo": "bar"
        },
        "transcript": [
          {
            "content": "content",
            "role": "user",
            "tool_arguments": {
              "foo": "bar"
            },
            "tool_is_error": true,
            "tool_name": "tool_name",
            "tool_output": "tool_output"
          }
        ],
        "transferred_to": "transferred_to"
      }
    ],
    "call_retry_config": {
      "allowed_days": [
        "monday"
      ],
      "call_twice_in_a_row": true,
      "calling_windows": [
        {
          "calling_window_end_time": "calling_window_end_time",
          "calling_window_start_time": "calling_window_start_time",
          "retry_delay_seconds": {}
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "calls_count": 0,
    "campaign": {
      "id": "id",
      "name": "name",
      "status": "running"
    },
    "channel": "phone",
    "contact": {
      "company": "company",
      "email": "email",
      "first_name": "first_name",
      "job_title": "job_title",
      "last_name": "last_name"
    },
    "created_at": {},
    "direction": "inbound",
    "first_sentence_delay_ms": -9007199254740991,
    "from_phone_number": "from_phone_number",
    "is_cancelled": true,
    "is_completed": true,
    "last_call_attempt": {
      "id": "id",
      "answered_at": {},
      "dial_error": "number_non_attributed",
      "ended_at": {},
      "handled_by_ai": true,
      "handled_by_human": true,
      "handled_by_user": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "phone_number": "phone_number",
      "recording_url": "recording_url",
      "result": "IVR",
      "started_at": {},
      "status": "queued",
      "actions": [
        {
          "id": "id",
          "arguments": {
            "foo": "bar"
          },
          "created_at": {},
          "error": "error",
          "phase": "in_call",
          "status": "succeeded",
          "tool_name": "tool_name"
        }
      ],
      "assistant_names": {
        "foo": "string"
      },
      "assistants_used": [
        "string"
      ],
      "email_log": [
        {
          "id": "id",
          "calendar_invite_at": {},
          "created_at": {},
          "from_address": "from_address",
          "resend_message_id": "resend_message_id",
          "subject": "subject",
          "to_emails": [
            "string"
          ]
        }
      ],
      "end_reason": "client_initiated",
      "ended_by": "agent",
      "post_call_transcript": [
        {
          "content": "content",
          "role": "user",
          "tool_arguments": {
            "foo": "bar"
          },
          "tool_is_error": true,
          "tool_name": "tool_name",
          "tool_output": "tool_output"
        }
      ],
      "sms_log": [
        {
          "id": "id",
          "created_at": {},
          "message_body": "message_body",
          "provider": "twilio",
          "provider_error_code": "provider_error_code",
          "provider_message_id": "provider_message_id",
          "provider_status": "provider_status",
          "to_phone_number": "to_phone_number",
          "type": "in_call"
        }
      ],
      "speech_events": [
        {
          "id": "id",
          "is_real_turn": true,
          "llm_system_prompt": "llm_system_prompt",
          "llm_ttft_ms": 0,
          "llm_winner_model": "llm_winner_model",
          "speaker": "user",
          "started_speaking_at_ms": 0,
          "stopped_speaking_at_ms": 0,
          "stt_transcription_delay_ms": 0,
          "transcript": "transcript",
          "tts_ttfb_ms": 0,
          "was_cut": true
        }
      ],
      "structured_output": {
        "foo": "bar"
      },
      "transcript": [
        {
          "content": "content",
          "role": "user",
          "tool_arguments": {
            "foo": "bar"
          },
          "tool_is_error": true,
          "tool_name": "tool_name",
          "tool_output": "tool_output"
        }
      ],
      "transferred_to": "transferred_to"
    },
    "llm_model": {
      "type": "recommended"
    },
    "metadata": {
      "foo": "string"
    },
    "organization_id": "organization_id",
    "prompt_variables": {
      "foo": "string"
    },
    "retries_stopped": true,
    "scheduled_at": {},
    "status": "initializing",
    "to_phone_number": "to_phone_number",
    "transfer_destinations": [
      {
        "label": "x",
        "phone_number": "phone_number"
      }
    ],
    "updated_at": {},
    "callback_from": {
      "call_id": "call_id",
      "created_at": {}
    },
    "cancel_reason": "prospect_called_back",
    "do_not_call": true,
    "outcome": "not_interested",
    "outcome_summary": "outcome_summary",
    "prompt_version": {
      "id": "id",
      "latest_number": -9007199254740991,
      "number": -9007199254740991
    },
    "visual_number": -9007199254740991
  }
}