Place a call

call.create(**kwargs) -> CallCreateResponse { call }

POST/call

Place a new outbound call order. Provide either an existing assistant ID or a custom assistant configuration. The call can be scheduled for a specific time or started immediately. A single call order may be resolved over multiple call attempts spanning up to a few days, with automatic retries when voicemail is detected. You can also set concurrency limits and pass prompt variables for dynamic personalization.

ParametersExpand Collapse

phone_number: String

The phone number to call in the E.164 format. Example: +1234567890

assistant: { prompt, after_call_sms_outcomes, after_call_sms_prompt, 41 more}

You can provide a custom assistant configuration here. If you don't provide an assistant_id, this assistant object will be used for this call.

prompt: String

The prompt to use for the call. This will be given to the LLM (gpt-4.1)

after_call_sms_outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

after_call_sms_prompt: String

Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.

background_sound: :"audio/office.ogg"

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

background_sound_volume: Float

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

minimum0

maximum1

calendly: { connection_id, event_type_id}

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: { allowed_days, call_twice_in_a_row, calling_windows, 2 more}

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: bool

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[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]

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: Integer

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: Integer

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: String

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

Optional Cartesia pronunciation dictionary ID to use for this assistant's calls. Set null to unlink it.

minLength1

custom_tools: Array[{ body_template, description, headers, 5 more}]

Custom API tools the assistant can call during conversations. Each tool defines an HTTP endpoint with variable substitution.

body_template: String

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[{ key, value}]

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

key: String

minLength1

value: String

input_schema: Array[{ name, required, type, 2 more}]

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

minLength1

required: bool

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

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

minLength1

query_params: Array[{ key, value}]

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

email_notification_address: String

Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

email_notification_outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

end_of_call_sentence: String

Optional message to say when the agent decides to end the call.

faq_items: Array[{ answer, question}]

FAQ items to associate with this assistant. When provided, replaces all existing FAQ items.

answer: String

question: String

first_sentence: String

The first sentence to use for the call. This will be given to the LLM

first_sentence_delay_ms: Integer

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

minimum0

maximum9007199254740991

first_sentence_mode: :generated | :static | :none

How the first sentence should be handled. "generated" means the LLM will generate a response based on the first_sentence instruction. "static" means the first_sentence will be spoken exactly as provided. "none" means the agent will not speak first and will wait for the user.

One of the following:

:generated

:static

:none

from_phone_number: String

Override the default outbound phone number for calls placed with this assistant. Must be a phone number owned by the organization in E.164 format (e.g. +1234567890). When null, the organization's default phone number is used.

human_transfer_mode: :warm | :cold

When transfer_destinations is non-empty: "warm" (AI bridges) or "cold" (SIP REFER; trunk must allow REFER/PSTN). Omit or null when transfer is disabled.

One of the following:

:warm

:cold

ivr_navigation_enabled: bool

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

llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type} | { api_key, api_url, model_name, type} | { provider, realtime_model_id, type, realtime_voice_id}

One of the following:

class UnionMember0 { name, type }

One of the following:

:"gpt-4.1"

:"ministral-3-8b-instruct"

type: :"dedicated-instance"

class UnionMember1 { 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.

class UnionMember2 { 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).

class UnionMember3 { 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

Public URL of the brand logo shown on the assistant's demo page. Upload a new logo via POST /assistants/:id/logo. Set explicitly to null to clear it.

formaturi

max_call_duration_secs: Float

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

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 not set, the call ends silently.

maxLength150

position: { x, y_}

Canvas position of this assistant's node in its multi-step flow editor.

x: Float

y_: Float

precall_lookup_url: String

Inbound calls only. URL fetched over HTTP GET right before the call is answered, with {{phone}} replaced by the caller's number in E.164 format (URL-encoded). It must return {"prompt_variables": {...}} covering every {{variable}} the assistant declares, otherwise the call is errored. Must be an http(s) URL containing {{phone}}. When null, no lookup is performed.

maxLength2000

prompt_flow: { edges, nodes}

Visual prompt constructor data (nodes, edges, positions). Used by the UI to re-open the visual editor. Does not affect call behavior — the flattened prompt field is what the LLM receives.

edges: Array[{ id, source, target}]

id: String

source: String

target: String

nodes: Array[{ id, data, position, type}]

id: String

data: { body, title}

body: String

title: String

position: { x, y_}

x: Float

y_: Float

type: :promptBlock

slack: { channels, connection_id, outcomes, template}

Slack notification config. When set, posts a message to the chosen channel after a call ends with one of the configured outcomes.

channels: Array[{ id, name}]

The Slack channels eligible to receive the notification. When more than one is configured, the agent prompt may define routing rules to narrow it down per call; with no such rules every channel here is notified.

id: String

The Slack channel ID (e.g. 'C01234567').

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.

outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']). Use 'none' to notify when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.

sms_enabled: bool

Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

sms_template: String

Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.

structured_output_config: Array[{ name, required, type, 2 more}]

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.).

minLength1

required: bool

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

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_context: { general, terms}

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[{ key, value}]

key: String

minLength1

value: String

minLength1

terms: Array[String]

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

Transcriber (speech-to-text) model. Defaults to the newest Soniox realtime model when omitted.

One of the following:

:"stt-rt-v4"

:"stt-rt-v5"

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

Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null/omitted 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: Float

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

minimum0

maximum1

thinking_sound_volume: Float

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

minimum0

maximum1

transfer_destinations: Array[{ label, phone_number}]

Where calls can be transferred to when users ask to speak to a human. With a single entry the assistant always transfers there; with several, it picks one at transfer time by applying the routing rules written in the assistant's own prompt (which refer to the destination labels). Empty or null disables transfer.

label: String

Human-meaningful name for this destination (e.g. "Sales"). The assistant's prompt refers to these labels when describing who to transfer to.

minLength1

maxLength60

phone_number: String

Destination phone number in E.164 format (e.g. +1234567890).

type: :standalone | :"multi-step" | :"sub-assistant"

Assistant kind. 'standalone' (default) is a normal assistant, 'multi-step' orchestrates a flow of sub-assistants, 'sub-assistant' is a step inside a multi-step flow (hidden from the assistants list). Flow transitions are managed via the /assistants/:id/edges endpoints, not on the assistant itself.

One of the following:

:standalone

:"multi-step"

:"sub-assistant"

voice: { id, provider, model, 2 more}

The voice to use for the call. You can get the list of voices using the /voices endpoint

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"

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

One of the following:

:"sonic-3"

:"sonic-3.5"

speed: Float

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: Float

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

minimum0.5

maximum2

voicemail_message: String

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

voicemail_sms_prompt: String

SMS message to send when the call reaches voicemail. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.

warm_transfer_summary_instructions: String

When using warm transfer: extra instructions for the supervisor handoff summary. If null or empty, the API uses the product default briefing when the call is loaded for the agent.

webhook_url: String

The webhook URL to call when the call is completed.

zoho: { connection_id, field_mapping, log_call_activity, 3 more}

Zoho CRM integration config. When set, upserts the prospect (keyed on phone) into the chosen module and attaches a Note with the call summary after a call ends with one of the configured outcomes.

connection_id: String

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

field_mapping: Array[{ source, zoho_field}]

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: bool

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

outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'none' to push when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

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.

assistant_id: String

The ID of the assistant to use for this call.

formatuuid

concurrency: { key}

Limit the number of concurrent calls for a given concurrency key. The limit itself is set server-side; omit this to leave the call ungrouped (bounded only by your organization's limit).

key: String

Groups this call with every other call sharing the same key, for concurrency purposes.

from_phone_number: String

The phone number to use for making the call (e.g., +1234567890). If not provided, uses the default trunk.

metadata: Hash[Symbol, String]

Metadata to store with the call.

prompt_variables: Hash[Symbol, String]

Variables to interpolate into the prompt. Wether you use an assistant_id or an assistant object, this will be used to interpolate the variables into the prompt.

scheduled_at: Time | untyped

Schedule the call to start at a specific date and time (ISO 8601 format). If not provided, the call will start immediately.

One of the following:

Time

untyped

skip_calling_window: bool

Bypass the calling-window check for this call so it dials even outside the assistant's configured window. Use for immediate 'call now' dials.

ReturnsExpand Collapse

class CallCreateResponse { call }

call: { id, assignee, assistant, 24 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: { id, email, first_name, last_name}

The team member responsible for following up on this call.

id: String

The database user id of the assignee.

email: String

first_name: String

last_name: String

assistant: { id, after_call_sms_outcomes, after_call_sms_prompt, 50 more}

id: String

after_call_sms_outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use "none" when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

after_call_sms_prompt: String

Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.

background_sound: :"audio/office.ogg"

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

background_sound_volume: Float

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

minimum0

maximum1

calendly: { connection_id, event_type_id}

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: { allowed_days, call_twice_in_a_row, calling_windows, 2 more}

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: bool

calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]

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: Integer

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: Integer

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: String

cartesia_dictionary_pronunciation_id: String

Optional Cartesia pronunciation dictionary ID linked to this assistant.

created_at: untyped

custom_tools: Array[{ body_template, description, headers, 5 more}]

body_template: String

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[{ key, value}]

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

key: String

minLength1

value: String

input_schema: Array[{ name, required, type, 2 more}]

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

minLength1

required: bool

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

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

minLength1

query_params: Array[{ key, value}]

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

email_notification_address: String

Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

email_notification_outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

end_of_call_sentence: String

first_sentence: String

first_sentence_delay_ms: Integer

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

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

human_transfer_mode: :warm | :cold

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: bool

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

llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type} | { api_key, api_url, model_name, type} | { provider, realtime_model_id, type, realtime_voice_id}

One of the following:

class UnionMember0 { name, type }

One of the following:

:"gpt-4.1"

:"ministral-3-8b-instruct"

type: :"dedicated-instance"

class UnionMember1 { 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.

class UnionMember2 { 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).

class UnionMember3 { 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

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

max_call_duration_secs: Float

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

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

organization_id: String

position: { x, y_}

x: Float

y_: Float

precall_lookup_url: String

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

prompt: String

prompt_flow: { edges, nodes}

edges: Array[{ id, source, target}]

id: String

source: String

target: String

nodes: Array[{ id, data, position, type}]

id: String

data: { body, title}

body: String

title: String

position: { x, y_}

x: Float

y_: Float

type: :promptBlock

slack: { channels, connection_id, outcomes, template}

channels: Array[{ id, name}]

id: String

The Slack channel ID (e.g. 'C01234567').

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.

outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']). Use 'none' to notify when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

sms_enabled: bool

Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

sms_template: String

Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.

structured_output_config: Array[{ name, required, type, 2 more}]

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.).

minLength1

required: bool

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

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_context: { general, terms}

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[{ key, value}]

key: String

minLength1

value: String

minLength1

terms: Array[String]

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"

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

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: Float

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

minimum0

maximum1

thinking_sound_volume: Float

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

minimum0

maximum1

transfer_destinations: Array[{ label, phone_number}]

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: untyped

voice: { id, provider, model, 2 more}

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"

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

One of the following:

:"sonic-3"

:"sonic-3.5"

speed: Float

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: Float

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

minimum0.5

maximum2

voicemail_message: String

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

voicemail_sms_prompt: String

Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.

warm_transfer_summary_instructions: String

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

webhook_url: String

The webhook URL to call when the call is completed.

zoho: { connection_id, field_mapping, log_call_activity, 3 more}

connection_id: String

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

field_mapping: Array[{ source, zoho_field}]

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: bool

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

outcomes: Array[:not_interested | :interested | :completed | 2 more]

Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'none' to push when outcome is null.

One of the following:

:not_interested

:interested

:completed

:requested_callback_later

:none

created_by: { id, email, first_name, last_name}

The user who created the assistant.

id: String

The database user id of the creator.

email: String

first_name: String

last_name: String

faq_items: Array[{ answer, question, id, 2 more}]

answer: String

question: String

id: String

needs_human_answer: bool

source: :human | :ai

One of the following:

:human

:ai

is_inbound_receptionist: bool

is_realestate_assistant: bool

pending_faq_count: Float

call_attempts: Array[{ id, answered_at, dial_error, 18 more}]

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

id: String

The ID of the call attempt.

answered_at: untyped

The time the call was answered.

dial_error: :number_non_attributed | :too_many_calls | :busy | 5 more

The SIP error that occurred.

One of the following:

:number_non_attributed

:too_many_calls

:busy

:temporarily_unavailable

:no_answer

:no_international_permission

:precondition_failed

:non_classified_error

ended_at: untyped

The time the call ended.

handled_by_ai: bool

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: bool

Whether a human operator conducted (part of) this attempt — a jump-in takeover or a speed-dial operator connection (both stamp human_takeover_at).

handled_by_user: { id, email, first_name, last_name}

The team member responsible for following up on this call.

id: String

The database user id of the assignee.

email: String

first_name: String

last_name: String

phone_number: String

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

recording_url: String

The URL of the audio recording of the call.

result: :IVR | :voicemail | :human | 2 more

One of the following:

:IVR

:voicemail

:human

:unknown

:"ios-screening-filter"

started_at: untyped

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

assistants_used: Array[String]

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

email_log: Array[{ id, created_at, from_address, 3 more}]

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

id: String

created_at: untyped

When the email was sent.

from_address: String

resend_message_id: String

subject: String

to_emails: Array[String]

end_reason: :client_initiated | :connection_timeout | :human_takeover | 13 more

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

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[{ content, role, tool_arguments, 3 more}]

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: Hash[Symbol, untyped] | String

One of the following:

Hash[Symbol, untyped]

String

tool_is_error: bool

tool_name: String

tool_output: String

sms_log: Array[{ id, created_at, message_body, 3 more}]

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: untyped

When the SMS was sent.

message_body: String

to_phone_number: String

twilio_message_sid: String

type: :in_call | :voicemail | :after_call

One of the following:

:in_call

:voicemail

:after_call

speech_events: Array[{ id, is_real_turn, llm_ttft_ms, 7 more}]

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: bool

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

llm_ttft_ms: Float

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

speaker: :user | :agent

Who was speaking during this segment.

One of the following:

:user

:agent

started_speaking_at_ms: Float

Milliseconds since session start when speech began.

stopped_speaking_at_ms: Float

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

stt_transcription_delay_ms: Float

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

transcript: String

Recognized text for this segment, when available.

tts_ttfb_ms: Float

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

was_cut: bool

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

structured_output: Hash[Symbol, untyped]

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

transcript: Array[{ content, role, tool_arguments, 3 more}]

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: Hash[Symbol, untyped] | String

One of the following:

Hash[Symbol, untyped]

String

tool_is_error: bool

tool_name: String

tool_output: String

call_retry_config: { allowed_days, call_twice_in_a_row, calling_windows, 2 more}

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: bool

calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]

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: Integer

Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

minimum0

maximum9007199254740991

max_retry_attempts: Integer

Maximum number of call retry attempts. Default: 3.

exclusiveMinimum0

maximum9007199254740991

timezone: String

calls_count: Float

The number of call attempts made.

campaign: { id, name}

id: String

contact: { company, email, first_name, 2 more}

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

company: String

email: String

first_name: String

job_title: String

last_name: String

created_at: untyped

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: Integer

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: bool

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

is_completed: bool

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

last_call_attempt: { id, answered_at, dial_error, 18 more}

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: untyped

The time the call was answered.

dial_error: :number_non_attributed | :too_many_calls | :busy | 5 more

The SIP error that occurred.

One of the following:

:number_non_attributed

:too_many_calls

:busy

:temporarily_unavailable

:no_answer

:no_international_permission

:precondition_failed

:non_classified_error

ended_at: untyped

The time the call ended.

handled_by_ai: bool

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: bool

Whether a human operator conducted (part of) this attempt — a jump-in takeover or a speed-dial operator connection (both stamp human_takeover_at).

handled_by_user: { id, email, first_name, last_name}

The team member responsible for following up on this call.

id: String

The database user id of the assignee.

email: String

first_name: String

last_name: String

phone_number: String

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

recording_url: String

The URL of the audio recording of the call.

result: :IVR | :voicemail | :human | 2 more

One of the following:

:IVR

:voicemail

:human

:unknown

:"ios-screening-filter"

started_at: untyped

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

assistants_used: Array[String]

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

email_log: Array[{ id, created_at, from_address, 3 more}]

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

id: String

created_at: untyped

When the email was sent.

from_address: String

resend_message_id: String

subject: String

to_emails: Array[String]

end_reason: :client_initiated | :connection_timeout | :human_takeover | 13 more

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

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[{ content, role, tool_arguments, 3 more}]

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: Hash[Symbol, untyped] | String

One of the following:

Hash[Symbol, untyped]

String

tool_is_error: bool

tool_name: String

tool_output: String

sms_log: Array[{ id, created_at, message_body, 3 more}]

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: untyped

When the SMS was sent.

message_body: String

to_phone_number: String

twilio_message_sid: String

type: :in_call | :voicemail | :after_call

One of the following:

:in_call

:voicemail

:after_call

speech_events: Array[{ id, is_real_turn, llm_ttft_ms, 7 more}]

id: String

is_real_turn: bool

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

llm_ttft_ms: Float

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

speaker: :user | :agent

Who was speaking during this segment.

One of the following:

:user

:agent

started_speaking_at_ms: Float

Milliseconds since session start when speech began.

stopped_speaking_at_ms: Float

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

stt_transcription_delay_ms: Float

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

transcript: String

Recognized text for this segment, when available.

tts_ttfb_ms: Float

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

was_cut: bool

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

structured_output: Hash[Symbol, untyped]

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

transcript: Array[{ content, role, tool_arguments, 3 more}]

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: Hash[Symbol, untyped] | String

One of the following:

Hash[Symbol, untyped]

String

tool_is_error: bool

tool_name: String

tool_output: String

llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type} | { api_key, api_url, model_name, type} | { provider, realtime_model_id, type, realtime_voice_id}

