Detach number

POST

numbers

detach

{
  "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
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

phone_number

string

required

Response

201

application/json

string

required

Example:

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

user_id

string

required

Example:

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

number

string

required

Example:

"+1234567890"

active

boolean

Example:

true

label

string

Example:

"My Phone Number"

inbound_agent_name

string

Example:

"Agent Name"

outbound_only

boolean

Example:

false

example_context

object

telephony_provider

object

Example:

"twilio"

telephony_account_connection

object

description

string

Example:

"Business line for customer service"

inbound_agent

object

inbound_agent.id

string

required

Example:

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

inbound_agent.user_id

string

required

Example:

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

inbound_agent.prompt

object

required

inbound_agent.prompt.id

string

required

Example:

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

inbound_agent.prompt.user_id

string

required

Example:

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

inbound_agent.prompt.label

string

Example:

"My Prompt"

inbound_agent.prompt.description

string

Example:

"This is a description"

inbound_agent.prompt.content

string

Example:

"You are a helpful assistant..."

inbound_agent.prompt.context_endpoint

string

Example:

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

inbound_agent.prompt.collect_fields

string[]

deprecated

inbound_agent.prompt.type

enum<string>

Available options:

prompt,

block

Example:

"prompt"

inbound_agent.prompt.tags

string[]

Example:

["tag1", "tag2"]

inbound_agent.prompt.prompt_template

object

deprecated

inbound_agent.prompt.prompt_template.id

string

required

Example:

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

inbound_agent.prompt.prompt_template.user_id

string

required

Example:

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

inbound_agent.prompt.prompt_template.required_context_keys

string[]

required

Example:

["tag1", "tag2"]

inbound_agent.prompt.prompt_template.label

string

Example:

"My Prompt"

inbound_agent.voice

object

required

inbound_agent.name

string

Example:

"My Agent"

inbound_agent.language

enum<string>

Available options:

en,

es,

de,

hi,

pt,

fr,

nl,

id,

it,

ja,

ko

inbound_agent.actions

object[]

inbound_agent.initial_message

string

Example:

"Hello, how can I help you today?"

inbound_agent.webhook

object

inbound_agent.webhook.id

string

required

Example:

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

inbound_agent.webhook.user_id

string

required

Example:

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

inbound_agent.webhook.subscriptions

object[]

required

Example:

["event_message", "event_action"]

inbound_agent.webhook.url

string

required

Example:

"https://example.com/webhook"

inbound_agent.webhook.method

enum<string>

Available options:

GET,

POST

Example:

"POST"

inbound_agent.webhook.label

string

Example:

"My Webhook"

inbound_agent.webhook.description

string

Example:

"This is a description"

inbound_agent.interrupt_sensitivity

enum<string>

Available options:

low,

high

inbound_agent.context_endpoint

string

Example:

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

inbound_agent.noise_suppression

boolean

Example:

true

inbound_agent.endpointing_sensitivity

enum<string>

Available options:

auto,

relaxed,

sensitive

Available options:

default,

off

inbound_agent.conversation_speed

number

Example:

0.5

inbound_agent.initial_message_delay

number

Example:

1000

inbound_agent.openai_model_name_override

string

Example:

"gpt-4"

inbound_agent.ask_if_human_present_on_idle

boolean

Example:

true

inbound_agent.openai_account_connection

object

inbound_agent.openai_account_connection.id

string

required

Example:

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

inbound_agent.openai_account_connection.user_id

string

required

Example:

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

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"

inbound_agent.openai_account_connection.credentials

object

required

Example:

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

inbound_agent.openai_account_connection.label

string

Example:

"My Account Connection"

inbound_agent.openai_account_connection.description

string

Example:

"This is a description"

inbound_agent.openai_account_connection.steering_pool

string[]

Example:

["+1234567890"]

inbound_agent.openai_account_connection.account_supports_any_caller_id

boolean

Example:

false

inbound_agent.run_do_not_call_detection

boolean

Example:

true

inbound_agent.llm_fallback

object

inbound_agent.deepgram_keywords

object

Example:

{ "kansas": "10" }

inbound_agent.idle_time_seconds

number

Example:

10

inbound_agent.llm_temperature

number

Example:

0.5

inbound_agent.enable_recording

boolean

Example:

true

inbound_agent.provider

string

Example:

"openai"

inbound_agent.model

string

Example:

"gpt-4"

inbound_agent.label

string

Example:

"My Agent"

inbound_agent.description

string

Example:

"This is a description"

inbound_agent.transcriber

object

inbound_agent.call_duration_sec

number

Example:

10

inbound_agent.max_idle_check_count

number

Example:

10

Cancel number List calls

{
  "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
  }
}

Account Connections

Numbers

Calls

Agents

Prompts

Voices

Actions

Webhooks

Authorizations

Query Parameters

Response