sip

Create Outbound Trunk

⚠️ DEPRECATED ENDPOINT - This endpoint is no longer supported.

Use Instead: POST /agents/{agent_id}/phone-numbers

Why Deprecated:

This endpoint used an incorrect SIP architecture
It doesn’t properly integrate with LiveKit dispatch rules
Phone numbers should be registered at agent level, not tenant level

Migration Guide:

Use POST /agents/{agent_id}/phone-numbers to register phone numbers
See CORRECT_PHONE_NUMBER_SETUP.md for complete setup instructions
See MULTI_AGENT_ARCHITECTURE_PLAN.md for migration details

Correct Endpoint:

POST /agents/{agent_id}/phone-numbers
{
    "phone_number": "+15551234567",
    "provider": "twilio",
    "enable_outbound": true,
    "outbound_address": "sip.twilio.com"
}

POST

sip

tenants

{tenant_id}

sip-trunks

outbound

Create Outbound Trunk

curl --request POST \
  --url https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "trunk_type": "<string>",
  "sip_uri": "<string>",
  "phone_numbers": [
    "<string>"
  ],
  "provider": "<string>",
  "auth_username": "<string>",
  "auth_password": "<string>",
  "provider_config": {}
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

tenant_id

string<uuid>

required

Body

application/json

SIP trunk creation model.

name

string

required

Required string length: 1 - 255

trunk_type

string

required

Pattern: ^(inbound|outbound)$

sip_uri

string

required

Minimum string length: 1

phone_numbers

string[]

provider

string | null

auth_username

string | null

auth_password

string | null

provider_config

Provider Config · object

Response

Successful Response

List Sip Trunks⚠️ **DEPRECATED ENDPOINT** - This endpoint is no longer supported. **Use Instead:** `GET /agents/{agent_id}/phone-numbers` **For listing all phone numbers across agents:** - Use `GET /phone-numbers/all` (admin endpoint) - Or iterate through agents: `GET /agents/{agent_id}/phone-numbers` for each agent

Create Outbound Trunk

curl --request POST \
  --url https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "trunk_type": "<string>",
  "sip_uri": "<string>",
  "phone_numbers": [
    "<string>"
  ],
  "provider": "<string>",
  "auth_username": "<string>",
  "auth_password": "<string>",
  "provider_config": {}
}
'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Authorizations

Path Parameters

Body

Response