SIP Endpoints Module Documentation

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

---

1. Module Overview (Technical)

What Are SIP Endpoints?

SIP Endpoints is a registration monitoring interface that displays all currently registered SIP devices (phones, softphones, ATAs). It queries FreeSWITCH's registration database to show which devices are online, their IP addresses, protocols, and registration status.

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                 SIP Endpoints Architecture                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  SIP Devices                        FreeSWITCH                  │
│  ┌──────────────┐                  ┌─────────────────────────┐  │
│  │ Yealink T46U │                  │   mod_sofia             │  │
│  │ 192.168.1.10 │ ───REGISTER────► │                         │  │
│  │ ext: 1001    │                  │   Registration DB       │  │
│  └──────────────┘                  │   ├─ 1001: Online       │  │
│                                    │   ├─ 1002: Online       │  │
│  ┌──────────────┐                  │   ├─ 1003: Offline      │  │
│  │ Zoiper       │ ───REGISTER────► │   └─ 1004: Online       │  │
│  │ 192.168.1.15 │                  │                         │  │
│  │ ext: 1002    │                  └─────────────────────────┘  │
│  └──────────────┘                           │                   │
│                                             ▼                   │
│                                    ┌─────────────────────────┐  │
│                                    │   Backend API           │  │
│                                    │                         │  │
│                                    │   show registrations    │  │
│                                    │                         │  │
│                                    └─────────────────────────┘  │
│                                             │                   │
│                                             ▼                   │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        SIP Endpoints Page                                │   │
│  │                                                          │   │
│  │  Stats: 45 Total | UDP: 30 | TCP: 10 | TLS: 5           │   │
│  │                                                          │   │
│  │  ┌─────────────────────────────────────────────────────┐ │   │
│  │  │ Status │ Ext  │ IP           │ Port  │ Proto│Expires│ │   │
│  │  ├────────┼──────┼──────────────┼───────┼──────┼───────┤ │   │
│  │  │ 🟢     │ 1001 │ 192.168.1.10 │ 5060  │ UDP  │ 2:45  │ │   │
│  │  │ 🟢     │ 1002 │ 192.168.1.15 │ 5060  │ TCP  │ 1:30  │ │   │
│  │  └─────────────────────────────────────────────────────┘ │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Files

File	Description
`modules/sipEndpoints/`	Frontend module
FreeSWITCH mod_sofia	SIP registration handling

---

2. Module Overview (Commercial/Business)

Business Value

SIP Endpoints provides device visibility:

Without SIP Endpoints	With SIP Endpoints
Unknown device status	Online/Offline visible
No IP tracking	IP addresses shown
Blind troubleshooting	Device details available
Manual checking	Instant overview

Use Cases

Device Monitoring

- See all registered phones

- Identify offline devices

Troubleshooting

- Find device IP address

- Check registration status

Capacity Planning

- Total registration count

- Protocol distribution

Security

- Monitor registrations

- Identify unknown devices

Feature Highlights

Feature	Benefit
Online/Offline	Device status
IP Address	Network location
Protocol	UDP/TCP/TLS
Expiry Timer	Registration health
Search	Find specific devices
Stats	Registration overview

---

3. Module Overview (End User/Administrator)

What Can You Do?

View all registered SIP devices
See online/offline status
Check IP addresses and ports
View protocol (UDP/TCP/TLS)
Monitor registration expiry
Search by extension or IP

SIP Endpoints Interface

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│              SIP Endpoints                                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Active SIP registrations from FreeSWITCH                       │
│                                                                 │
│  [🔄 Refresh]  🔍 [Search by extension, IP, or hostname...   ] │
│                                                                 │
│  📊 Stats:                                                      │
│  ├─ Total Registrations: 45                                     │
│  ├─ By Protocol: UDP: 30 | TCP: 10 | TLS: 5                    │
│  └─ By Hostname: pbx1: 25 | pbx2: 20                           │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │Status│ Ext  │ IP Address   │ Port │Proto│ Realm  │Expires│  │
│  ├──────┼──────┼──────────────┼──────┼─────┼────────┼───────┤  │
│  │ 🟢   │ 1001 │192.168.1.10  │ 5060 │ UDP │domain1 │ 02:45 │  │
│  │ 🟢   │ 1002 │192.168.1.15  │ 5060 │ TCP │domain1 │ 01:30 │  │
│  │ 🟢   │ 1003 │192.168.1.20  │ 5061 │ TLS │domain1 │ 04:15 │  │
│  │ 🔴   │ 1004 │     -        │  -   │  -  │domain1 │ Exp.  │  │
│  │ 🟢   │ 1005 │10.0.0.50     │ 5060 │ UDP │domain2 │ 03:00 │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
│  🟢 Online: 44  |  🔴 Offline: 1                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

