Phone Numbers
Get phone numbers
Update a phone number
Delete a phone number
ModelsExpand Collapse
class PhoneNumberListResponse { phone_numbers }
phone_numbers: Array[PhoneNumber{ id, created_at, created_by, 11 more}]
inbound_assistant: InboundAssistant{ id, background_sound, background_sound_volume, 52 more}
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly{ connection_id, event_type_id}
The connection ID representing the link between your Calendly account and Revox.
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{ 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.
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.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
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, calling_window_start_time, retry_delay_seconds}]
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’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array[CustomTool{ body_template, description, headers, 5 more}]
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array[Header{ key, value}]HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array[InputSchema{ name, required, type, 2 more}]Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot{ connection_id, meeting_links, precall_lookup_enabled, post_call_sync}
meeting_links: Array[MeetingLink{ booking_url, duration_ms, is_fallback, 2 more}]Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent books through the API and only texts this link to the caller when the booking fails and the call can receive an SMS. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
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.
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.
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.
human_transfer_mode: :warm | :coldWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
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
class UnionMember5 { model_name, type, reasoning_effort }
Fireworks model id, e.g. accounts/fireworks/models/qwen3-235b-a22b or a dedicated deployment id.
Fireworks AI model, served with the server-side FIREWORKS_API_KEY (no key stored per-assistant).
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
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.
precall_lookup_headers: Array[PrecallLookupHeader{ key, value}]HTTP headers sent with the pre-call lookup request. Null when none are configured.
HTTP headers sent with the pre-call lookup request. Null when none are configured.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack{ channels, connection_id}
structured_output_config: Array[StructuredOutputConfig{ 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.).
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.).
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}}.
When false, the agent transcribes the raw caller track instead of the BVC noise-cancellation output.
stt_context: SttContext{ 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.
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.
Soniox endpoint latency adjustment level (0 to 3). Null: Soniox default.
teams: Teams{ channels, connection_id}
channels: Array[Channel{ id, team_id, name, team_name}]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.
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.
thinking_sound: :"city-ambience.ogg" | :"forest-ambience.ogg" | :"office-ambience.ogg" | 4 moreAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array[TransferDestination{ 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.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice{ id, provider, model, 2 more}
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.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
voice_languages: Array[VoiceLanguage{ language, voice}]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.
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.
voice: Voice{ id, provider, model, 2 more}The voice used for contacts whose language is this language.
The voice used for contacts whose language is this language.
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.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
Warm transfer only: voice speed of the briefing to the human colleague; null when it follows voice.speed, not configured, or cold transfer.
zoho: Zoho{ connection_id, field_mapping, log_call_activity, 2 more}
field_mapping: Array[FieldMapping{ source, zoho_field}]Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
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.
class PhoneNumberUpdateResponse { phone_number }
phone_number: PhoneNumber{ id, created_at, created_by, 11 more}
inbound_assistant: InboundAssistant{ id, background_sound, background_sound_volume, 52 more}
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
calendly: Calendly{ connection_id, event_type_id}
The connection ID representing the link between your Calendly account and Revox.
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{ 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.
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.
Days of the week when calls are allowed, in the recipient’s timezone. Default: Monday through Friday.
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, calling_window_start_time, retry_delay_seconds}]
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’.
Optional Cartesia pronunciation dictionary ID linked to this assistant.
custom_tools: Array[CustomTool{ body_template, description, headers, 5 more}]
JSON body template for the request. Use quoted {{variable}} placeholders (e.g. “{{name}}”) for dynamic values
Human-readable description of what the tool does, used by the LLM to decide when to call it
headers: Array[Header{ key, value}]HTTP headers to include in the request. Values support {{variable}} placeholders
HTTP headers to include in the request. Values support {{variable}} placeholders
input_schema: Array[InputSchema{ name, required, type, 2 more}]Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Schema defining the parameters the LLM should extract from the conversation to pass to this tool
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
hubspot: Hubspot{ connection_id, meeting_links, precall_lookup_enabled, post_call_sync}
meeting_links: Array[MeetingLink{ booking_url, duration_ms, is_fallback, 2 more}]Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Scheduling pages the agent can book on during a call — typically one per sales rep plus a round-robin team page marked as the fallback.
Public URL of the scheduling page (e.g. https://meetings-eu1.hubspot.com/julien). The agent books through the API and only texts this link to the caller when the booking fails and the call can receive an SMS. Null on calendars saved before this field existed.
Meeting duration in milliseconds, chosen among the durations the scheduling page offers (e.g. 1800000 for 30 minutes).
Marks the round-robin calendar the agent falls back to when the requested rep has no slot. At most one meeting link may set this.
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.
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.
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.
human_transfer_mode: :warm | :coldWarm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Warm or cold transfer when transfer_destinations is non-empty; null when transfer is not configured.
Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.
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
class UnionMember5 { model_name, type, reasoning_effort }
Fireworks model id, e.g. accounts/fireworks/models/qwen3-235b-a22b or a dedicated deployment id.
Fireworks AI model, served with the server-side FIREWORKS_API_KEY (no key stored per-assistant).
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
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.
precall_lookup_headers: Array[PrecallLookupHeader{ key, value}]HTTP headers sent with the pre-call lookup request. Null when none are configured.
HTTP headers sent with the pre-call lookup request. Null when none are configured.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
slack: Slack{ channels, connection_id}
structured_output_config: Array[StructuredOutputConfig{ 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.).
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.).
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}}.
When false, the agent transcribes the raw caller track instead of the BVC noise-cancellation output.
stt_context: SttContext{ 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.
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.
Soniox endpoint latency adjustment level (0 to 3). Null: Soniox default.
teams: Teams{ channels, connection_id}
channels: Array[Channel{ id, team_id, name, team_name}]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.
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.
thinking_sound: :"city-ambience.ogg" | :"forest-ambience.ogg" | :"office-ambience.ogg" | 4 moreAudio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
transfer_destinations: Array[TransferDestination{ 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.
Where calls can be transferred to when users ask to speak to a human. Null or empty when transfer is not configured.
voice: Voice{ id, provider, model, 2 more}
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.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
voice_languages: Array[VoiceLanguage{ language, voice}]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.
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.
voice: Voice{ id, provider, model, 2 more}The voice used for contacts whose language is this language.
The voice used for contacts whose language is this language.
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.
Cartesia TTS model (Cartesia only). Defaults to sonic-3.6 when omitted. Ignored for other providers.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
Warm transfer only: voice speed of the briefing to the human colleague; null when it follows voice.speed, not configured, or cold transfer.
zoho: Zoho{ connection_id, field_mapping, log_call_activity, 2 more}
field_mapping: Array[FieldMapping{ source, zoho_field}]Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.
When true, also log the call as a record in Zoho’s Calls module (related to the upserted prospect via Who_Id).
Zoho module the prospect record is upserted into (e.g. ‘Leads’ or ‘Contacts’).
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.