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.
Parameters
phone_number: str
The phone number to call in the E.164 format. Example: +1234567890
assistant_id: Optional[str]
The ID of the assistant to use for this call.
formatuuid
The prompt to use for the call. This will be given to the LLM (gpt-4.1)
from_phone_number: Optional[str]
The phone number to use for making the call (e.g., +1234567890). If not provided, uses the default trunk.
metadata: Optional[Dict[str, str]]
Metadata to store with the call.
prompt_variables: Optional[Dict[str, str]]
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.
Returns
Place a call
import os
from revox import Revox
client = Revox(
api_key=os.environ.get("REVOX_API_KEY"), # This is the default and can be omitted
)
call = client.call.create(
phone_number="phone_number",
)
print(call.call){
"call": {
"id": "id",
"assistant": {
"id": "id",
"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": 1
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"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": "dev@stainless.com",
"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"
},
"max_call_duration_secs": 0,
"max_duration_end_message": "max_duration_end_message",
"name": "name",
"organization_id": "organization_id",
"prompt": "prompt",
"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",
"thinking_sound": "city-ambience.ogg",
"thinking_sound_probability": 0,
"thinking_sound_volume": 0,
"transfer_phone_number": "transfer_phone_number",
"updated_at": {},
"voice": {
"id": "x",
"provider": "cartesia",
"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",
"faq_items": [
{
"answer": "answer",
"question": "question",
"id": "id",
"needs_human_answer": true,
"source": "human"
}
],
"pending_faq_count": 0
},
"call_attempts": [
{
"id": "id",
"answered_at": {},
"dial_error": "number_non_attributed",
"ended_at": {},
"phone_number": "phone_number",
"recording_url": "recording_url",
"result": "IVR",
"started_at": {},
"status": "queued",
"end_reason": "end_reason",
"ended_by": "agent",
"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": 1
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"calls_count": 0,
"campaign": {
"id": "id",
"name": "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": {},
"phone_number": "phone_number",
"recording_url": "recording_url",
"result": "IVR",
"started_at": {},
"status": "queued",
"end_reason": "end_reason",
"ended_by": "agent",
"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": {},
"outcome": "not_interested",
"outcome_summary": "outcome_summary"
}
}Returns Examples
{
"call": {
"id": "id",
"assistant": {
"id": "id",
"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": 1
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"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": "dev@stainless.com",
"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"
},
"max_call_duration_secs": 0,
"max_duration_end_message": "max_duration_end_message",
"name": "name",
"organization_id": "organization_id",
"prompt": "prompt",
"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",
"thinking_sound": "city-ambience.ogg",
"thinking_sound_probability": 0,
"thinking_sound_volume": 0,
"transfer_phone_number": "transfer_phone_number",
"updated_at": {},
"voice": {
"id": "x",
"provider": "cartesia",
"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",
"faq_items": [
{
"answer": "answer",
"question": "question",
"id": "id",
"needs_human_answer": true,
"source": "human"
}
],
"pending_faq_count": 0
},
"call_attempts": [
{
"id": "id",
"answered_at": {},
"dial_error": "number_non_attributed",
"ended_at": {},
"phone_number": "phone_number",
"recording_url": "recording_url",
"result": "IVR",
"started_at": {},
"status": "queued",
"end_reason": "end_reason",
"ended_by": "agent",
"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": 1
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"calls_count": 0,
"campaign": {
"id": "id",
"name": "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": {},
"phone_number": "phone_number",
"recording_url": "recording_url",
"result": "IVR",
"started_at": {},
"status": "queued",
"end_reason": "end_reason",
"ended_by": "agent",
"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": {},
"outcome": "not_interested",
"outcome_summary": "outcome_summary"
}
}