Cloudonix Overview
This document provides an introduction to Cloudonix CPaaS and explains why it's essential for OPBX to function as a business PBX platform.
What is Cloudonix CPaaS?
Cloudonix is a Communication Platform as a Service (CPaaS) that provides programmable voice and messaging capabilities. Instead of building and maintaining your own telephony infrastructure, you can leverage Cloudonix's cloud-based services through their API.
Key Capabilities
- Voice Calls: Make and receive telephone calls via SIP or WebRTC
- Number Management: Purchase and manage DID (Direct Inward Dialing) numbers
- Call Routing: Define how calls are handled using CXML (Cloudonix XML)
- Webhooks: Receive real-time events about call state changes
- Recording: Capture call audio for compliance or training purposes
Why OPBX Needs Cloudonix
OPBX is a PBX orchestration layer - it handles the business logic for call routing, extensions, ring groups, and IVR menus. However, it is not a telephony infrastructure.
Cloudonix provides the actual VoIP capabilities:
| Layer | Responsibility | Technology |
|---|---|---|
| OPBX | PBX configuration, routing logic, extension management | Laravel + React |
| Cloudonix | SIP termination, media handling, PSTN connectivity | Cloud infrastructure |
The Partnership
-
Inbound Calls: When a caller dials a Cloudonix number, Cloudonix sends a webhook to OPBX asking "what should I do with this call?" OPBX responds with CXML instructions (ring extension, play IVR, etc.)
-
Call Events: As the call progresses (answered, hung up, voicemail), Cloudonix notifies OPBX via webhooks so OPBX can update call logs and presence status
-
Extension Mapping: OPBX extensions are synchronized to Cloudonix as "subscribers" - this allows Cloudonix to route calls to the correct endpoint
Key Cloudonix Concepts
Understanding these terms will help you configure the integration successfully.
Domain
A Domain is your Cloudonix tenant. It represents your organization within Cloudonix and contains:
- All your phone numbers
- Voice applications
- Subscribers (extensions)
- API credentials
Your Domain UUID uniquely identifies your Cloudonix account.
Voice Application
A Voice Application defines how Cloudonix handles voice calls for your domain. It contains:
- Webhook URLs for call routing
- Call flow logic
- Recording settings
OPBX automatically creates a Voice Application when you complete the pairing workflow.
Subscribers
Subscribers represent your users/endpoints in Cloudonix. Each OPBX extension is synchronized to Cloudonix as a subscriber with:
- A unique subscriber ID
- MSISDN (phone number) if assigned
- SIP credentials for registration
Webhooks
Webhooks are HTTP callbacks that Cloudonix sends to OPBX to:
- Request routing instructions when a call arrives
- Notify about call state changes
- Send Call Detail Records (CDRs) after calls
API Keys
Cloudonix uses API keys for authentication:
- Domain API Key: Authenticates OPBX when making API calls to Cloudonix
- Requests API Key: Authenticates Cloudonix webhooks when they call back to OPBX
Architecture Diagram
Next Steps
Now that you understand the architecture, proceed to Account Setup to create your Cloudonix account and obtain the necessary credentials.
Related Documentation: