List available numbers

GET

numbers

available

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "number": "+1234567890",
      "active": true,
      "label": "My Phone Number",
      "inbound_agent_name": "Agent Name",
      "outbound_only": false,
      "example_context": {},
      "telephony_provider": "twilio",
      "telephony_account_connection": {},
      "description": "Business line for customer service",
      "inbound_agent": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "user_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "My Agent",
        "prompt": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "label": "My Prompt",
          "description": "This is a description",
          "content": "You are a helpful assistant...",
          "context_endpoint": "https://api.example.com/context",
          "collect_fields": [
            "<string>"
          ],
          "type": "prompt",
          "tags": [
            "tag1",
            "tag2"
          ],
          "prompt_template": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "user_id": "550e8400-e29b-41d4-a716-446655440000",
            "required_context_keys": [
              "tag1",
              "tag2"
            ],
            "label": "My Prompt"
          }
        },
        "language": "en",
        "actions": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "user_id": "550e8400-e29b-41d4-a716-446655440000",
            "type": "action_transfer_call",
            "label": "Transfer Call",
            "description": "This is a description",
            "config": {},
            "action_trigger": {}
          }
        ],
        "voice": {},
        "initial_message": "Hello, how can I help you today?",
        "webhook": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "subscriptions": [
            "event_message",
            "event_action"
          ],
          "url": "https://example.com/webhook",
          "method": "POST",
          "label": "My Webhook",
          "description": "This is a description"
        },
        "interrupt_sensitivity": "low",
        "context_endpoint": "https://api.example.com/context",
        "noise_suppression": true,
        "endpointing_sensitivity": "auto",
        "ivr_navigation_mode": "default",
        "conversation_speed": 0.5,
        "initial_message_delay": 1000,
        "openai_model_name_override": "gpt-4",
        "ask_if_human_present_on_idle": true,
        "openai_account_connection": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "label": "My Account Connection",
          "description": "This is a description",
          "type": "account_connection_twilio",
          "credentials": {
            "twilio_account_sid": "AC1234567890",
            "twilio_auth_token": "1234567890"
          },
          "steering_pool": [
            "+1234567890"
          ],
          "account_supports_any_caller_id": false
        },
        "run_do_not_call_detection": true,
        "llm_fallback": {},
        "deepgram_keywords": {
          "kansas": "10"
        },
        "idle_time_seconds": 10,
        "llm_temperature": 0.5,
        "enable_recording": true,
        "provider": "openai",
        "model": "gpt-4",
        "label": "My Agent",
        "description": "This is a description",
        "transcriber": {},
        "call_duration_sec": 10,
        "max_idle_check_count": 10
      }
    }
  ],
  "total": 10
}

Authorizations

Authorization

string

header

required

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

Query Parameters

telephony_provider

string

required

telephony_account_connection

string

required

limit

number

filters

string

Response

200

application/json

items

object[]

required

items.id

string

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.user_id

string

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.number

string

Example:

"+1234567890"

items.active

boolean

Example:

true

items.label

string

Example:

"My Phone Number"

items.inbound_agent_name

string

Example:

"Agent Name"

items.outbound_only

boolean

Example:

false

items.example_context

object

items.telephony_provider

object

Example:

"twilio"

items.telephony_account_connection

object

items.description

string

Example:

"Business line for customer service"

items.inbound_agent

object

items.inbound_agent.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.prompt

object

required

items.inbound_agent.prompt.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.prompt.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.prompt.label

string

Example:

"My Prompt"

items.inbound_agent.prompt.description

string

Example:

"This is a description"

items.inbound_agent.prompt.content

string

Example:

"You are a helpful assistant..."

items.inbound_agent.prompt.context_endpoint

string

Example:

"https://api.example.com/context"

items.inbound_agent.prompt.collect_fields

string[]

deprecated

items.inbound_agent.prompt.type

enum<string>

Available options:

prompt,

block

Example:

"prompt"

items.inbound_agent.prompt.tags

string[]

Example:

["tag1", "tag2"]

items.inbound_agent.prompt.prompt_template

object

deprecated

items.inbound_agent.prompt.prompt_template.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.prompt.prompt_template.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.prompt.prompt_template.required_context_keys

string[]

required

Example:

["tag1", "tag2"]

items.inbound_agent.prompt.prompt_template.label

string

Example:

"My Prompt"

items.inbound_agent.voice

object

required

items.inbound_agent.name

string

Example:

"My Agent"

items.inbound_agent.language

enum<string>

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

items.inbound_agent.actions

object[]

items.inbound_agent.initial_message

string

Example:

"Hello, how can I help you today?"

items.inbound_agent.webhook

object

items.inbound_agent.webhook.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.webhook.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.webhook.subscriptions

object[]

required

Example:

["event_message", "event_action"]

items.inbound_agent.webhook.url

string

required

Example:

"https://example.com/webhook"

items.inbound_agent.webhook.method

enum<string>

Available options:

GET,

POST

Example:

"POST"

items.inbound_agent.webhook.label

string

Example:

"My Webhook"

items.inbound_agent.webhook.description

string

Example:

"This is a description"

items.inbound_agent.interrupt_sensitivity

enum<string>

Available options:

low,

high

items.inbound_agent.context_endpoint

string

Example:

"https://api.example.com/context"

items.inbound_agent.noise_suppression

boolean

Example:

true

items.inbound_agent.endpointing_sensitivity

enum<string>

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