One of the following:

class UnionMember0 { name, type }

One of the following:

:"gpt-4.1"

:"ministral-3-8b-instruct"

type: :"dedicated-instance"

class UnionMember1 { 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.

class UnionMember2 { 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).

class UnionMember3 { 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: Hash[Symbol, String]

Metadata stored with the call.

organization_id: String

The ID of the organization that owns the call.

prompt_variables: Hash[Symbol, String]

Variables used to interpolate the prompt.

scheduled_at: untyped

The time the call order is scheduled to start.

status: :initializing | :queued_for_calling | :calling | 6 more

The status of the call.

One of the following:

:initializing

:queued_for_calling

:calling

:post_processing

:scheduled

:paused

:completed

:cancelled

:errored

to_phone_number: String

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

updated_at: untyped

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

follow_up_emails: Array[String]

Extra notification recipients resolved from the agent prompt's own routing rules, when it defines any. Added to the assistant's configured notification recipients; never replaces them. Null when the prompt defines no routing rules.

outcome: :not_interested | :interested | :completed | :requested_callback_later

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

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

slack_channel_ids: Array[String]

Slack channels resolved from the agent prompt's own routing rules, when it defines any. Always a subset of the channels configured on the assistant. Null when the prompt defines no routing rules, in which case every configured channel is notified.

Place a call

require "revox"

revox = Revox::Client.new(api_key: "My API Key")

call = revox.call.create(phone_number: "phone_number")

puts(call)

{
  "call": {
    "id": "id",
    "assignee": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "assistant": {
      "id": "id",
      "after_call_sms_outcomes": [
        "not_interested"
      ],
      "after_call_sms_prompt": "after_call_sms_prompt",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "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": 0
          }
        ],
        "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"
        }
      ],
      "email_notification_address": "email_notification_address",
      "email_notification_outcomes": [
        "not_interested"
      ],
      "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",
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "llm_model": {
        "name": "gpt-4.1",
        "type": "dedicated-instance"
      },
      "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
      },
      "precall_lookup_url": "precall_lookup_url",
      "prompt": "prompt",
      "prompt_flow": {
        "edges": [
          {
            "id": "id",
            "source": "source",
            "target": "target"
          }
        ],
        "nodes": [
          {
            "id": "id",
            "data": {
              "body": "body",
              "title": "title"
            },
            "position": {
              "x": 0,
              "y": 0
            },
            "type": "promptBlock"
          }
        ]
      },
      "slack": {
        "channels": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "connection_id": "connection_id",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "sms_enabled": true,
      "sms_template": "sms_template",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_model": "stt-rt-v4",
      "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
      },
      "voicemail_message": "voicemail_message",
      "voicemail_sms_prompt": "voicemail_sms_prompt",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "faq_items": [
        {
          "answer": "answer",
          "question": "question",
          "id": "id",
          "needs_human_answer": true,
          "source": "human"
        }
      ],
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true,
      "pending_faq_count": 0
    },
    "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",
        "assistants_used": [
          "string"
        ],
        "email_log": [
          {
            "id": "id",
            "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",
            "to_phone_number": "to_phone_number",
            "twilio_message_sid": "twilio_message_sid",
            "type": "in_call"
          }
        ],
        "speech_events": [
          {
            "id": "id",
            "is_real_turn": true,
            "llm_ttft_ms": 0,
            "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"
          }
        ]
      }
    ],
    "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": 0
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "calls_count": 0,
    "campaign": {
      "id": "id",
      "name": "name"
    },
    "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",
      "assistants_used": [
        "string"
      ],
      "email_log": [
        {
          "id": "id",
          "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",
          "to_phone_number": "to_phone_number",
          "twilio_message_sid": "twilio_message_sid",
          "type": "in_call"
        }
      ],
      "speech_events": [
        {
          "id": "id",
          "is_real_turn": true,
          "llm_ttft_ms": 0,
          "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"
        }
      ]
    },
    "llm_model": {
      "name": "gpt-4.1",
      "type": "dedicated-instance"
    },
    "metadata": {
      "foo": "string"
    },
    "organization_id": "organization_id",
    "prompt_variables": {
      "foo": "string"
    },
    "scheduled_at": {},
    "status": "initializing",
    "to_phone_number": "to_phone_number",
    "updated_at": {},
    "follow_up_emails": [
      "string"
    ],
    "outcome": "not_interested",
    "outcome_summary": "outcome_summary",
    "slack_channel_ids": [
      "string"
    ]
  }
}

