Speed Dials Module Documentation

Module Overview (Technical)
Module Overview (Commercial/Business)
Module Overview (End User/Administrator)
Configuration Fields Reference
Call Flow / Logic Explanation
Import/Export Feature
Common Scenarios & Examples
Limitations & Important Notes
Troubleshooting Tips
Glossary

---

1. Module Overview (Technical)

What Are Speed Dials?

Speed Dials are shortcut codes that map to full destination numbers. Users dial a short code (like 202) and the system automatically dials the full number (like +1-555-123-4567).

Architecture

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                    Speed Dial System                            │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  User dials: 202 (speed dial code)                              │
│       │                                                         │
│       ▼                                                         │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │              Speed Dial Lookup                           │   │
│  │  SELECT * FROM speed_dials                               │   │
│  │  WHERE speed_code = '202' AND enabled = true             │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼                                                         │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │              Found: destination = '+15551234567'         │   │
│  │                                                          │   │
│  │  Check Class of Service (if specified):                  │   │
│  │  ├─ CoS specified → Verify caller has permission        │   │
│  │  └─ CoS empty → Inherit from caller's extension         │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼                                                         │
│  Dial +1-555-123-4567 using normal outbound routing             │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

Table	Purpose
`public.speed_dials`	Speed dial definitions (code, destination, CoS)
`public.class_of_services`	Referenced for CoS restrictions

Destination Formats

Format	Example	Description
E.164	`+15551234567`	Full international number
Extension	`1001`	Internal extension
SIP URI	`user/1000`	Direct SIP addressing
Local	`5551234567`	Local number format

Key Files

File	Description
`admin/apps/web/src/modules/speedDials/`	Frontend module
`admin/apps/web/src/i18n/en/speedDials.json`	English translations
`admin/apps/web/src/modules/speedDials/ImportSpeedDialsModal.tsx`	CSV import

---

2. Module Overview (Commercial/Business)

Business Value

Speed Dials simplify dialing for frequently called numbers:

Without Speed Dials	With Speed Dials
Dial +1-555-123-4567	Dial 202
Remember long numbers	Remember short codes
Error-prone dialing	Consistent, accurate

Use Cases

Frequently Called Numbers

- Main office: 201

- IT Support: 202

- CEO Mobile: 203

Vendor/Partner Hotlines

- Supplier A: 301

- Supplier B: 302

- Bank: 303

Emergency Services

- Building Security: 911

- Fire Department: 9411

International Offices

- London Office: 401

- Tokyo Office: 402

- Sydney Office: 403

Feature Highlights

Feature	Benefit
Short Codes	Easy to remember (202, 801)
CoS Restriction	Limit who can use each speed dial
CSV Import	Bulk upload speed dials
CSV Export	Backup or migrate settings
Flexible Destinations	E.164, extensions, SIP URIs

---

3. Module Overview (End User/Administrator)

What Can You Do?

Create speed dial codes mapped to full numbers
Restrict speed dials by Class of Service
Import speed dials from CSV files
Export speed dials to CSV for backup

Administrator Workflow

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                 Creating a Speed Dial                           │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  1. General Information                                         │
│     ├─ Speed Dial Code: 202                                    │
│     ├─ Destination: +1-555-123-4567                            │
│     └─ Description: "Main Office Line"                         │
│                                                                 │
│  2. Access Control (Optional)                                   │
│     └─ Class of Service: None (everyone can use)               │
│                                                                 │
│  3. Enable and Save                                             │
│     └─ Enabled: ✓                                              │
│                                                                 │
│  Result: Users dial 202 → System dials +1-555-123-4567         │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP

Use Meaningful Codes: 201-299 for departments, 301-399 for vendors, etc.

TIP

Descriptions: Always add a description for easy identification later.

CAUTION

Code Conflicts: Speed dial codes must not conflict with extensions or feature codes.

---

4. Configuration Fields Reference

