Ctrl K
ring2all.com

Recording Management Module Documentation

Table of Contents

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

---

1. Module Overview (Technical)

What Is Recording Management?

Recording Management is a voice recording library module that manages audio prompts and announcements. It supports both file uploads and AI Text-to-Speech (TTS) generation for creating professional audio content.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│            Recording Management Architecture                   │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Recording Management                              │   │
│  │                                                          │   │
│  │  Recording Modes:                                        │   │
│  │  ├─ Upload File: WAV, MP3, OGG (max 50MB)               │   │
│  │  └─ AI TTS: Text converted to speech                    │   │
│  │                                                          │   │
│  │  TTS Providers (via AI Profiles):                        │   │
│  │  ├─ OpenAI TTS (Alloy, Nova, Shimmer...)               │   │
│  │  ├─ Azure Speech Services                               │   │
│  │  └─ Google TTS (300+ voices, emotion styles)           │   │
│  │                                                          │   │
│  │  Categories:                                             │   │
│  │  ├─ Announcement                                        │   │
│  │  ├─ IVR                                                 │   │
│  │  ├─ Voicemail                                           │   │
│  │  ├─ Feature Code                                        │   │
│  │  └─ Custom                                              │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Stored per domain                                      │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Recording Storage                                 │   │
│  │                                                          │   │
│  │  /var/lib/freeswitch/storage/domains/{domain}/recordings/│   │
│  │  ├─ welcome_message.wav                                 │   │
│  │  ├─ after_hours.mp3                                     │   │
│  │  └─ ai_generated_001.wav                                │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used by PBX modules                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        IVR, Announcements, Voicemail                     │   │
│  │                                                          │   │
│  │  IVR Menu → Welcome Recording → Play audio              │   │
│  │  Announcement → After Hours → Play audio                │   │
│  │  Feature Code → Confirmation → Play audio               │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.recordingsRecording metadata and paths

Key Files

FileDescription
modules/recordingManagement/Frontend module
/var/lib/freeswitch/storage/...Audio file storage
---

2. Module Overview (Commercial/Business)

Business Value

Recording Management provides professional audio content:

Without Recording ManagementWith Recording Management
SSH to upload filesWeb interface
No TTS optionAI-generated audio
Manual organizationCategorized library
No previewIn-browser playback

Use Cases

  1. Professional Greetings

- Upload studio recordings

- AI-generate placeholders

  1. IVR Prompts

- Menu options

- Navigation instructions

  1. Announcements

- After hours messages

- Holiday greetings

  1. Multi-language Support

- Recordings per language

- TTS in multiple languages

Feature Highlights

FeatureBenefit
File UploadCustom audio files
AI TTSInstant generation
CategoriesOrganized library
Multi-languageEN, ES, FR, DE, PT
PreviewIn-browser playback
DownloadExport recordings
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Upload audio files (WAV, MP3, OGG)
  • Generate audio from text using AI TTS
  • Organize recordings by category
  • Set recording language
  • Preview audio in browser
  • Download recordings
  • Enable/disable recordings

Recording Management Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Recording Management                               │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Manage voice recordings and AI-generated audio for your domain│
│                                                                 │
│  [+ Add]                                                        │
│                                                                 │
│  [🔍 Search recordings...]                                      │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Name              │ Category    │ Type    │ Duration │ ▶ │  │
│  ├───────────────────┼─────────────┼─────────┼──────────┼───┤  │
│  │ Welcome Message   │ IVR         │ Uploaded│ 0:15     │ ▶ │  │
│  │ After Hours       │ Announcement│ AI Gen  │ 0:22     │ ▶ │  │
│  │ Menu Options      │ IVR         │ Uploaded│ 0:45     │ ▶ │  │
│  │ Holiday Greeting  │ Announcement│ AI Gen  │ 0:18     │ ▶ │  │
│  │ Voicemail Prompt  │ Voicemail   │ Uploaded│ 0:08     │ ▶ │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create Recording - Upload Mode

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Create Recording                                   │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Basic Information                                            │
│                                                                 │
│  Name: [Welcome Message              ]                         │
│  Description: [Main IVR welcome prompt]                        │
│  Category: [IVR ▼]                                             │
│  Language: [English ▼]                                         │
│  Status: [Active ▼]                                            │
│                                                                 │
│  ▼ Recording Mode                                               │
│                                                                 │
│  ○ Upload File   ● AI TTS Generation                           │
│                                                                 │
│  ▼ File Upload                                                  │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │                                                             ││
│  │         Drag and drop audio file here                       ││
│  │                                                             ││
│  │  Supported formats: WAV, MP3, OGG (max 50MB)               ││
│  │                                                             ││
│  │               [Select File]                                 ││
│  │                                                             ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  ▼ Audio Preview                                                │
│                                                                 │
│  [▶ Play] ━━━━━━━━━━━━━━━━━━━━ 0:00 / 0:15                    │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Create Recording - AI TTS Mode

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Create Recording                                   │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  ▼ Basic Information                                            │
│                                                                 │
│  Name: [After Hours Message          ]                         │
│  Description: [Plays outside business hours]                   │
│  Category: [Announcement ▼]                                    │
│  Language: [English ▼]                                         │
│  Status: [Active ▼]                                            │
│                                                                 │
│  ▼ Recording Mode                                               │
│                                                                 │
│  ○ Upload File   ● AI TTS Generation                           │
│                                                                 │
│  ▼ AI Text-to-Speech                                            │
│                                                                 │
│  AI Profile: [Joanna (English US) ▼]                           │
│                                                                 │
│  Text to Convert:                                               │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Thank you for calling ABC Company. Our offices are         ││
│  │ currently closed. Our business hours are Monday through    ││
│  │ Friday, 8 AM to 5 PM. Please leave a message after the    ││
│  │ tone and we will return your call on the next business day.││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  [Generate TTS]                                                 │
│                                                                 │
│  ▼ Audio Preview                                                │
│                                                                 │
│  [▶ Play] ━━━━━━━━━━━━━━━━━━━━ 0:00 / 0:22                    │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
AI TTS: Great for quick drafts, then replace with professional recordings.
TIP
Categories: Use categories to organize and find recordings.
NOTE
Preview: Always preview before saving.

