Numbers
Cancel Number
Numbers
Cancel Number
POST
/
v1
/
numbers
/
cancel
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
phone_number
string
requiredResponse
200 - application/json
id
string
requireduser_id
string
requiredactive
boolean
default: truelabel
string
default: inbound_agent
object
requiredinbound_agent.id
string
requiredinbound_agent.user_id
string
requiredinbound_agent.name
string
inbound_agent.prompt
object
requiredinbound_agent.prompt.id
string
requiredinbound_agent.prompt.user_id
string
requiredinbound_agent.prompt.content
string
default: inbound_agent.prompt.collect_fields
object[]
inbound_agent.prompt.collect_fields.field_type
enum<string>
requiredAvailable options:
field_type_email inbound_agent.prompt.collect_fields.label
string
requiredinbound_agent.prompt.collect_fields.name
string
requiredinbound_agent.prompt.collect_fields.description
string
inbound_agent.prompt.context_endpoint
string
inbound_agent.prompt.prompt_template
object
inbound_agent.prompt.prompt_template.id
string
requiredinbound_agent.prompt.prompt_template.user_id
string
requiredinbound_agent.prompt.prompt_template.label
string
default: inbound_agent.prompt.prompt_template.required_context_keys
string[]
requiredinbound_agent.language
enum<string>
An enumeration.
Available options:
en, es, de, hi, pt, fr, nl, id, it, ja, ko inbound_agent.actions
object[]
requiredinbound_agent.actions.id
string
requiredinbound_agent.actions.user_id
string
requiredinbound_agent.actions.type
enum<string>
requiredAvailable options:
action_transfer_call inbound_agent.actions.config
object
requiredinbound_agent.actions.config.phone_number
string
requiredinbound_agent.actions.action_trigger
object
inbound_agent.actions.action_trigger.type
enum<string>
requiredAvailable options:
action_trigger_function_call inbound_agent.actions.action_trigger.config
object
inbound_agent.voice
object
requiredinbound_agent.voice.id
string
requiredinbound_agent.voice.user_id
string
requiredinbound_agent.voice.type
enum<string>
requiredAvailable options:
voice_azure inbound_agent.voice.voice_name
string
requiredinbound_agent.voice.pitch
integer
default: 0inbound_agent.voice.rate
integer
default: 15inbound_agent.initial_message
string
inbound_agent.webhook
object
inbound_agent.webhook.id
string
requiredinbound_agent.webhook.user_id
string
requiredinbound_agent.webhook.subscriptions
enum<string>[]
requiredAvailable options:
event_message, event_action, event_phone_call_connected, event_phone_call_ended, event_phone_call_did_not_connect, event_transcript, event_recording, event_human_detection inbound_agent.webhook.url
string
requiredinbound_agent.webhook.method
enum<string>
An enumeration.
Available options:
GET, POST inbound_agent.vector_database
object
inbound_agent.vector_database.id
string
requiredinbound_agent.vector_database.user_id
string
requiredinbound_agent.vector_database.type
enum<string>
requiredAvailable options:
vector_database_pinecone inbound_agent.vector_database.index
string
requiredinbound_agent.vector_database.api_key
string
requiredinbound_agent.vector_database.api_environment
string
requiredinbound_agent.interrupt_sensitivity
enum<string>
An enumeration.
Available options:
low, high inbound_agent.context_endpoint
string
inbound_agent.noise_suppression
boolean
default: falseinbound_agent.endpointing_sensitivity
enum<string>
default: autoAvailable options:
auto, relaxed, sensitive inbound_agent.ivr_navigation_mode
enum<string>
default: offAvailable options:
default, off inbound_agent.conversation_speed
number
default: 1inbound_agent.initial_message_delay
number
default: 0inbound_agent.openai_model_name_override
string
inbound_agent.ask_if_human_present_on_idle
boolean
default: falseinbound_agent.openai_account_connection
object
inbound_agent.openai_account_connection.id
string
requiredinbound_agent.openai_account_connection.user_id
string
requiredinbound_agent.openai_account_connection.credentials
object
requiredinbound_agent.openai_account_connection.credentials.openai_api_key
string
requiredinbound_agent.openai_account_connection.type
enum<string>
requiredAvailable options:
account_connection_openai inbound_agent.run_do_not_call_detection
boolean
default: falseinbound_agent.llm_temperature
number
default: 0outbound_only
boolean
default: falseexample_context
object
number
string
requiredtelephony_provider
enum<string>
default: vonageAvailable options:
vonage, twilio telephony_account_connection
object
telephony_account_connection.id
string
requiredtelephony_account_connection.user_id
string
requiredtelephony_account_connection.credentials
object
requiredtelephony_account_connection.credentials.twilio_account_sid
string
requiredtelephony_account_connection.credentials.twilio_auth_token
string
requiredtelephony_account_connection.type
enum<string>
requiredAvailable options:
account_connection_twilio telephony_account_connection.steering_pool
string[]
telephony_account_connection.account_supports_any_caller_id
boolean
default: false