Speed Dial Fields

Field	Description	Example	Required
Speed Dial Code	Short code to dial	`202`, `801`	Yes
Destination Number	Full number or URI	`+15551234567`	Yes
Description	Friendly label	`Main Office`	No
Class of Service	Restrict by CoS	`Standard`, `None`	No
Enabled	Active/inactive	On/Off	Yes

Code Format Options

Format	Example	Notes
`202`	Numeric only	Standard speed dial
`801`	With asterisk	Feature code style
`#55`	With hash	Less common

Destination Format Options

Format	Example	Use Case
`+15551234567`	E.164	International standard
`5551234567`	Local	Domestic calls
`1001`	Extension	Internal routing
`user/1000`	SIP URI	Direct SIP

---

5. Call Flow / Logic Explanation

Speed Dial Flow

Plaintext

┌─────────────────────────────────────────────────────────────────┐
│                    Speed Dial Flow                              │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  1. User dials 202                                              │
│     │                                                           │
│     ▼                                                           │
│  2. Dialplan checks speed_dials table                           │
│     SELECT * FROM speed_dials                                   │
│     WHERE speed_code = '202'                                    │
│       AND domain_id = [domain]                                  │
│       AND enabled = true                                        │
│     │                                                           │
│     ├─ Found → Continue                                        │
│     └─ Not Found → Normal dialplan (may fail)                  │
│     │                                                           │
│     ▼                                                           │
│  3. Check Class of Service (if set)                             │
│     ├─ CoS specified → Check if caller has this CoS            │
│     │   ├─ Yes → Continue                                      │
│     │   └─ No → "Not authorized"                               │
│     └─ CoS empty → Inherit from caller's extension             │
│     │                                                           │
│     ▼                                                           │
│  4. Replace destination                                         │
│     ├─ Original: 202                                           │
│     └─ New: +15551234567                                       │
│     │                                                           │
│     ▼                                                           │
│  5. Route call through normal outbound dialing                  │
│     ├─ Apply dialrules                                         │
│     ├─ Select trunk                                            │
│     └─ Bridge call                                             │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

---

6. Import/Export Feature

CSV Export

Purpose: Backup speed dials or migrate to another system. Process:

Click "Export" button
System generates CSV file
Download file to your computer

CSV Format:

Csv

speed_code,destination,description,class_of_service,enabled
202,+15551234567,Main Office,,true
203,+15559876543,IT Support,Standard,true
*801,user/1000,Internal Transfer,,true

CSV Import

Purpose: Bulk upload speed dials from spreadsheet. Import Modes:

Mode	Behavior
Skip Existing	Ignore codes that already exist
Update Existing	Update existing codes with new data
Replace Existing	Delete existing and insert new

Process:

Click "Import" button
Select CSV file
Choose import mode
Preview counts
Click "Import" to execute

CSV Template:

Csv

speed_code,destination,description,class_of_service,enabled
201,+15551111111,Reception,,true
202,+15552222222,Sales,,true
203,+15553333333,Support,Standard,true

Import Results:

Created: New speed dials added
Updated: Existing speed dials modified
Skipped: Already existed (skip mode)
Errors: Invalid rows

---

7. Common Scenarios & Examples

Scenario 1: Company Directory

Setup:

Code	Destination	Description
201	+15551001	Reception
202	+15551002	Sales Department
203	+15551003	Support
204	+15551004	Accounting
205	+15551005	HR

Scenario 2: Executive Quick Dial

Setup with CoS restriction:

Code	Destination	Description	CoS
100	+1555CEO1234	CEO Mobile	Executive
101	+1555CFO1234	CFO Mobile	Executive
102	+1555CTO1234	CTO Mobile	Executive

Result: Only users with "Executive" CoS can dial these.

Scenario 3: International Offices

Setup:

Code	Destination	Description
401	+442071234567	London Office
402	+81312345678	Tokyo Office
403	+61298765432	Sydney Office
404	+4989123456	Munich Office

