Skip to main content
GET
/
phone
List AI phone agents
curl --request GET \
  --url https://api.open.cx/phone \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "org_id": "<string>",
    "phone_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>",
    "first_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "provider_external_id": "<string>",
    "flow": null,
    "manual_mode": true,
    "custom_llm": "<string>",
    "use_org_knowledgebase": true,
    "background_noise_preset": "office",
    "recording_enabled": true
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.open.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Response

Default Response

​
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
​
speed
number | 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,
oppie-vox-livekit
​
voice_id
string | null
required
​
first_message
string | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
provider_external_id
string | null
required
​
flow
unknown
required
​
manual_mode
boolean
required
​
custom_llm
string | null
required
​
use_org_knowledgebase
boolean
required
​
background_noise_preset
enum<string> | null
required
Available options:
office,
bar,
city-street
​
recording_enabled
boolean
required