Connect a carrier account
curl --request POST \
--url https://apiv2.vodex.ai/v1/integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"terminationUri": "<string>",
"authUsername": "<string>",
"authPassword": "<string>",
"allowedIps": [
"<string>"
],
"port": 32768,
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"authId": "<string>",
"outboundProxy": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"outboundProxy": "<string>",
"expiry": 180,
"line": true,
"pinHost": true,
"tlsVerify": {
"verify": true,
"wildcard": true,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "1910",
"password": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 1
}
],
"maxConcurrent": 50,
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/integrations"
payload = {
"name": "<string>",
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"terminationUri": "<string>",
"authUsername": "<string>",
"authPassword": "<string>",
"allowedIps": ["<string>"],
"port": 32768,
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"authId": "<string>",
"outboundProxy": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"outboundProxy": "<string>",
"expiry": 180,
"line": True,
"pinHost": True,
"tlsVerify": {
"verify": True,
"wildcard": True,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "1910",
"password": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 1
}
],
"maxConcurrent": 50,
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"accountId": "<string>",
"campaignId": "<string>",
"from": "<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>',
accountSid: '<string>',
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
terminationUri: '<string>',
authUsername: '<string>',
authPassword: '<string>',
allowedIps: ['<string>'],
port: 32768,
dialRules: [{match: '+971', replace: '0'}],
connection: 'direct',
preset: '<string>',
authId: '<string>',
outboundProxy: '<string>',
register: {
server: '<string>',
port: 32768,
outboundProxy: '<string>',
expiry: 180,
line: true,
pinHost: true,
tlsVerify: {verify: true, wildcard: true, fingerprint: '<string>'}
},
identities: [
{
username: '1910',
password: '<string>',
authUsername: '<string>',
fromUser: '<string>',
maxConcurrent: 1
}
],
maxConcurrent: 50,
inboundNumber: '<string>',
inboundRules: [{match: '0', replace: '+971'}],
accountId: '<string>',
campaignId: '<string>',
from: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/integrations', 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/integrations",
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>',
'accountSid' => '<string>',
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'terminationUri' => '<string>',
'authUsername' => '<string>',
'authPassword' => '<string>',
'allowedIps' => [
'<string>'
],
'port' => 32768,
'dialRules' => [
[
'match' => '+971',
'replace' => '0'
]
],
'connection' => 'direct',
'preset' => '<string>',
'authId' => '<string>',
'outboundProxy' => '<string>',
'register' => [
'server' => '<string>',
'port' => 32768,
'outboundProxy' => '<string>',
'expiry' => 180,
'line' => true,
'pinHost' => true,
'tlsVerify' => [
'verify' => true,
'wildcard' => true,
'fingerprint' => '<string>'
]
],
'identities' => [
[
'username' => '1910',
'password' => '<string>',
'authUsername' => '<string>',
'fromUser' => '<string>',
'maxConcurrent' => 1
]
],
'maxConcurrent' => 50,
'inboundNumber' => '<string>',
'inboundRules' => [
[
'match' => '0',
'replace' => '+971'
]
],
'accountId' => '<string>',
'campaignId' => '<string>',
'from' => '<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/integrations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\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/integrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/integrations")
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 \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"carrier": "<string>",
"name": "<string>",
"accountRef": "<string>",
"accountName": "<string>",
"status": "connected",
"lastError": "<string>",
"trunkId": "<string>",
"carrierTrunkSid": "<string>",
"terminationUri": "<string>",
"credentialFingerprint": "<string>",
"hasCredentials": true,
"secretsBackend": "secret-manager",
"provisioning": "api",
"displayName": "<string>",
"transferSupport": "supported",
"channel": "voice",
"sipUri": "<string>",
"gateway": {
"port": 123,
"transport": "udp",
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"callerIdRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"transport": "udp",
"outboundProxy": "<string>",
"srtp": "none",
"expiry": 180,
"qualify": 0,
"line": true,
"pinHost": true,
"tlsVerify": {
"verify": true,
"wildcard": true,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 123,
"registration": {
"status": "<string>",
"nextRefreshS": 123,
"summary": "Registered, next refresh in 4 min"
}
}
],
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"maxConcurrent": 123
},
"configPublished": true,
"connectedAt": 123
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}Integrations
Connect a carrier account
Credentials are validated against the carrier first — a saved integration always means “these credentials worked”. One account, one integration, owning one SIP trunk; numbers are added to it over time.
The body is carrier-shaped: GET /v1/carriers names the required fields
per carrier. Twilio takes an API key pair or an account SID plus auth
token and is provisioned through its API; Exotel and Vobiz are
configured in the carrier’s portal and hand back a termination URI plus
credentials; pronto_connects is a messaging-only carrier with no trunk
and no numbers.
Credentials go to Secret Manager; only a reference and a non-reversible fingerprint are kept here.
POST
/
integrations
Connect a carrier account
curl --request POST \
--url https://apiv2.vodex.ai/v1/integrations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"terminationUri": "<string>",
"authUsername": "<string>",
"authPassword": "<string>",
"allowedIps": [
"<string>"
],
"port": 32768,
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"authId": "<string>",
"outboundProxy": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"outboundProxy": "<string>",
"expiry": 180,
"line": true,
"pinHost": true,
"tlsVerify": {
"verify": true,
"wildcard": true,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "1910",
"password": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 1
}
],
"maxConcurrent": 50,
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"accountId": "<string>",
"campaignId": "<string>",
"from": "<string>"
}
'import requests
url = "https://apiv2.vodex.ai/v1/integrations"
payload = {
"name": "<string>",
"accountSid": "<string>",
"apiKeySid": "<string>",
"apiKeySecret": "<string>",
"authToken": "<string>",
"apiKey": "<string>",
"apiSecret": "<string>",
"terminationUri": "<string>",
"authUsername": "<string>",
"authPassword": "<string>",
"allowedIps": ["<string>"],
"port": 32768,
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"authId": "<string>",
"outboundProxy": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"outboundProxy": "<string>",
"expiry": 180,
"line": True,
"pinHost": True,
"tlsVerify": {
"verify": True,
"wildcard": True,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "1910",
"password": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 1
}
],
"maxConcurrent": 50,
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"accountId": "<string>",
"campaignId": "<string>",
"from": "<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>',
accountSid: '<string>',
apiKeySid: '<string>',
apiKeySecret: '<string>',
authToken: '<string>',
apiKey: '<string>',
apiSecret: '<string>',
terminationUri: '<string>',
authUsername: '<string>',
authPassword: '<string>',
allowedIps: ['<string>'],
port: 32768,
dialRules: [{match: '+971', replace: '0'}],
connection: 'direct',
preset: '<string>',
authId: '<string>',
outboundProxy: '<string>',
register: {
server: '<string>',
port: 32768,
outboundProxy: '<string>',
expiry: 180,
line: true,
pinHost: true,
tlsVerify: {verify: true, wildcard: true, fingerprint: '<string>'}
},
identities: [
{
username: '1910',
password: '<string>',
authUsername: '<string>',
fromUser: '<string>',
maxConcurrent: 1
}
],
maxConcurrent: 50,
inboundNumber: '<string>',
inboundRules: [{match: '0', replace: '+971'}],
accountId: '<string>',
campaignId: '<string>',
from: '<string>'
})
};
fetch('https://apiv2.vodex.ai/v1/integrations', 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/integrations",
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>',
'accountSid' => '<string>',
'apiKeySid' => '<string>',
'apiKeySecret' => '<string>',
'authToken' => '<string>',
'apiKey' => '<string>',
'apiSecret' => '<string>',
'terminationUri' => '<string>',
'authUsername' => '<string>',
'authPassword' => '<string>',
'allowedIps' => [
'<string>'
],
'port' => 32768,
'dialRules' => [
[
'match' => '+971',
'replace' => '0'
]
],
'connection' => 'direct',
'preset' => '<string>',
'authId' => '<string>',
'outboundProxy' => '<string>',
'register' => [
'server' => '<string>',
'port' => 32768,
'outboundProxy' => '<string>',
'expiry' => 180,
'line' => true,
'pinHost' => true,
'tlsVerify' => [
'verify' => true,
'wildcard' => true,
'fingerprint' => '<string>'
]
],
'identities' => [
[
'username' => '1910',
'password' => '<string>',
'authUsername' => '<string>',
'fromUser' => '<string>',
'maxConcurrent' => 1
]
],
'maxConcurrent' => 50,
'inboundNumber' => '<string>',
'inboundRules' => [
[
'match' => '0',
'replace' => '+971'
]
],
'accountId' => '<string>',
'campaignId' => '<string>',
'from' => '<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/integrations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\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/integrations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/integrations")
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 \"accountSid\": \"<string>\",\n \"apiKeySid\": \"<string>\",\n \"apiKeySecret\": \"<string>\",\n \"authToken\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"apiSecret\": \"<string>\",\n \"terminationUri\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"authPassword\": \"<string>\",\n \"allowedIps\": [\n \"<string>\"\n ],\n \"port\": 32768,\n \"dialRules\": [\n {\n \"match\": \"+971\",\n \"replace\": \"0\"\n }\n ],\n \"connection\": \"direct\",\n \"preset\": \"<string>\",\n \"authId\": \"<string>\",\n \"outboundProxy\": \"<string>\",\n \"register\": {\n \"server\": \"<string>\",\n \"port\": 32768,\n \"outboundProxy\": \"<string>\",\n \"expiry\": 180,\n \"line\": true,\n \"pinHost\": true,\n \"tlsVerify\": {\n \"verify\": true,\n \"wildcard\": true,\n \"fingerprint\": \"<string>\"\n }\n },\n \"identities\": [\n {\n \"username\": \"1910\",\n \"password\": \"<string>\",\n \"authUsername\": \"<string>\",\n \"fromUser\": \"<string>\",\n \"maxConcurrent\": 1\n }\n ],\n \"maxConcurrent\": 50,\n \"inboundNumber\": \"<string>\",\n \"inboundRules\": [\n {\n \"match\": \"0\",\n \"replace\": \"+971\"\n }\n ],\n \"accountId\": \"<string>\",\n \"campaignId\": \"<string>\",\n \"from\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"carrier": "<string>",
"name": "<string>",
"accountRef": "<string>",
"accountName": "<string>",
"status": "connected",
"lastError": "<string>",
"trunkId": "<string>",
"carrierTrunkSid": "<string>",
"terminationUri": "<string>",
"credentialFingerprint": "<string>",
"hasCredentials": true,
"secretsBackend": "secret-manager",
"provisioning": "api",
"displayName": "<string>",
"transferSupport": "supported",
"channel": "voice",
"sipUri": "<string>",
"gateway": {
"port": 123,
"transport": "udp",
"dialRules": [
{
"match": "+971",
"replace": "0"
}
],
"callerIdRules": [
{
"match": "+971",
"replace": "0"
}
],
"connection": "direct",
"preset": "<string>",
"register": {
"server": "<string>",
"port": 32768,
"transport": "udp",
"outboundProxy": "<string>",
"srtp": "none",
"expiry": 180,
"qualify": 0,
"line": true,
"pinHost": true,
"tlsVerify": {
"verify": true,
"wildcard": true,
"fingerprint": "<string>"
}
},
"identities": [
{
"username": "<string>",
"authUsername": "<string>",
"fromUser": "<string>",
"maxConcurrent": 123,
"registration": {
"status": "<string>",
"nextRefreshS": 123,
"summary": "Registered, next refresh in 4 min"
}
}
],
"inboundNumber": "<string>",
"inboundRules": [
{
"match": "0",
"replace": "+971"
}
],
"maxConcurrent": 123
},
"configPublished": true,
"connectedAt": 123
}{
"error": "not found"
}{
"error": "not found"
}{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Body
application/json
Available options:
twilio, vonage, exotel, vobiz, sip-gateway, pronto_connects Twilio.
Twilio.
Twilio.
Twilio — alternative to the key pair.
Vonage / Pronto.
Vonage.
Manually provisioned carriers.
SIP gateway — omit for the SIP default.
Required range:
1 <= x <= 65535SIP gateway — omit to let the media layer choose.
Available options:
udp, tcp, tls SIP gateway: how the destination is written for the gateway, as POST /v1/integrations/{id}/gateway takes them.
Maximum array length:
10Show child attributes
Show child attributes
SIP gateway only. direct dials the gateway by IP. register has the
cell's SIP relay register to the system as a device or extension and
bridge calls both ways — for cloud UCaaS such as RingCentral and for a
PBX behind a vendor relay such as Yeastar's Remote Access Service.
registrar (the system registers to Vodex) is reserved and refused
until it ships. register needs Secret Manager behind the API.
Available options:
direct, register, registrar register only: the vendor preset that fills register (yeastar-ras, ringcentral, generic-pbx, generic-carrier). GET /v1/carriers lists them.
register only: the authorization id, where the vendor issues one distinct from the user name (RingCentral).
register only: the vendor's regional proxy, where it routes through one (sip20.ringcentral.com:5096).
register only: overrides to the preset's values; omitted fields take the preset's.
Show child attributes
Show child attributes
register only: the identities the relay registers. Omitted, authUsername/authPassword (and authId) are the one identity.
Maximum array length:
20Show child attributes
Show child attributes
register only, with the one-identity form: the calls that identity can carry at once (its extension's concurrent-call setting, a UCaaS device's fixed limit).
Required range:
1 <= x <= 100register only: the Vodex number an inbound call through the identity is presented as. Defaults to the gateway's first number.
register only: how the caller the system delivers is normalized.
Maximum array length:
10Show child attributes
Show child attributes
Pronto.
Pronto.
Pronto default sender (E.164).
Response
Connected.
Twilio Account SID or carrier SIP host — safe to show.
Available options:
connected, error The trunk id inside the carrier's account (API-provisioned carriers).
Non-reversible; for display and audit only.
Example:
"secret-manager"
Available options:
api, manual Available options:
supported, verify, unsupported An sms integration has no trunk and no numbers.
Available options:
voice, sms How a manually connected gateway is dialed; port and transport are null where unset. The register fields are empty on a direct gateway.
Show child attributes
Show child attributes
Present after a change to a registered gateway; whether the cell's relay snapshot reached the config bucket.