List numbers
curl --request GET \
--url https://apiv2.vodex.ai/v1/phone-numbers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiv2.vodex.ai/v1/phone-numbers"
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/phone-numbers', 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/phone-numbers",
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/phone-numbers"
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/phone-numbers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/phone-numbers")
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": "num-14155551234",
"e164": "<string>",
"scope": "tenant",
"ownership": "platform",
"carrier": "twilio",
"trunkId": "<string>",
"region": "us",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": {
"inbound": true,
"outbound": true
},
"label": "<string>"
}
]{
"error": "not found"
}Phone Numbers
List numbers
GET
/
phone-numbers
List numbers
curl --request GET \
--url https://apiv2.vodex.ai/v1/phone-numbers \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiv2.vodex.ai/v1/phone-numbers"
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/phone-numbers', 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/phone-numbers",
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/phone-numbers"
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/phone-numbers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.vodex.ai/v1/phone-numbers")
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": "num-14155551234",
"e164": "<string>",
"scope": "tenant",
"ownership": "platform",
"carrier": "twilio",
"trunkId": "<string>",
"region": "us",
"assistantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": {
"inbound": true,
"outbound": true
},
"label": "<string>"
}
]{
"error": "not found"
}Authorizations
Tenant API key (vdx_live_…) as Authorization: Bearer.
Response
Numbers.
Example:
"num-14155551234"
platform marks a Vodex-owned shared caller ID: usable as fromNumberId for outbound calls and batches by every workspace, outbound-only, and read-only — PATCH and DELETE return 403. Distinct from ownership, which says whose carrier trunk the number rides.
Available options:
tenant, platform Available options:
platform, byo-trunk Available options:
twilio, vonage, exotel, vobiz The number's MARKET, derived from its prefix on read. Never stored and never sent — the tenant's region decides which cell serves the number (0016 §3). Absent for a prefix in neither market.
Available options:
us, in The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.
Show child attributes
Show child attributes