Ctrl K
ring2all.com

Voicemail Settings Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Fields
  5. Common Scenarios & Examples
  6. Limitations & Important Notes
  7. Troubleshooting Tips
  8. Glossary

---

1. Module Overview (Technical)

What Is Voicemail Settings?

Voicemail Settings is a domain-wide voicemail configuration module that manages global voicemail parameters. These settings control message duration limits, silence detection, login security, greeting requirements, and user experience options for all voicemail boxes in a domain.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│               Voicemail Settings Architecture                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Voicemail Settings                                │   │
│  │                                                          │   │
│  │  General Settings:                                       │   │
│  │  ├─ Max Message Length: 300 sec                         │   │
│  │  ├─ Min Message Length: 3 sec                           │   │
│  │  ├─ Max Silence: 5 sec                                  │   │
│  │  └─ Max Messages: 100                                   │   │
│  │                                                          │   │
│  │  Behavior & Experience:                                  │   │
│  │  ├─ Force Name Recording                                │   │
│  │  ├─ Force Greeting Recording                            │   │
│  │  └─ Allow Message Review                                │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Stored per domain                                      │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        public.domain_voicemail_settings                  │   │
│  │                                                          │   │
│  │  domain_id | settings (JSON)                            │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used by voicemail handlers                             │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Voicemail Lua Handler                             │   │
│  │                                                          │   │
│  │  Load settings → Apply to voicemail session             │   │
│  │  ├─ Record up to max_message_length                     │   │
│  │  ├─ Stop on max_silence                                 │   │
│  │  ├─ Enforce login limits                                │   │
│  │  └─ Apply behavior options                              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.domain_voicemail_settingsDomain voicemail configuration

Key Files

FileDescription
modules/voicemailSettings/Frontend module
---

2. Module Overview (Commercial/Business)

Business Value

Voicemail Settings provides consistent voicemail behavior:

Without Voicemail SettingsWith Voicemail Settings
Default limitsCustom limits
No controlFull control
InconsistentStandardized
Fixed behaviorConfigurable

Use Cases

  1. Storage Management

- Limit message count

- Control message length

  1. User Experience

- Force greetings

- Allow message review

  1. Security

- Limit login attempts

- Control access

  1. Compliance

- Message retention

- Backup deleted messages

Feature Highlights

FeatureBenefit
Message LimitsControl storage
Silence DetectionEnd recordings early
Login SecurityPrevent brute force
Greeting ControlForce personalization
Backup DeletedRecovery option
Locale SupportMultilingual
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Set maximum message duration
  • Set minimum message duration
  • Configure silence detection
  • Limit login attempts
  • Set mailbox capacity
  • Force name/greeting recording
  • Enable message review
  • Configure email date format

Voicemail Settings Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Voicemail Settings                                 │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Manage global voicemail parameters for this domain.           │
│                                                                 │
│  ▼ General Settings                                             │
│  Tune core voicemail limits and defaults.                       │
│                                                                 │
│  Max Message Length (sec): [300            ]                   │
│    Maximum allowed message duration.                            │
│                                                                 │
│  Min Message Length (sec): [3              ]                   │
│    Messages shorter than this are discarded.                    │
│                                                                 │
│  Greeting Length (sec): [60             ]                      │
│    Maximum allowed greeting duration.                           │
│                                                                 │
│  Max Silence (sec): [5               ]                         │
│    Stops recording after this many seconds of silence.          │
│                                                                 │
│  Max Login Attempts: [3               ]                        │
│    Allowed number of invalid PIN attempts before hangup.        │
│                                                                 │
│  Backup Deleted (count): [10              ]                    │
│    Number of deleted messages retained in backup.               │
│                                                                 │
│  Max Messages: [100             ]                              │
│    Maximum number of stored messages per mailbox.               │
│                                                                 │
│  Locale: [en-US ▼]                                             │
│    Language and voice prompt pack used for voicemail.           │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Behavior Settings

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Voicemail Settings (continued)                     │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Behavior & Experience                                        │
│  Control how callers and users interact with voicemail.         │
│                                                                 │
│  Move Heard Messages: ✓                                        │
│    Move played messages to the 'old' folder.                    │
│                                                                 │
│  Force Name Recording: ☐                                       │
│    Require users to record their spoken name.                   │
│                                                                 │
│  Force Greeting Recording: ☐                                   │
│    Require users to record greetings.                           │
│                                                                 │
│  Use Directory: ✓                                              │
│    Allow callers to search extensions by name.                  │
│                                                                 │
│  Allow Message Review: ✓                                       │
│    Allow users to review messages before sending.               │
│                                                                 │
│  Email Date Format: [%A, %B %d %Y, %R     ]                    │
│    Format used for date/time in voicemail notification emails.  │
│                                                                 │
│  [Save Changes]                                                 │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
Short Silence: Lower max_silence to stop recording quickly after caller stops talking.
TIP
Message Review: Enable to let callers re-record before saving.
NOTE
Domain-Scoped: These settings apply to all mailboxes in the domain.

