Active Calls Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Call Fields Reference
Call States
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Are Active Calls?

Active Calls is a real-time call monitoring interface that displays all currently active calls on the PBX. It queries FreeSWITCH's live channel data to show callers, destinations, call states, duration, and technical details.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                  Active Calls Architecture                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        ActiveCallsPage.tsx                               │   │
│  │                                                          │   │
│  │  [🔄 Refresh]  🔍 [Search...              ]             │   │
│  │                                                          │   │
│  │  ┌─────────────────────────────────────────────────────┐ │   │
│  │  │ Dir │ Caller │ Dest   │ State  │ Duration │ Codec  │ │   │
│  │  ├─────┼────────┼────────┼────────┼──────────┼────────┤ │   │
│  │  │ OUT │ 1001   │ +1555..│ ACTIVE │ 00:05:23 │ G722   │ │   │
│  │  │ IN  │ +1555..│ 1002   │ RING   │ 00:00:12 │ PCMU   │ │   │
│  │  │ INT │ 1003   │ 1004   │ HELD   │ 00:02:45 │ OPUS   │ │   │
│  │  └─────────────────────────────────────────────────────┘ │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ API Query (Real-time)                                   │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Backend API                                       │   │
│  │                                                          │   │
│  │  fs_cli: show channels                                   │   │
│  │                                                          │   │
│  │  Returns: Live channel data from FreeSWITCH              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼                                                         │
│  FreeSWITCH (mod_commands)                                      │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Files

File	Description
`modules/activeCalls/ActiveCallsPage.tsx`	Main page
`modules/activeCalls/api.ts`	API calls to backend

---

2. Module Overview (Commercial/Business)

Business Value

Active Calls provides live call visibility:

Without Active Calls	With Active Calls
Blind to current calls	Real-time view
No call monitoring	Live state tracking
Unknown capacity	Current load visible
Manual checking	Instant refresh

Use Cases

Capacity Monitoring

- See current call volume

- Identify peak times

Troubleshooting

- Debug call issues live

- See codec and IP info

Supervision

- Monitor call center

- Track long calls

Operations

- System health check

- Network visibility

Feature Highlights

Feature	Benefit
Real-time	Live call data
Search	Find specific calls
Call States	Ringing, Active, Held
Duration	Running call length
Technical Info	Codec, IP address
Refresh	Manual or auto update

---

3. Module Overview (End User/Administrator)

What Can You Do?

View all active calls in real-time
Search by caller, destination, or IP
See call direction (In/Out/Internal)
Monitor call states
Track call duration
View technical details

Active Calls Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              Active Calls                                       │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [🔄 Refresh]  🔍 [Search by caller, destination, IP...      ] │
│                                                                 │
│  📊 Active Calls: 5 | 📥 Inbound: 2 | 📤 Outbound: 2 | 🔄 Int: 1│
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Dir  │ Caller     │ Destination │ State  │ Duration│Codec│  │
│  ├──────┼────────────┼─────────────┼────────┼─────────┼─────┤  │
│  │ 📤   │ 1001       │+15551234567 │ ACTIVE │ 00:05:23│G722 │  │
│  │ 📥   │+15559876543│ 1002        │ RINGING│ 00:00:12│PCMU │  │
│  │ 🔄   │ 1003       │ 1004        │ ACTIVE │ 00:02:45│OPUS │  │
│  │ 📤   │ 1005       │+15555551234 │ EARLY  │ 00:00:05│G711 │  │
│  │ 📥   │+15557771234│ 1010        │ HELD   │ 00:08:32│PCMU │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  Showing 5 active calls                                         │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

Refresh: Click Refresh button to update call list.

TIP

Search: Search by any field - caller, destination, IP, codec.

NOTE

Real-time: Data is live but not auto-refreshing - manual refresh needed.

---

4. Call Fields Reference

Display Columns

Column	Description
Direction	Inbound/Outbound/Internal
Caller	Calling party number
Destination	Called party number
State	Current call state
Duration	Time since call started
Codec	Audio codec in use
IP Address	Remote endpoint IP
Context	FreeSWITCH context
Hostname	FreeSWITCH server

Direction Types

Direction	Icon	Description
Inbound	📥	Incoming from external
Outbound	📤	Outgoing to external
Internal	🔄	Extension to extension

---

5. Call States

State Types

State	Description	Color
ACTIVE	Call in progress	🟢 Green
RINGING	Destination ringing	🟡 Yellow
EARLY	Early media (ringback)	🟡 Yellow
HELD	Call on hold	🟠 Orange
HANGUP	Call ending	🔴 Red

State Flow

Plaintext

EARLY → RINGING → ACTIVE → HELD → ACTIVE → HANGUP
  │                  │              ↑
  │                  └──────────────┘
  └──── (ringback/progress) ────────┘

---

6. Common Scenarios & Examples

Scenario 1: Monitor Call Volume

Open Active Calls
View total count
Watch during peak hours

Scenario 2: Find Specific Call

Enter phone number in search
Locate the call
View details

Scenario 3: Debug Call Issue

Find affected call
Check state (stuck in RINGING?)
Note codec and IP

Scenario 4: Check Long Calls

Sort by duration
Identify unusually long calls
Investigate if needed

---

7. Limitations & Important Notes

Technical Notes

NOTE

Snapshot: Data shows point-in-time snapshot.

NOTE

Manual Refresh: Auto-refresh not enabled by default.

WARNING

Gone Quickly: Short calls may not appear.

Best Practices

Regular Refresh: Update frequently during monitoring
Use Search: Find specific calls quickly
Check States: Understand what each state means
Note IPs: Useful for network troubleshooting
Watch Duration: Identify stuck or long calls

---

8. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
No calls shown	No active calls	Normal if system idle
Stale data	Not refreshed	Click Refresh
Search no match	Wrong format	Try partial number
Call stuck	FreeSWITCH issue	Check FS logs
High count	Peak load	Normal during busy

Diagnostic Commands

FreeSWITCH CLI:

Bash

# Show all active channels
fs_cli -x "show channels"

# Show call count
fs_cli -x "show calls count"

# Show channel by UUID
fs_cli -x "uuid_dump <uuid>"

---

9. Glossary

Term	Definition
Active Call	Currently connected call
Channel	FreeSWITCH call leg
Codec	Audio encoding (G711, G722, Opus)
RINGING	Destination alerting
EARLY	Early media before answer
HELD	Call on hold
Context	FreeSWITCH dialplan context

---

Lua Script Status ℹ️

No Lua Handler Required

Component	Status
Active Calls	ℹ️ Frontend module - queries FreeSWITCH via backend API

Active Calls queries live channel data from FreeSWITCH using mod_commands. No Lua handlers are used.

---

Documentation last updated: January 2026

Active Calls Module Documentation

Table of Contents

1. Module Overview (Technical)

What Are Active Calls?

Architecture

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

Active Calls Interface

Quick Tips

4. Call Fields Reference

Display Columns

Direction Types

5. Call States

State Types

State Flow

6. Common Scenarios & Examples

Scenario 1: Monitor Call Volume

Scenario 2: Find Specific Call

Scenario 3: Debug Call Issue

Scenario 4: Check Long Calls

7. Limitations & Important Notes

Technical Notes

Best Practices

8. Troubleshooting Tips

Common Issues

Diagnostic Commands

9. Glossary

Lua Script Status ℹ️

No Lua Handler Required