POST
/
phone

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the AI phone agent

type
enum<string>
default: inbound
Available options:
inbound,
outbound
language
string | null

The language the AI phone agent should mainly speak in

accent
string | null

The accent the AI phone agent should mainly speak in

handoff_phone_number
string | null

The phone number of the human agent to hand off the call to

interruptible
boolean
default: true

Whether the agent can be interrupted or not

actionIds
string[] | null

A list of action ids the AI phone agent has access to. A null value means all actions. An empty list means no actions

instructions
string[] | null

A list of instructions

data_collection_fields
string[] | null

A list of fields to collect data about

data_collection_webhook_url
string | null

The webhook url to send the collected data to

model
enum<string>
default: oppie-vox

The AI model of the agent. This cannot be changed after creation

Available options:
oppie-vox,
oppie-vox-turbo,
oppie-vox-2
first_message
string | null

The first message the AI phone agent should say

voice_id
string | null

The voice id

Response

201 - application/json
id
string
required
org_id
string
required
phone_number
string | null
required
name
string | null
required
type
enum<string>
required
Available options:
inbound,
outbound
language
string | null
required
accent
string | null
required
handoff_phone_number
string | null
required
interruptible
boolean
required
actionIds
string[] | null
required
instructions
string[] | null
required
data_collection_fields
string[] | null
required
data_collection_webhook_url
string | null
required
model
enum<string>
required
Available options:
oppie-vox,
oppie-vox-turbo,
oppie-vox-2
voice_id
string | null
required
first_message
string | null
required
created_at
string
required
updated_at
string
required
provider_external_id
string | null
required