---

4. Configuration Fields

General Settings

FieldDefaultDescription
Max Message Length300 secMaximum recording time
Min Message Length3 secMinimum to save (filter blanks)
Greeting Length60 secMaximum greeting duration
Max Silence5 secStop recording on silence
Max Login Attempts3PIN entry attempts
Backup Deleted10Retained deleted messages
Max Messages100Mailbox capacity
Localeen-USVoice prompt language

Behavior & Experience

FieldDefaultDescription
Move Heard MessagesYesMove to 'old' folder
Force Name RecordingNoRequire name recording
Force Greeting RecordingNoRequire greeting
Use DirectoryYesDial-by-name enabled
Allow Message ReviewYesPreview before save
Email Date Format%A, %B %d %YEmail timestamp format
---

5. Common Scenarios & Examples

Scenario 1: Short Messages Only

  1. Set Max Message Length = 60 sec
  2. Set Min Message Length = 5 sec
  3. Set Max Silence = 3 sec
  4. Save changes

Scenario 2: High Security

  1. Set Max Login Attempts = 2
  2. Enable Force Name Recording
  3. Enable Force Greeting Recording
  4. Save changes

Scenario 3: Large Mailboxes

  1. Set Max Messages = 200
  2. Set Backup Deleted = 50
  3. Set Max Message Length = 600 sec
  4. Save changes

Scenario 4: Professional Setup

  1. Enable Force Name Recording
  2. Enable Force Greeting Recording
  3. Enable Allow Message Review
  4. Enable Use Directory
  5. Save changes

---

6. Limitations & Important Notes

Technical Notes

NOTE
Domain-Scoped: Settings apply per domain/tenant.
NOTE
Existing Mailboxes: Changes affect all mailboxes immediately.
WARNING
Storage Impact: Increasing max messages increases storage usage.

Best Practices

  1. Balance Length: Long enough for messages, short enough for storage
  2. Silence Detection: 3-5 seconds is typical
  3. Login Security: 2-3 attempts prevents brute force
  4. Force Greetings: Improves caller experience
  5. Backup Deleted: Keep some for recovery

Date Format Codes

CodeMeaningExample
%AFull weekdayMonday
%BFull monthJanuary
%dDay of month15
%YFour-digit year2026
%RTime (24h)14:30
%I:%M %pTime (12h)2:30 PM
---

7. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Messages cut shortMax length too lowIncrease max_message_length
Blank messages savedMin length too lowIncrease min_message_length
Recording stops earlySilence detectionIncrease max_silence
User locked outLogin attemptsCheck max_login_attempts
Mailbox fullMax messagesIncrease max_messages

Check Settings

Sql
SELECT 
  settings
FROM public.domain_voicemail_settings
WHERE domain_id = [domain_id];

Common Values

SettingRecommended
Max Message180-300 sec
Min Message3-5 sec
Max Silence3-5 sec
Login Attempts2-3
Max Messages50-200
---

8. Glossary

TermDefinition
Max Message LengthRecording time limit
Min Message LengthMinimum to save
Max SilenceSilence before stop
GreetingPersonalized intro message
Message ReviewPreview before saving
LocaleLanguage/region setting
Backup DeletedRetained deleted messages
---

Lua Script Status ℹ️

Configuration Module

ComponentStatus
Voicemail Settingsℹ️ Configuration module - settings used by voicemail Lua handlers
Voicemail Settings is a configuration module. Settings are stored per domain and loaded by the voicemail Lua handlers when processing voicemail sessions.

---

Documentation last updated: January 2026
AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?