Skip to main content
Version: Unreleased

SBC Live Calls Dashboard

BETA

Welcome to the SBC Live Calls Dashboard! This dashboard provides real-time insights into active calls managed by the Session Border Controller (SBC), helping you monitor, analyze, and troubleshoot call activity with ease.


Setup and Access

For the Monitor to access SBC data, ensure the following requirements are met:

  1. Required permissions are granted in the CCM
  2. Firewall allows required traffic (SBC 5.5 and below only)
  3. Authentication tokens are configured

Authentication Methods

Choose one of the following authentication methods based on your SBC version:

Method 1: Token Authentication (SBC 5.6+)

For SBC version 5.6 and above, use API tokens for authentication. Tokens can be configured in two ways:

Via UI (Recommended):

  1. Navigate to the Access tab in Settings
  2. Configure the appropriate token:
    • SBC Config: Enter the SBC authentication token
    • Monitor Config: Enter the CCM authentication token (optional)

Via Environment Variables:

Set the following environment variables on your Monitor server:

export SBC_AUTH_TOKEN="your-sbc-token-here"
export CCM_AUTH_TOKEN="your-ccm-token-here"

Generating SBC Tokens:

Tokens are generated in the CCM at:

https://<ccm_URL>:<ccm_port>/ccm/tokens.php

SBC API Token generation page

When creating a token:

  1. Set Enabled to true
  2. Select never expire for a long-lived token
  3. Choose SBC API as the token type
  4. Assign SBC: Status and Monitoring permissions

Note: The CCM token is optional. It is only required if the current user's permissions do not allow access to the API endpoints.

For SBC version 5.5 and below, use cookie-based authentication by including the ccmAuth cookie in the request header.

info

After configuring tokens via the UI or environment variables, allow 30-60 seconds for the settings to propagate before the dashboard will work correctly.

Required Permissions in CCM

For setting up and accessing the SBC Live Calls Dashboard, ensure you have the following permissions in the CCM for the relevant account:

info

Only view permissions are required for the following sections

  • ABC Monitor
  • REST API
  • Monitoring: Registration cache
  • Monitoring: Live calls
  • Monitoring: Destination Blacklist
  • Monitoring: Registration cache
  • Monitoring: Live calls
  • Monitoring: Destination Blacklist
  • Monitoring: Registration Agents
  • Monitoring: Call Agents status
  • Monitoring: Conference Rooms
  • Monitoring: System status
  • Monitoring: User Recent Traffic
  • Monitoring: View logs
  • System: Config Groups

Firewall Configuration

note

If you are using SBC version 5.5 or lower and the firewall is enabled, you need to add a rule to allow the Monitor to access the SBC data. For SBC version 5.6 and above, use SBC API tokens instead.

If the firewall is disabled, you can skip this step.

Firewall settings page

  • Go to System > Firewall and add to the Manual Low Level Rules the following rule to allow the Monitor to access the SBC data:

    Firewall rule entry example

  • Just replace the src IP address with the IP address of the Monitor and save the changes.

Dashboard Overview

SBC Live Calls Main Page

The dashboard features:

  • Real-time call statistics
  • Active call monitoring
  • Quick issue identification
  • Visual analytics for efficient troubleshooting

Dashboard Tabs

Easily navigate between different views and data sets:

SBC Live Calls Dashboard Tabs


note

For more details, explore the tabs above or refer to the documentation sidebar.