POST
/
phone
/
buy

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string

The name of the AI phone agent

area_code
string
required

The area code of the phone number. For now, this API only supports US phone numbers, so the area code should be a 3-digit number.

base_prompt
string

The base prompt guides the AI's responses when interacting with customers. It serves as the foundational instruction set for the AI, defining how it should initiate conversations, handle customer inquiries, and respond to various scenarios. This prompt helps ensure that the AI provides consistent and relevant responses tailored to the specific needs of the organization and its customers.

handoff_phone_number
string

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

greeting_message
string

The initial message to be spoken by the AI phone agent when it answers the phone call (e.g - "Hello! This is Mark from FictionalCompany. How can I help you?")

language
enum<string>
default: en

The language the AI phone agent speaks in

Available options:
bg,
ca,
zh,
zh-TW,
cs,
da,
nl,
en,
et,
fi,
nl-BE,
fr,
de,
de-CH,
el,
hi,
hu,
id,
it,
ja,
ko,
lv,
lt,
ms,
multi,
no,
pl,
pt,
ro,
ru,
sk,
es,
sv,
th,
tr,
uk,
vi
emotion_recognition
boolean

Whether the AI should recognize emotions of the user on the other end of the call. If turned off, the agent will not recognize the different emotions of the user from their tone, like anger, disappointment, etc.

elevenlabs_voice_id
enum<string>
required

ID for a voice provided by 11labs. Different IDs, as well as descriptions of these voices can be found here.

Available options:
hP72SDESIJq2YuAblBqz,
a38v0NaUbsvackET0tSL,
UR972wNGq3zluze0LoIp,
IOyj8WtBHdke2FjQgGAr,
6pVydnYcVtMsrrSeUKs6,
BafnizVJUkrZF7B8vAMB,
7ml0LUl80q5HrlC5rH5n,
2EUn20N7uqcXUxqGrJEF,
dRqoXefWJMo2lbk72Ucp,
3R4yOxfnii0AEiNj88t7,
AcERRlWeeyUhaV8Z6nI7,
CXlx1qNjAZaq99XYNLZl,
ktBW0zUVLSxdQiNCm7VY,
EOYxsIDQfFQEnzbIRe3T,
4h05pJAlcSqTMs5KRd8X,
H61ermx0gHYPgQYw03E4,
fc0bJMlcn2uSFDSWPMjI,
Yx8RZ6gdw0HEEzcwrVlS,
4CrZuIW9am7gYAxgo2Af,
x8udhExu0uJxUn4Tf9Az,
sY2peC9GbHX8NCy5enOe,
TxErUhYT25MQSG3MlH4A,
PoPHDFYHijTq7YiSCwE3,
tavIIPLplRB883FzWU0V,
RFMAYURhm3MdnPIzpcwm,
GiGOaehga8enaTnFQvb4,
jQWvT5ZpmLknePt8F1jr,
JjHBC66wF58p4ogebCNA,
cfO5AAIh6JY3KjKu6QRz,
IJOA5d06iGvU3ehQdDjg
voice_speed
number

The speed of the voice in which the AI agent speaks.

speaks_first
enum<string>

Specifies who speaks first in the phone call, the AI phone assistant, or, the user calling

Available options:
assistant-speaks-first,
user-speaks-first
wait_time_before_ending_call
number

The time the AI agent waits without speech from either the AI agent or the user before ending the call

call_max_duration
number

The maximum number of seconds that the call will last. When the call reaches this duration, it will end.

end_call_message
string

This is the message that the assistant will say if it ends the call. If unspecified, it will hang up without saying anything.

awaiting_response_messages
string

A set of messages to be said whenever there is no speach for a certain amount of time specified in idle_timeout_seconds, when this time is exceeded the AI agent says one of the messages specified. The different messages are seperated using commas. (e.g - "Are you still there?,Hello?,Do you need help with anything?")

awaiting_response_max_spoken_count
number

This determines the maximum number of times awaiting_response_messages can be spoken during the call.

awaiting_response_timeout
number

The timeout in seconds before a message from idleMessages is spoken. The clock starts when the assistant finishes speaking and remains active until the user speaks.

Response

201 - application/json
id
string
required
phone_number
string
required

Was this page helpful?

Update a contactUpdate a phone number