Skip to main content
GET
/
api
/
v2
/
platform
/
telephony
/
bridges
/
{slug}
Get Bridge by Slug
curl --request GET \
  --url http://localhost:3001/api/v2/platform/telephony/bridges/{slug}/ \
  --header 'Authorization: <api-key>' \
  --header 'Org-Handle: <org-handle>'
{
  "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,
        "status": "active"
      }
    ]
  }
}

{
  "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,
        "status": "active"
      }
    ]
  }
}

​
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

NameTypeRequiredDescription
slugstringYesUnique 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

NameTypeRequiredDescription
AuthorizationstringYesAPI Key format: Token <token>
Org-HandlestringYesOrganization 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

FieldTypeDescription
status_codeintegerHTTP status code
messagestringResponse message
dataobjectBridge details

​
Bridge Object Fields

FieldTypeDescription
idintegerBridge unique identifier
namestringBridge display name
slugstringUnique bridge slug identifier
numbersarrayList of assigned phone numbers

​
Number Object Fields

FieldTypeDescription
idintegerNumber assignment ID
number_idintegerPhone number ID
numberstringPhone number (E.164 format)
statestringNumber state: ASSIGNED, UNASSIGNED
activebooleanWhether number is active
channels_countintegerNumber of active channels
statusstringNumber status: active, inactive

​
Common Error Codes

Status CodeDescription
200Success - Bridge fetched successfully
401Unauthorized - Invalid or missing API token
403Forbidden - Invalid organization handle
404Not Found - Bridge not found
500Internal 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.dev/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');

​
Best Practices

  1. Slug Validation: Handle 404 errors when a bridge slug may have been deleted or renamed
  2. Number Inspection: Check the numbers array to verify active phone numbers before routing calls
  3. Active Status: Only numbers with active: true and status: active are ready to handle calls
  4. Error Handling: Always handle potential errors and edge cases
  5. 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"

Path Parameters

​
slug
string
required
Example:

"sales-bridge"

Response

Bridge details