Returns Examples

{
  "call": {
    "id": "id",
    "assignee": {
      "id": "id",
      "email": "email",
      "first_name": "first_name",
      "last_name": "last_name"
    },
    "assistant": {
      "id": "id",
      "after_call_sms_outcomes": [
        "not_interested"
      ],
      "after_call_sms_prompt": "after_call_sms_prompt",
      "background_sound": "audio/office.ogg",
      "background_sound_volume": 0,
      "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": 0
          }
        ],
        "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"
        }
      ],
      "email_notification_address": "email_notification_address",
      "email_notification_outcomes": [
        "not_interested"
      ],
      "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",
      "human_transfer_mode": "warm",
      "ivr_navigation_enabled": true,
      "llm_model": {
        "name": "gpt-4.1",
        "type": "dedicated-instance"
      },
      "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
      },
      "precall_lookup_url": "precall_lookup_url",
      "prompt": "prompt",
      "prompt_flow": {
        "edges": [
          {
            "id": "id",
            "source": "source",
            "target": "target"
          }
        ],
        "nodes": [
          {
            "id": "id",
            "data": {
              "body": "body",
              "title": "title"
            },
            "position": {
              "x": 0,
              "y": 0
            },
            "type": "promptBlock"
          }
        ]
      },
      "slack": {
        "channels": [
          {
            "id": "id",
            "name": "name"
          }
        ],
        "connection_id": "connection_id",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "sms_enabled": true,
      "sms_template": "sms_template",
      "structured_output_config": [
        {
          "name": "x",
          "required": true,
          "type": "string",
          "description": "description",
          "enum_options": [
            "string"
          ]
        }
      ],
      "structured_output_prompt": "structured_output_prompt",
      "stt_context": {
        "general": [
          {
            "key": "x",
            "value": "x"
          }
        ],
        "terms": [
          "x"
        ]
      },
      "stt_model": "stt-rt-v4",
      "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
      },
      "voicemail_message": "voicemail_message",
      "voicemail_sms_prompt": "voicemail_sms_prompt",
      "warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
      "webhook_url": "webhook_url",
      "zoho": {
        "connection_id": "connection_id",
        "field_mapping": [
          {
            "source": "x",
            "zoho_field": "x"
          }
        ],
        "log_call_activity": true,
        "module": "x",
        "outcomes": [
          "not_interested"
        ],
        "template": "template"
      },
      "created_by": {
        "id": "id",
        "email": "email",
        "first_name": "first_name",
        "last_name": "last_name"
      },
      "faq_items": [
        {
          "answer": "answer",
          "question": "question",
          "id": "id",
          "needs_human_answer": true,
          "source": "human"
        }
      ],
      "is_inbound_receptionist": true,
      "is_realestate_assistant": true,
      "pending_faq_count": 0
    },
    "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",
        "assistants_used": [
          "string"
        ],
        "email_log": [
          {
            "id": "id",
            "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",
            "to_phone_number": "to_phone_number",
            "twilio_message_sid": "twilio_message_sid",
            "type": "in_call"
          }
        ],
        "speech_events": [
          {
            "id": "id",
            "is_real_turn": true,
            "llm_ttft_ms": 0,
            "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"
          }
        ]
      }
    ],
    "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": 0
        }
      ],
      "max_retry_attempts": 1,
      "timezone": "timezone"
    },
    "calls_count": 0,
    "campaign": {
      "id": "id",
      "name": "name"
    },
    "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",
      "assistants_used": [
        "string"
      ],
      "email_log": [
        {
          "id": "id",
          "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",
          "to_phone_number": "to_phone_number",
          "twilio_message_sid": "twilio_message_sid",
          "type": "in_call"
        }
      ],
      "speech_events": [
        {
          "id": "id",
          "is_real_turn": true,
          "llm_ttft_ms": 0,
          "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"
        }
      ]
    },
    "llm_model": {
      "name": "gpt-4.1",
      "type": "dedicated-instance"
    },
    "metadata": {
      "foo": "string"
    },
    "organization_id": "organization_id",
    "prompt_variables": {
      "foo": "string"
    },
    "scheduled_at": {},
    "status": "initializing",
    "to_phone_number": "to_phone_number",
    "updated_at": {},
    "follow_up_emails": [
      "string"
    ],
    "outcome": "not_interested",
    "outcome_summary": "outcome_summary",
    "slack_channel_ids": [
      "string"
    ]
  }
}

Place a call

ParametersExpand Collapse

ReturnsExpand Collapse

Place a call

Returns Examples

What can I help you with?

Suggestions