GET

api

platform

telephony

bridges

{slug}

Get Bridge by Slug

curl --request GET \
  --url https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/"

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/bridges/{slug}/', 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/bridges/{slug}/",
  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/bridges/{slug}/"

	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/bridges/{slug}/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/")

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": "Bridge fetched successfully.",
  "data": {
    "id": 314,
    "name": "Sales Bridge",
    "slug": "sales-bridge-001",
    "numbers": [
      {
        "id": 501,
        "number_id": 25,
        "number": "+1234567890",
        "state": "ASSIGNED",
        "active": true,
        "channels_count": 2,
        "status": "active"
      }
    ]
  }
}

{
  "status_code": 404,
  "message": "Bridge not found.",
  "errors": "No bridge exists with the provided slug"
}

{
  "status_code": 200,
  "message": "Bridge fetched successfully.",
  "data": {
    "id": 314,
    "name": "Sales Bridge",
    "slug": "sales-bridge-001",
    "numbers": [
      {
        "id": 501,
        "number_id": 25,
        "number": "+1234567890",
        "state": "ASSIGNED",
        "active": true,
        "channels_count": 2,
        "status": "active"
      }
    ]
  }
}

{
  "status_code": 404,
  "message": "Bridge not found.",
  "errors": "No bridge exists with the provided slug"
}

Get Bridge by Slug

Retrieve full details of a specific telephony bridge using its unique slug identifier, including its assigned phone numbers and current configuration.

Prerequisites: Make sure you have your API Token and Org-Handle ready. See Authentication for details.

Path Parameters

Name	Type	Required	Description
slug	string	Yes	Unique bridge slug

You can get the bridge slug by hitting the Get All Bridges API. The slug field in the response is your Bridge Slug.

Headers

Name	Type	Required	Description
Authorization	string	Yes	API Key format: `Token <token>`
Org-Handle	string	Yes	Organization domain handle

You can get the Org-Handle by hitting the Get All Organizations API. The domain_handle field in the response is your Org-Handle.

Response Fields

Field	Type	Description
status_code	integer	HTTP status code
message	string	Response message
data	object	Bridge details

Bridge Object Fields

Field	Type	Description
id	integer	Bridge unique identifier
name	string	Bridge display name
slug	string	Unique bridge slug identifier
numbers	array	List of assigned phone numbers

Number Object Fields

Field	Type	Description
id	integer	Number assignment ID
number_id	integer	Phone number ID
number	string	Phone number (E.164 format)
state	string	Number state: `ASSIGNED`, `UNASSIGNED`
active	boolean	Whether number is active
channels_count	integer	Number of active channels
status	string	Number status: `active`, `inactive`

Common Error Codes

Status Code	Description
200	Success - Bridge fetched successfully
401	Unauthorized - Invalid or missing API token
403	Forbidden - Invalid organization handle
404	Not Found - Bridge not found
500	Internal Server Error - Server-side error

Code Examples

const axios = require('axios');

const headers = {
  'Authorization': 'Token your-api-token',
  'Org-Handle': 'your-org-handle'
};

// Get bridge by slug
const getBridgeBySlug = async (slug) => {
  const response = await axios.get(
    `https://unpod.ai/api/v2/platform/telephony/bridges/${slug}/`,
    { headers }
  );
  const bridge = response.data.data;
  console.log(`Bridge: ${bridge.name} (${bridge.slug})`);
  console.log(`Assigned numbers: ${bridge.numbers.length}`);
  return bridge;
};

// Example usage
getBridgeBySlug('sales-bridge-001');

import requests

headers = {
    'Authorization': 'Token your-api-token',
    'Org-Handle': 'your-org-handle'
}

def get_bridge_by_slug(slug: str):
    """Get bridge details by slug"""
    url = f'https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/'
    response = requests.get(url, headers=headers)
    data = response.json()
    bridge = data['data']
    print(f"Bridge: {bridge['name']} ({bridge['slug']})")
    print(f"Assigned numbers: {len(bridge['numbers'])}")
    return bridge

# Example usage
get_bridge_by_slug('sales-bridge-001')

# Get bridge by slug
curl -X GET "https://unpod.ai/api/v2/platform/telephony/bridges/sales-bridge-001/" \
  -H "Authorization: Token your-api-token" \
  -H "Org-Handle: your-org-handle"

Best Practices

Slug Validation: Handle 404 errors when a bridge slug may have been deleted or renamed
Number Inspection: Check the numbers array to verify active phone numbers before routing calls
Active Status: Only numbers with active: true and status: active are ready to handle calls
Error Handling: Always handle potential errors and edge cases
Security: Keep API tokens secure and rotate them regularly

Authorizations

Authorization

string

header

required

Format: Token

Headers

Org-Handle

string

required

Organization domain handle

Example:

"unpod.tv"

Path Parameters

slug

string

required

Example:

"sales-bridge-001"

Response

Bridge details

Update BridgeUpdate an existing telephony bridge configuration

Get Bridge by Slug

curl --request GET \
  --url https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'

import requests

url = "https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/"

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/bridges/{slug}/', 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/bridges/{slug}/",
  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/bridges/{slug}/"

	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/bridges/{slug}/")
  .header("Org-Handle", "<org-handle>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://unpod.ai/api/v2/platform/telephony/bridges/{slug}/")

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": "Bridge fetched successfully.",
  "data": {
    "id": 314,
    "name": "Sales Bridge",
    "slug": "sales-bridge-001",
    "numbers": [
      {
        "id": 501,
        "number_id": 25,
        "number": "+1234567890",
        "state": "ASSIGNED",
        "active": true,
        "channels_count": 2,
        "status": "active"
      }
    ]
  }
}

{
  "status_code": 404,
  "message": "Bridge not found.",
  "errors": "No bridge exists with the provided slug"
}

Getting Started

API Lists

Get Bridge by Slug

Get Bridge by Slug

Path Parameters

Headers

Response Fields

Bridge Object Fields

Number Object Fields

Common Error Codes

Code Examples

Best Practices

Authorizations

Headers

Path Parameters

Response

​Get Bridge by Slug

​Path Parameters

​Headers

​Response Fields

​Bridge Object Fields

​Number Object Fields

​Common Error Codes

​Code Examples

​Best Practices

Authorizations

Headers

Path Parameters

Response

Get Bridge by Slug

Path Parameters

Headers

Response Fields

Bridge Object Fields

Number Object Fields

Common Error Codes

Code Examples

Best Practices