The carrier registry
curl --request GET \
--url https://apiv2.vodex.ai/v1/carriers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiv2.vodex.ai/v1/carriers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiv2.vodex.ai/v1/carriers', 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/carriers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/carriers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.vodex.ai/v1/carriers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/carriers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "twilio",
"displayName": "<string>",
"markets": [
"us"
],
"provisioning": "api",
"fields": [
{
"key": "<string>",
"label": "<string>",
"secret": true,
"optional": true,
"hint": "<string>"
}
],
"transfer": "supported",
"notes": "<string>"
}
]{
"error": "not found"
}Carriers
The carrier registry
What the console can offer and how each carrier connects. This is the
file where “adding a carrier touches trunk config and an adapter, never
the worker or the media path” actually lives — fields keys land
verbatim in the POST /v1/integrations body, so the connect form is
data-driven rather than a chain of if (carrier === …).
GET
/
carriers
The carrier registry
curl --request GET \
--url https://apiv2.vodex.ai/v1/carriers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiv2.vodex.ai/v1/carriers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiv2.vodex.ai/v1/carriers', 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/carriers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiv2.vodex.ai/v1/carriers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiv2.vodex.ai/v1/carriers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/carriers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "twilio",
"displayName": "<string>",
"markets": [
"us"
],
"provisioning": "api",
"fields": [
{
"key": "<string>",
"label": "<string>",
"secret": true,
"optional": true,
"hint": "<string>"
}
],
"transfer": "supported",
"notes": "<string>"
}
]{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Response
Carriers.
Available options:
twilio, vonage, exotel, vobiz, sip-gateway, pronto_connects Available options:
us, in api = we create the trunk in the customer's account; manual = they configure it in the portal and hand back host and credentials.
Available options:
api, manual Connect-form fields — keys land verbatim in the POST /v1/integrations body.
Show child attributes
Show child attributes
REFER (cold transfer) support.
Available options:
supported, verify, unsupported