Data Models Overview
This section provides comprehensive documentation of all data structures in OpBX.
Categories
Database Models
Complete reference of all Eloquent models including:
- Table structure and columns
- Relationships
- Scopes and mutators
- Business logic methods
Enumerations
All PHP enums used throughout the application:
- Status enums
- Type enums
- Strategy enums
- Mode enums
Configuration
Configuration files and environment variables:
- Application config
- Service configuration
- Environment variables
- Feature flags
Key Models
Auto Dialer
- AutoDialerCampaign - Campaign configuration
- AutoDialerCampaignCallerId - Caller ID pool entries
- AutoDialerCallerIdStat - Per-Caller ID statistics
Core PBX
- Extension - PBX extensions
- DidNumber - Phone numbers
- RingGroup - Ring group configuration
- IvrMenu - IVR menu structure
AI Integration
- AiAssistant - AI assistant configuration
- AiAssistantLoadBalancer - Load balancer setup
Users & Organizations
- User - User accounts
- Organization - Multi-tenant organizations
Recently Added
Caller ID Pooling (v2026.04)
New models supporting multiple Caller IDs per campaign:
| Model | Purpose |
|---|---|
AutoDialerCampaignCallerId | Pivot table linking campaigns to DIDs |
AutoDialerCallerIdStat | Tracks call statistics per Caller ID |
See Auto Dialer Caller ID Pooling for usage documentation.