items.inbound_agent.conversation_speed

number

Example:

0.5

items.inbound_agent.initial_message_delay

number

Example:

1000

items.inbound_agent.openai_model_name_override

string

Example:

"gpt-4"

items.inbound_agent.ask_if_human_present_on_idle

boolean

Example:

true

items.inbound_agent.openai_account_connection

object

items.inbound_agent.openai_account_connection.id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.openai_account_connection.user_id

string

required

Example:

"550e8400-e29b-41d4-a716-446655440000"

items.inbound_agent.openai_account_connection.type

enum<string>

required

Available options:

account_connection_twilio,

account_connection_openai,

account_connection_google,

account_connection_azure_llm,

account_connection_elevenlabs,

account_connection_deepgram,

account_connection_cartesia,

account_connection_playht,

account_connection_rime,

account_connection_azure_speech,

account_connection_assemblyai,

account_connection_deepseek,

account_connection_telnyx,

account_connection_un_pw_oauth,

account_connection_login_key_oauth,

account_connection_external_api_key

Example:

"account_connection_twilio"

items.inbound_agent.openai_account_connection.credentials

object

required

Example:

{
  "twilio_account_sid": "AC1234567890",
  "twilio_auth_token": "1234567890"
}

items.inbound_agent.openai_account_connection.label

string

Example:

"My Account Connection"

items.inbound_agent.openai_account_connection.description

string

Example:

"This is a description"

items.inbound_agent.openai_account_connection.steering_pool

string[]

Example:

["+1234567890"]

items.inbound_agent.openai_account_connection.account_supports_any_caller_id

boolean

Example:

false

items.inbound_agent.run_do_not_call_detection

boolean

Example:

true

items.inbound_agent.llm_fallback

object

items.inbound_agent.deepgram_keywords

object

Example:

{ "kansas": "10" }

items.inbound_agent.idle_time_seconds

number

Example:

10

items.inbound_agent.llm_temperature

number

Example:

0.5

items.inbound_agent.enable_recording

boolean

Example:

true

items.inbound_agent.provider

string

Example:

"openai"

items.inbound_agent.model

string

Example:

"gpt-4"

items.inbound_agent.label

string

Example:

"My Agent"

items.inbound_agent.description

string

Example:

"This is a description"

items.inbound_agent.transcriber

object

items.inbound_agent.call_duration_sec

number

Example:

10

items.inbound_agent.max_idle_check_count

number

Example:

10

total

number

required

Example:

10

Update account connection List numbers

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "user_id": "550e8400-e29b-41d4-a716-446655440000",
      "number": "+1234567890",
      "active": true,
      "label": "My Phone Number",
      "inbound_agent_name": "Agent Name",
      "outbound_only": false,
      "example_context": {},
      "telephony_provider": "twilio",
      "telephony_account_connection": {},
      "description": "Business line for customer service",
      "inbound_agent": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "user_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "My Agent",
        "prompt": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "label": "My Prompt",
          "description": "This is a description",
          "content": "You are a helpful assistant...",
          "context_endpoint": "https://api.example.com/context",
          "collect_fields": [
            "<string>"
          ],
          "type": "prompt",
          "tags": [
            "tag1",
            "tag2"
          ],
          "prompt_template": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "user_id": "550e8400-e29b-41d4-a716-446655440000",
            "required_context_keys": [
              "tag1",
              "tag2"
            ],
            "label": "My Prompt"
          }
        },
        "language": "en",
        "actions": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "user_id": "550e8400-e29b-41d4-a716-446655440000",
            "type": "action_transfer_call",
            "label": "Transfer Call",
            "description": "This is a description",
            "config": {},
            "action_trigger": {}
          }
        ],
        "voice": {},
        "initial_message": "Hello, how can I help you today?",
        "webhook": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "subscriptions": [
            "event_message",
            "event_action"
          ],
          "url": "https://example.com/webhook",
          "method": "POST",
          "label": "My Webhook",
          "description": "This is a description"
        },
        "interrupt_sensitivity": "low",
        "context_endpoint": "https://api.example.com/context",
        "noise_suppression": true,
        "endpointing_sensitivity": "auto",
        "ivr_navigation_mode": "default",
        "conversation_speed": 0.5,
        "initial_message_delay": 1000,
        "openai_model_name_override": "gpt-4",
        "ask_if_human_present_on_idle": true,
        "openai_account_connection": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "user_id": "550e8400-e29b-41d4-a716-446655440000",
          "label": "My Account Connection",
          "description": "This is a description",
          "type": "account_connection_twilio",
          "credentials": {
            "twilio_account_sid": "AC1234567890",
            "twilio_auth_token": "1234567890"
          },
          "steering_pool": [
            "+1234567890"
          ],
          "account_supports_any_caller_id": false
        },
        "run_do_not_call_detection": true,
        "llm_fallback": {},
        "deepgram_keywords": {
          "kansas": "10"
        },
        "idle_time_seconds": 10,
        "llm_temperature": 0.5,
        "enable_recording": true,
        "provider": "openai",
        "model": "gpt-4",
        "label": "My Agent",
        "description": "This is a description",
        "transcriber": {},
        "call_duration_sec": 10,
        "max_idle_check_count": 10
      }
    }
  ],
  "total": 10
}

Account Connections

Numbers

Calls

Agents

Prompts

Voices

Actions

Webhooks

List available numbers

Authorizations

Query Parameters

Response