---

4. Configuration Sections

Basic Information

FieldDescription
NameRecording identifier
DescriptionPurpose notes
CategoryOrganizational category
LanguageRecording language
StatusActive/Inactive/Processing

Recording Modes

ModeDescription
Upload FileUpload WAV, MP3, or OGG
AI TTSGenerate from text

Categories

CategoryUse Case
AnnouncementGeneral announcements
IVRMenu prompts
VoicemailVoicemail greetings
Feature CodeFeature confirmations
CustomOther purposes
---

5. Settings Reference

Supported Languages

CodeLanguage
enEnglish
esSpanish
frFrench
deGerman
ptPortuguese

File Formats

FormatExtensionMax Size
WAV.wav50MB
MP3.mp350MB
OGG.ogg50MB

Status Values

StatusDescription
ActiveAvailable for use
InactiveDisabled
ProcessingTTS generation in progress
---

6. Common Scenarios & Examples

Scenario 1: Upload IVR Greeting

  1. Click "Add"
  2. Name = "Main IVR Welcome"
  3. Category = IVR
  4. Mode = Upload File
  5. Drag audio file
  6. Preview and save

Scenario 2: AI-Generated Announcement

  1. Click "Add"
  2. Name = "After Hours"
  3. Category = Announcement
  4. Mode = AI TTS Generation
  5. Select AI Profile
  6. Enter text
  7. Click "Generate TTS"
  8. Preview and save

Scenario 3: Multi-language Recordings

  1. Create English version
  2. Duplicate and edit
  3. Set Language = Spanish
  4. Generate Spanish TTS
  5. Repeat for other languages

Scenario 4: Replace Recording

  1. Find existing recording
  2. Click Edit
  3. Upload new file or regenerate TTS
  4. Preview and save

Scenario 5: Google TTS with Emotion Style

  1. Click "Add"
  2. Name = "Friendly Welcome"
  3. Category = IVR
  4. Mode = AI TTS Generation
  5. Select AI Profile with Google TTS configured:

- Language = Spanish

- Accent = Mexico

- Voice = Enceladus

- Style = Alegre (friendly tone)

  1. Enter text with warm greeting
  2. Click "Generate TTS"
  3. Preview and adjust prosody (Speed, Pitch, Volume) if needed
  4. Save

---

7. Limitations & Important Notes

Technical Notes

NOTE
AI TTS: Requires configured AI profile. Supported providers: OpenAI TTS, Azure Speech, Google TTS.
NOTE
File Size: Maximum 50MB per file.
NOTE
Google TTS: Supports 300+ voices with Language → Accent → Voice → Style selection and emotion styles (Alegre, Triste, Susurrar).
WARNING
Processing Time: TTS generation may take a few seconds.

Supported TTS Providers

ProviderVoicesFeatures
OpenAI TTS6 voicesHigh quality, fast generation
Azure Speech400+ voicesNeural voices, multiple languages
Google TTS300+ voicesCascading selection, emotion styles, prosody controls

Best Practices

  1. Naming Convention: Use descriptive names
  2. Categorize: Proper category for organization
  3. Preview: Always preview before deploying
  4. Backup: Download important recordings
  5. Language Match: Ensure language matches content
  6. Use Google TTS Styles: For professional recordings, use emotion styles like "Natural" or "Alegre"

AI TTS Tips

TipDescription
PunctuationUse periods for pauses
NumbersWrite out or use digits
AbbreviationsSpell out for clarity
EmphasisUse CAPS sparingly
Google StylesUse "Alegre" for friendly, "Triste" for empathetic
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Upload failsFile too largeCompress or trim audio
TTS failsNo AI profileConfigure AI profile
No playbackInvalid formatConvert to WAV/MP3
Processing stuckTTS errorCheck AI service
Can't find recordingWrong categoryCheck all categories

Check Recording Files

Bash
# List recordings for domain
ls -la /var/lib/freeswitch/storage/domains/{domain}/recordings/

# Play audio file
aplay /path/to/recording.wav

# Check file format
file /path/to/recording.wav

Convert Audio Format

Bash
# Convert MP3 to WAV (8kHz mono)
ffmpeg -i input.mp3 -ar 8000 -ac 1 output.wav

---

9. Glossary

TermDefinition
TTSText-to-Speech
AI ProfileTTS voice configuration
WAVWaveform audio format
MP3Compressed audio format
OGGOpen audio format
IVRInteractive Voice Response
---

Lua Script Status ℹ️

Content Management Module

ComponentStatus
Recording Managementℹ️ Content library - recordings used by IVR, Announcements, etc.
Recording Management is a content management module. Recordings are stored and referenced by other PBX modules (IVR, Announcements, Voicemail) when playing audio to callers.

---

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?