Create a BYO SIP trunk
curl --request POST \
--url https://apiv2.vodex.ai/v1/sip-trunks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"inbound": {
"allowedIps": [
"<string>"
],
"authUsername": "<string>",
"authPassword": "<string>"
},
"declaredNumbers": [
"<string>"
],
"outbound": {
"host": "<string>",
"port": 5060,
"transport": "udp",
"authUsername": "<string>",
"authPassword": "<string>"
}
}
'import requests
url = "https://apiv2.vodex.ai/v1/sip-trunks"
payload = {
"name": "<string>",
"inbound": {
"allowedIps": ["<string>"],
"authUsername": "<string>",
"authPassword": "<string>"
},
"declaredNumbers": ["<string>"],
"outbound": {
"host": "<string>",
"port": 5060,
"transport": "udp",
"authUsername": "<string>",
"authPassword": "<string>"
}
}
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>',
inbound: {allowedIps: ['<string>'], authUsername: '<string>', authPassword: '<string>'},
declaredNumbers: ['<string>'],
outbound: {
host: '<string>',
port: 5060,
transport: 'udp',
authUsername: '<string>',
authPassword: '<string>'
}
})
};
fetch('https://apiv2.vodex.ai/v1/sip-trunks', 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://apiv2.vodex.ai/v1/sip-trunks",
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>',
'inbound' => [
'allowedIps' => [
'<string>'
],
'authUsername' => '<string>',
'authPassword' => '<string>'
],
'declaredNumbers' => [
'<string>'
],
'outbound' => [
'host' => '<string>',
'port' => 5060,
'transport' => 'udp',
'authUsername' => '<string>',
'authPassword' => '<string>'
]
]),
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://apiv2.vodex.ai/v1/sip-trunks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\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://apiv2.vodex.ai/v1/sip-trunks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sip-trunks")
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 \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "trunk-1a2b3c4d",
"name": "<string>",
"inbound": {
"allowedIps": [
"<string>"
],
"authUsername": "<string>"
},
"outbound": {
"host": "<string>",
"port": 123,
"transport": "udp",
"authUsername": "<string>"
},
"declaredNumbers": [
"<string>"
],
"livekitInboundId": "<string>",
"livekitOutboundId": "<string>",
"cellId": "<string>",
"sipUri": "sip:sip.example:5060"
}{
"error": "not found"
}{
"error": "not found"
}SIP Trunks
Create a BYO SIP trunk
IP ACL and credentials, never either alone. declaredNumbers scopes
the trunk: LiveKit inbound trunks are created for exactly those numbers,
never as a catch-all.
POST
/
sip-trunks
Create a BYO SIP trunk
curl --request POST \
--url https://apiv2.vodex.ai/v1/sip-trunks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"inbound": {
"allowedIps": [
"<string>"
],
"authUsername": "<string>",
"authPassword": "<string>"
},
"declaredNumbers": [
"<string>"
],
"outbound": {
"host": "<string>",
"port": 5060,
"transport": "udp",
"authUsername": "<string>",
"authPassword": "<string>"
}
}
'import requests
url = "https://apiv2.vodex.ai/v1/sip-trunks"
payload = {
"name": "<string>",
"inbound": {
"allowedIps": ["<string>"],
"authUsername": "<string>",
"authPassword": "<string>"
},
"declaredNumbers": ["<string>"],
"outbound": {
"host": "<string>",
"port": 5060,
"transport": "udp",
"authUsername": "<string>",
"authPassword": "<string>"
}
}
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>',
inbound: {allowedIps: ['<string>'], authUsername: '<string>', authPassword: '<string>'},
declaredNumbers: ['<string>'],
outbound: {
host: '<string>',
port: 5060,
transport: 'udp',
authUsername: '<string>',
authPassword: '<string>'
}
})
};
fetch('https://apiv2.vodex.ai/v1/sip-trunks', 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://apiv2.vodex.ai/v1/sip-trunks",
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>',
'inbound' => [
'allowedIps' => [
'<string>'
],
'authUsername' => '<string>',
'authPassword' => '<string>'
],
'declaredNumbers' => [
'<string>'
],
'outbound' => [
'host' => '<string>',
'port' => 5060,
'transport' => 'udp',
'authUsername' => '<string>',
'authPassword' => '<string>'
]
]),
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://apiv2.vodex.ai/v1/sip-trunks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\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://apiv2.vodex.ai/v1/sip-trunks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/sip-trunks")
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 \"inbound\": {\n \"allowedIps\": [\n \"<string>\"\n ],\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n },\n \"declaredNumbers\": [\n \"<string>\"\n ],\n \"outbound\": {\n \"host\": \"<string>\",\n \"port\": 5060,\n \"transport\": \"udp\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "trunk-1a2b3c4d",
"name": "<string>",
"inbound": {
"allowedIps": [
"<string>"
],
"authUsername": "<string>"
},
"outbound": {
"host": "<string>",
"port": 123,
"transport": "udp",
"authUsername": "<string>"
},
"declaredNumbers": [
"<string>"
],
"livekitInboundId": "<string>",
"livekitOutboundId": "<string>",
"cellId": "<string>",
"sipUri": "sip:sip.example:5060"
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
application/json
Response
Created and provisioned on the gateway.
Credentials are never echoed — only the username and the URI to point a PBX at.