Calls
Telephony Overview
Per-number lifecycle: connection state, termination, agent link, sync state
GET
/
api
/
v2
/
platform
/
telephony
/
overview
/
Telephony Overview
curl --request GET \
--url https://unpod.ai/api/v2/platform/telephony/overview/ \
--header 'Authorization: <api-key>' \
--header 'Org-Handle: <org-handle>'import requests
url = "https://unpod.ai/api/v2/platform/telephony/overview/"
headers = {
"Org-Handle": "<org-handle>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};
fetch('https://unpod.ai/api/v2/platform/telephony/overview/', 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://unpod.ai/api/v2/platform/telephony/overview/",
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: <api-key>",
"Org-Handle: <org-handle>"
],
]);
$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://unpod.ai/api/v2/platform/telephony/overview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Org-Handle", "<org-handle>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/telephony/overview/")
.header("Org-Handle", "<org-handle>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://unpod.ai/api/v2/platform/telephony/overview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"message": "Telephony overview fetched successfully.",
"data": [
{
"number_id": 501,
"number": "+15551234567",
"bridge_slug": "support-bridge",
"connection_state": "LINKED",
"termination_kind": "sip",
"agent_id": null,
"sync_state": "synced",
"sync_detail": null
}
]
}
{ "message": "Please provide Org-Handle in headers" }
A per-number lifecycle overview for your organization: one row per
ASSIGNED number on
your bridges, exposing connection_state, termination kind, agent link, and the
projection sync_state. This endpoint is DB-only - it never live-probes the projection
planes, so it stays fast and never errors on a missing projection. Secrets are masked.
Prerequisites: API Token + Org-Handle. See Authentication.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Token <your-api-key> |
| Org-Handle | string | Yes | Organization domain handle |
| Product-Id | string | No | Optional product filter |
Row fields
| Field | Type | Description |
|---|---|---|
| number_id | integer | Number id |
| number | string | E.164 number |
| bridge_slug | string | Bridge the number is on |
| connection_state | string | e.g. LINKED, NOT_LINKED |
| termination_kind | string | sip (carrier) or agent |
| agent_id | string | Linked agent handle (null for carrier) |
| sync_state | string | Projection sync state |
| sync_detail | string | Extra sync detail (nullable) |
{
"status_code": 200,
"message": "Telephony overview fetched successfully.",
"data": [
{
"number_id": 501,
"number": "+15551234567",
"bridge_slug": "support-bridge",
"connection_state": "LINKED",
"termination_kind": "sip",
"agent_id": null,
"sync_state": "synced",
"sync_detail": null
}
]
}
{ "message": "Please provide Org-Handle in headers" }
cURL
curl -s "https://unpod.ai/api/v2/platform/telephony/overview/" \
-H "Authorization: Token <your-api-key>" \
-H "Org-Handle: <your-org-handle>"
Was this page helpful?
⌘I
Telephony Overview
curl --request GET \
--url https://unpod.ai/api/v2/platform/telephony/overview/ \
--header 'Authorization: <api-key>' \
--header 'Org-Handle: <org-handle>'import requests
url = "https://unpod.ai/api/v2/platform/telephony/overview/"
headers = {
"Org-Handle": "<org-handle>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Org-Handle': '<org-handle>', Authorization: '<api-key>'}
};
fetch('https://unpod.ai/api/v2/platform/telephony/overview/', 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://unpod.ai/api/v2/platform/telephony/overview/",
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: <api-key>",
"Org-Handle: <org-handle>"
],
]);
$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://unpod.ai/api/v2/platform/telephony/overview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Org-Handle", "<org-handle>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://unpod.ai/api/v2/platform/telephony/overview/")
.header("Org-Handle", "<org-handle>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://unpod.ai/api/v2/platform/telephony/overview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Org-Handle"] = '<org-handle>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status_code": 200,
"message": "Telephony overview fetched successfully.",
"data": [
{
"number_id": 501,
"number": "+15551234567",
"bridge_slug": "support-bridge",
"connection_state": "LINKED",
"termination_kind": "sip",
"agent_id": null,
"sync_state": "synced",
"sync_detail": null
}
]
}
{ "message": "Please provide Org-Handle in headers" }