What is Cloud PBX API?
The Cloud PBX (Private Branch Exchange) API enables you to build custom voice solutions and manage cloud-based telephony systems. This API provides comprehensive control over call routing, voicemail, call recording, IVR (Interactive Voice Response) systems, and advanced telephony features for businesses of all sizes.
How It Works
The Cloud PBX API provides programmatic access to voice communication infrastructure:
Call Management
- Call routing: Configure sophisticated call routing rules and forwarding
- Call handling: Manage incoming and outgoing calls programmatically
- Call queuing: Implement call queues for customer support and sales teams
- Call transfer: Enable call transfers between extensions and departments
Voice Features
- Voicemail: Manage voicemail boxes, greetings, and notifications
- IVR systems: Create interactive voice response menus for automated call handling
- Call recording: Record calls for quality assurance and compliance
- Conference calling: Set up and manage multi-party conference calls
Extension Management
- User management: Create and manage user accounts and extensions
- Device configuration: Configure phones, softphones, and mobile apps
- Permission control: Set user permissions and access levels
- Department organization: Organize users into departments and groups
Advanced Features
- Call analytics: Track call volumes, durations, and patterns
- Real-time monitoring: Monitor active calls and system status
- Webhooks: Receive real-time notifications for call events
- Integration: Integrate with CRM, helpdesk, and other business systems
Key Features
Flexible Call Routing
Configure complex call routing rules based on time, caller ID, department, or custom business logic for optimal call handling.
IVR Systems
Build interactive voice response systems with custom menus, prompts, and call flows to automate customer interactions.
Call Recording
Record calls automatically or on-demand for quality assurance, training, and compliance with configurable storage options.
Voicemail Management
Comprehensive voicemail system with custom greetings, email notifications, transcription, and web-based access.
Conference Calling
Host multi-party conference calls with scheduling, participant management, and recording capabilities for team collaboration.
Analytics & Reporting
Detailed call analytics with reports on call volumes, durations, wait times, and agent performance metrics.
Use Cases
Business Phone Systems
Replace traditional PBX systems with cloud-based solutions that scale with your business.
Call Centers
Build sophisticated call center solutions with queuing, routing, and analytics for customer support teams.
Customer Service
Implement IVR systems and automated call handling to improve customer experience and reduce wait times.
Remote Work
Enable remote teams with softphone capabilities, mobile integration, and unified communications.
Integration Projects
Integrate voice capabilities into existing applications, CRM systems, or custom business solutions.
Authentication
The Cloud PBX API uses JWT (JSON Web Token) authentication:
- Login endpoint:
/admin_login- Obtain JWT token with username and password - Token refresh:
/token/refresh- Refresh expired tokens - Header:
Authorization: Bearer {jwt_token}for authenticated requests
Environments
- Sandbox:
https://api.omax.dev/api/brand- For testing and development - Production:
https://api.omaxtelecom.com/api/brand- For live operations
Getting Started
To start using the Cloud PBX API:
-
Get your credentials: Log in to My OmaxTelecom Portal to obtain your username and password.
-
Authenticate: Use the
/admin_loginendpoint to obtain your JWT token. -
Choose your environment:
- Sandbox: For testing and development
- Production: For live operations
-
Review the API documentation: Explore all available endpoints, request/response formats, and authentication requirements.
-
Start building: Begin with user management, then implement call routing and advanced features.
API Documentation
Complete API Reference
Explore the full API documentation with interactive examples, request/response schemas, and authentication details.
Need Help?
If you have any questions or need assistance with the Cloud PBX API, please contact our support team at [email protected].