Skip to main content
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

NameTypeRequiredDescription
AuthorizationstringYesToken <your-api-key>
Org-HandlestringYesOrganization domain handle
Product-IdstringNoOptional product filter

​
Row fields

FieldTypeDescription
number_idintegerNumber id
numberstringE.164 number
bridge_slugstringBridge the number is on
connection_statestringe.g. LINKED, NOT_LINKED
termination_kindstringsip (carrier) or agent
agent_idstringLinked agent handle (null for carrier)
sync_statestringProjection sync state
sync_detailstringExtra 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>"

Authorizations

​
Authorization
string
header
required

Format: Token

Headers

​
Org-Handle
string
required

Organization domain handle

Example:

"unpod.tv"

​
Product-Id
string

Product scope for the auto-resolved bridge (default unpod.dev)

Example:

"unpod.dev"

Response

Per-number lifecycle overview for the organization