Scenario 4: Bulk Import from Spreadsheet

CSV file (speed_dials.csv):

Csv

speed_code,destination,description,class_of_service,enabled
501,+18005551234,Vendor Helpdesk,,true
502,+18005554567,Bank Customer Service,,true
503,+18005557890,Insurance Claims,,true
504,+18005550001,Legal Hotline,Legal,true

Import steps:

Click Import
Select speed_dials.csv
Mode: "Update Existing"
Click Import

---

8. Limitations & Important Notes

Technical Limitations

WARNING

Code Uniqueness: Speed dial codes must be unique within a domain.

WARNING

Code Conflicts: Avoid codes that match extensions, feature codes, or emergency numbers.

IMPORTANT

CoS Inheritance: If CoS is empty, the caller's own CoS determines dial permissions.

Best Practices

Organize by Range: 201-299 for internal, 301-399 for vendors
Document Everything: Use description field for clarity
Use E.164: Full international format for reliability
Regular Backups: Export periodically for disaster recovery
CoS for Sensitive: Restrict executive/private numbers by CoS

Reserved Ranges to Avoid

Range	Common Use
911	Emergency
67, 72, etc.	Feature codes
1001-9999	Extensions

---

9. Troubleshooting Tips

Common Issues

Symptom	Possible Cause	Solution
Code not recognized	Speed dial disabled	Enable the entry
"Not authorized"	CoS restriction	Check user's CoS
Wrong number dialed	Typo in destination	Verify destination
Import fails	Invalid CSV format	Check headers/format
Conflict error	Code already exists	Use unique code

Diagnostic SQL

List all speed dials:

Sql

SELECT speed_code, destination, description, 
       cos.name as class_of_service, enabled
FROM public.speed_dials sd
LEFT JOIN public.class_of_services cos ON sd.class_of_services_id = cos.id
WHERE sd.domain_id = [domain_id]
ORDER BY speed_code;

Check for duplicate codes:

Sql

SELECT speed_code, COUNT(*) as count
FROM public.speed_dials
WHERE domain_id = [domain_id]
GROUP BY speed_code
HAVING COUNT(*) > 1;

---

10. Glossary

Term	Definition
Speed Dial	A short code that maps to a full destination number
Speed Code	The short number users dial (e.g., 202)
Destination	The full number or URI to call
E.164	International phone number format (+country code + number)
SIP URI	SIP addressing format (user/ext or sip:user@domain)
Class of Service	Permission level that restricts dialing
CSV	Comma-Separated Values file format for import/export
Inherit CoS	Using the caller's Class of Service for permissions

---

Lua Script Status ℹ️

Integration Module

Component	Status	Notes
Speed Dials	ℹ️ Configuration module	Speed dial codes expanded during dialplan routing

--- Documentation last updated: January 2026

Speed Dials Module Documentation

Table of Contents

1. Module Overview (Technical)

What Are Speed Dials?

Architecture

Key Tables

Destination Formats

Key Files

2. Module Overview (Commercial/Business)

Business Value

Use Cases

Feature Highlights

3. Module Overview (End User/Administrator)

What Can You Do?

Administrator Workflow

Quick Tips

4. Configuration Fields Reference

Speed Dial Fields

Code Format Options

Destination Format Options

5. Call Flow / Logic Explanation

Speed Dial Flow

6. Import/Export Feature

CSV Export

CSV Import

7. Common Scenarios & Examples

Scenario 1: Company Directory

Scenario 2: Executive Quick Dial

Scenario 3: International Offices

Scenario 4: Bulk Import from Spreadsheet

8. Limitations & Important Notes

Technical Limitations

Best Practices

Reserved Ranges to Avoid

9. Troubleshooting Tips

Common Issues

Diagnostic SQL

10. Glossary

Lua Script Status ℹ️

Integration Module