Refresh: Click Refresh to get latest registration data.

TIP

Search: Search by extension number or IP address.

NOTE

Expiry: Low expiry time is normal - devices re-register automatically.

---

4. Registration Fields Reference

Display Columns

Column	Description
Status	Online (🟢) or Offline (🔴)
Extension	Extension/user ID
IP Address	Device IP address
Port	SIP port number
Protocol	UDP, TCP, or TLS
Realm	Registration realm/domain
Hostname	FreeSWITCH server
Expires In	Time until re-registration
SIP URL	Full SIP contact URL

Status Types

Status	Description
🟢 Online	Device is registered
🔴 Offline	Registration expired

Protocols

Protocol	Port	Description
UDP	5060	Standard SIP
TCP	5060	Reliable SIP
TLS	5061	Encrypted SIP

---

5. Common Scenarios & Examples

Scenario 1: Check If Phone Is Online

Open SIP Endpoints
Search for extension number
Check status (🟢 or 🔴)

Scenario 2: Find Device IP Address

Search by extension
Note the IP Address
Use for network troubleshooting

Scenario 3: Monitor Protocol Usage

View Stats section
Check "By Protocol" breakdown
Verify TLS adoption

Scenario 4: Identify Offline Devices

Look for 🔴 status
Note affected extensions
Troubleshoot connectivity

---

6. Limitations & Important Notes

Technical Notes

NOTE

Registration Window: Devices typically register every 60-300 seconds.

NOTE

Multi-Device: One extension can have multiple registrations.

WARNING

Network Issues: Offline status may indicate network problems.

Best Practices

Regular Monitoring: Check for unexpected offline devices
Protocol Review: Encourage TLS for security
IP Tracking: Note unusual IP changes
Expiry Health: Very short expiry may indicate issues
Search Smart: Use partial matching

---

7. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
Device offline	Network issue	Check connectivity
Wrong IP	NAT issue	Configure NAT
Short expiry	Firewall	Check SIP ALG
No registration	Credentials	Verify username/password
Multiple entries	Multi-device	Normal for multiple phones

Diagnostic Commands

FreeSWITCH CLI:

Bash

# Show all registrations
fs_cli -x "show registrations"

# Show specific profile registrations
fs_cli -x "sofia status profile internal reg"

# Show registration count
fs_cli -x "show registrations count"

Diagnostic SQL

Check extension registration status:

Sql

-- Extensions are in telephony database
-- Registrations are live in FreeSWITCH
SELECT extension, effective_caller_id_name 
FROM public.sip_extensions
WHERE domain_id = [domain_id]
  AND enabled = true;

---

8. Glossary

Term	Definition
SIP	Session Initiation Protocol
Registration	Device announcing presence
Endpoint	SIP device (phone, softphone)
Realm	SIP domain for registration
Expiry	Time until registration expires
mod_sofia	FreeSWITCH SIP module
NAT	Network Address Translation

---

Lua Script Status ℹ️

No Lua Handler Required

Component	Status
SIP Endpoints	ℹ️ Frontend module - queries FreeSWITCH registrations via API

SIP Endpoints queries live registration data from FreeSWITCH's mod_sofia. No Lua handlers are used.

---

Documentation last updated: January 2026

SIP Endpoints Module Documentation

Table of Contents

1. Module Overview (Technical)

What Are SIP Endpoints?

Architecture

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

SIP Endpoints Interface

Quick Tips

4. Registration Fields Reference

Display Columns

Status Types

Protocols

5. Common Scenarios & Examples

Scenario 1: Check If Phone Is Online

Scenario 2: Find Device IP Address

Scenario 3: Monitor Protocol Usage

Scenario 4: Identify Offline Devices

6. Limitations & Important Notes

Technical Notes

Best Practices

7. Troubleshooting Tips

Common Issues

Diagnostic Commands

Diagnostic SQL

8. Glossary

Lua Script Status ℹ️

No Lua Handler Required