Phones
Get Phones
Call Management
Conversational AI
Agents
Campaigns
Call Management
Conversational AI
API Reference
Agents
Phones
Get Phones
GET
/
phones
[
{
"id": "<string>",
"agent_id": "<string>",
"create_at": 123,
"status": "<string>",
"agent_config_override": {
"prompt": "<string>",
"voice": {
"provider": "elevenlabs",
"voice_id": "<string>",
"model": "<string>",
"settings": {}
},
"flow": {
"user_start_first": true,
"interruption": {
"allowed": true,
"keep_interruption_message": true,
"first_messsage": true
},
"response_delay": 123,
"auto_fill_responses": {
"messages": [
"<string>"
],
"response_gap_threshold": 123
},
"agent_terminate_call": {
"messages": [
"<string>"
],
"instruction": "<string>",
"enabled": true
},
"voicemail": {
"action": "hangup",
"message": "<string>",
"continue_on_voice_activity": true
},
"call_transfer": {
"phone": "<string>",
"instruction": "<string>",
"messages": [
"<string>"
]
}
},
"first_message": "<string>",
"tools": [
{
"name": "<string>",
"params": [
{
"name": "<string>",
"required": true,
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>",
"webhook": "<string>",
"header": {},
"method": "<string>",
"run_after_call": true,
"messages": [
"<string>"
],
"execute_after_message": true
}
],
"millis_functions": [
{
"name": "<string>",
"description": "<string>",
"data": {
"param": {
"description": "<string>",
"name": "<string>",
"required": true,
"type": "<string>"
}
},
"type": "<string>",
"messages": [
"<string>"
]
}
],
"app_functions": [
{
"name": "<string>",
"credentials": {}
}
],
"custom_llm_websocket": "<string>",
"language": "ln",
"vad_threshold": 123,
"llm": {
"model": "gpt-3.5-turbo"
},
"session_timeout": {
"max_duration": 123,
"max_idle": 123,
"message": "<string>"
},
"session_data_webhook": "<string>",
"privacy_settings": {
"opt_out_data_collection": true
},
"custom_vocabulary": {
"keywords": {}
},
"extra_prompt_webhook": "<string>",
"switch_language": {
"languages": [
"<string>"
]
},
"knowledge_base": {
"files": [
"<string>"
],
"messages": [
"<string>"
]
},
"speech_to_text": {
"provider": "deepgram",
"multilingual": true
},
"call_settings": {
"enable_recording": false
},
"timezone": "<string>"
},
"tags": [
"<string>"
]
}
]Headers
Response
200
application/json
Successful Response
Provider of text to speech.
Available options:
elevenlabs, openai, cartesia, playht, deepgram, rime, neets, openai_realtime, dubverse The ID of the voice selected for the agent
The ElevenLabs model name (e.g., 'eleven_turbo_v2_5')
ElevenLabs-specific voice settings such as stability and similarity_boost
Available options:
ln, cy, wo, cs, hy, nl, ceb, la, en-NZ, ss, lt, ne, fy, oc, yi, tt, bn, fr-CA, sw, th, ms, ka, pa, fi, ig, af, multi, eu, bs, ps, en-AU, si, ff, de, mt, km, pl, nl-BE, fr, en-IN, no, gu, lo, sk, ht, tk, bg, mn, su, ko, it, id, tl, zu, pt-BR, jv, et, ca, sl, ja, lb, gl, zh-TW, hi, ha, th-TH, lv, ast, sq, tr, ar, sv, haw, tg, lg, ba, mk, vi, hu, el, mi, en-US, kn, az, he, hr, ml, kk, es, br, sr, xh, uk, as, ilo, ru, gd, yo, da, sa, fa, es-419, bo, ur, my, nn, mo, so, mr, tn, sd, sn, uz, de-CH, fo, en-GB, zh, ro, pt, or, ga, ta, mg, en, be, am, te, is Available options:
gpt-3.5-turbo, gpt-4-turbo, gpt-4o-realtime-preview, gpt-4o, gpt-4o-mini, llama-3-70b, llama-3-1-8b, llama-3-1-70b, llama-3-1-405b, mistral-large-2407, l3.1-70b-euryale-v2.2 [
{
"id": "<string>",
"agent_id": "<string>",
"create_at": 123,
"status": "<string>",
"agent_config_override": {
"prompt": "<string>",
"voice": {
"provider": "elevenlabs",
"voice_id": "<string>",
"model": "<string>",
"settings": {}
},
"flow": {
"user_start_first": true,
"interruption": {
"allowed": true,
"keep_interruption_message": true,
"first_messsage": true
},
"response_delay": 123,
"auto_fill_responses": {
"messages": [
"<string>"
],
"response_gap_threshold": 123
},
"agent_terminate_call": {
"messages": [
"<string>"
],
"instruction": "<string>",
"enabled": true
},
"voicemail": {
"action": "hangup",
"message": "<string>",
"continue_on_voice_activity": true
},
"call_transfer": {
"phone": "<string>",
"instruction": "<string>",
"messages": [
"<string>"
]
}
},
"first_message": "<string>",
"tools": [
{
"name": "<string>",
"params": [
{
"name": "<string>",
"required": true,
"type": "<string>",
"description": "<string>"
}
],
"description": "<string>",
"webhook": "<string>",
"header": {},
"method": "<string>",
"run_after_call": true,
"messages": [
"<string>"
],
"execute_after_message": true
}
],
"millis_functions": [
{
"name": "<string>",
"description": "<string>",
"data": {
"param": {
"description": "<string>",
"name": "<string>",
"required": true,
"type": "<string>"
}
},
"type": "<string>",
"messages": [
"<string>"
]
}
],
"app_functions": [
{
"name": "<string>",
"credentials": {}
}
],
"custom_llm_websocket": "<string>",
"language": "ln",
"vad_threshold": 123,
"llm": {
"model": "gpt-3.5-turbo"
},
"session_timeout": {
"max_duration": 123,
"max_idle": 123,
"message": "<string>"
},
"session_data_webhook": "<string>",
"privacy_settings": {
"opt_out_data_collection": true
},
"custom_vocabulary": {
"keywords": {}
},
"extra_prompt_webhook": "<string>",
"switch_language": {
"languages": [
"<string>"
]
},
"knowledge_base": {
"files": [
"<string>"
],
"messages": [
"<string>"
]
},
"speech_to_text": {
"provider": "deepgram",
"multilingual": true
},
"call_settings": {
"enable_recording": false
},
"timezone": "<string>"
},
"tags": [
"<string>"
]
}
]