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-numbersto register phone numbers - See
CORRECT_PHONE_NUMBER_SETUP.mdfor complete setup instructions - See
MULTI_AGENT_ARCHITECTURE_PLAN.mdfor 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": {}
}
'import requests
url = "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound"
payload = {
"name": "<string>",
"trunk_type": "<string>",
"sip_uri": "<string>",
"phone_numbers": ["<string>"],
"provider": "<string>",
"auth_username": "<string>",
"auth_password": "<string>",
"provider_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trunk_type: '<string>',
sip_uri: '<string>',
phone_numbers: ['<string>'],
provider: '<string>',
auth_username: '<string>',
auth_password: '<string>',
provider_config: {}
})
};
fetch('https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trunk_type' => '<string>',
'sip_uri' => '<string>',
'phone_numbers' => [
'<string>'
],
'provider' => '<string>',
'auth_username' => '<string>',
'auth_password' => '<string>',
'provider_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
SIP trunk creation model.
Response
Successful Response
⌘I
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": {}
}
'import requests
url = "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound"
payload = {
"name": "<string>",
"trunk_type": "<string>",
"sip_uri": "<string>",
"phone_numbers": ["<string>"],
"provider": "<string>",
"auth_username": "<string>",
"auth_password": "<string>",
"provider_config": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
trunk_type: '<string>',
sip_uri: '<string>',
phone_numbers: ['<string>'],
provider: '<string>',
auth_username: '<string>',
auth_password: '<string>',
provider_config: {}
})
};
fetch('https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'trunk_type' => '<string>',
'sip_uri' => '<string>',
'phone_numbers' => [
'<string>'
],
'provider' => '<string>',
'auth_username' => '<string>',
'auth_password' => '<string>',
'provider_config' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sip/tenants/{tenant_id}/sip-trunks/outbound")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"trunk_type\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"phone_numbers\": [\n \"<string>\"\n ],\n \"provider\": \"<string>\",\n \"auth_username\": \"<string>\",\n \"auth_password\": \"<string>\",\n \"provider_config\": {}\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}