Get an AI phone agent
curl --request GET \
--url http://localhost:8080/phone/{phone_agent_id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/phone/{phone_agent_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/phone/{phone_agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/phone/{phone_agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/phone/{phone_agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/phone/{phone_agent_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/phone/{phone_agent_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"org_id": "<string>",
"phone_number": "<string>",
"outbound_caller_number": "<string>",
"name": "<string>",
"type": "inbound",
"language": [
"<string>"
],
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 123,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"voice_id": "<string>",
"voice_mode": "modular",
"first_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider_external_id": "<string>",
"use_org_knowledgebase": true,
"background_noise_preset": "office",
"background_volume_pct": 0,
"typing_sound_enabled": true,
"recording_enabled": true,
"search_enabled": true,
"stt_keyterms": [
"<string>"
],
"stt_model": "deepgram/flux-general",
"tts_speed_pct": 0,
"tts_provider": "elevenlabs",
"failover_transfer_destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_destination_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"published": true,
"has_unpublished_changes": true,
"flow": null
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}AI Phone Agents
Get an AI phone agent
Get full details of a specific AI phone agent including its voice, language, instructions, phone number, model, and all configuration.
GET
/
phone
/
{phone_agent_id}
Get an AI phone agent
curl --request GET \
--url http://localhost:8080/phone/{phone_agent_id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:8080/phone/{phone_agent_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:8080/phone/{phone_agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/phone/{phone_agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/phone/{phone_agent_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8080/phone/{phone_agent_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/phone/{phone_agent_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"org_id": "<string>",
"phone_number": "<string>",
"outbound_caller_number": "<string>",
"name": "<string>",
"type": "inbound",
"language": [
"<string>"
],
"accent": "<string>",
"handoff_phone_number": "<string>",
"speed": 123,
"interruptible": true,
"actionIds": [
"<string>"
],
"instructions": [
"<string>"
],
"data_collection_fields": [
"<string>"
],
"data_collection_webhook_url": "<string>",
"model": "oppie-vox",
"voice_id": "<string>",
"voice_mode": "modular",
"first_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider_external_id": "<string>",
"use_org_knowledgebase": true,
"background_noise_preset": "office",
"background_volume_pct": 0,
"typing_sound_enabled": true,
"recording_enabled": true,
"search_enabled": true,
"stt_keyterms": [
"<string>"
],
"stt_model": "deepgram/flux-general",
"tts_speed_pct": 0,
"tts_provider": "elevenlabs",
"failover_transfer_destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_destination_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"published": true,
"has_unpublished_changes": true,
"flow": null
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Response
Default Response
Available options:
deepgram/flux-general, deepgram/nova-3, deepgram/nova-3-medical, cartesia/ink-whisper, elevenlabs/scribe_v2_realtime, xai/stt-1, assemblyai/universal-3-5-pro, speechmatics/enhanced, google/gemini-3.5-transcribe-live, soniox/stt-rt-v6, openai/gpt-live-transcribe Was this page helpful?