DOCSEARCHbyAlgolia
Submit Docs

Cloudonix Developer Documentation

website·Indexed 32 days ago

https://developers.cloudonix.com

Developer guides and API documentation for Cloudonix, featuring tools for building dynamic voice applications, AI voice agents, and the Cloudonix Voice AI Connector. Includes technical details on the AutoDialerCampaign model for outbound dialing, SIP trunking integration guides for VAPI.ai and ReTell.ai, and tutorials on Quality of Service (QoS) and MoS scores.

Tokens
147.7K
Snippets
508
Records
1.1K
Agent score
57%

What's inside Cloudonix

  1. Overview of the AMD Worker microservice

    The AMD Worker is a Java/Vert.x 5 microservice that performs real-time Answering Machine Detection (AMD). It receives live audio streams from Cloudonix via WebSocket, analyzes the audio for voicemail beep tones using ML and energy-based detectors, and posts the detection results to the Laravel backend at the /api/voice/amd-action endpoint.

  2. Overview of Business Hours call routing

    Business Hours enable time-based call routing in OPBX. This allows calls to be routed to different destinations depending on whether the business is open or closed. Key capabilities include defining weekly open/closed hours, configuring IANA time zones, adding holiday or special-hours exceptions, and setting specific destinations for open and closed periods.

  4. Overview of available OPBX modules

    OPBX provides a set of modules to manage business phone system functionality. Available modules include:

    • User Management: Role-based access control for user accounts.
    • Extensions: SIP credentials and Cloudonix sync.
    • Phone Numbers: DID management and inbound routing.
    • Ring Groups: Call distribution across extensions.
    • IVR Menus: Digit-based navigation menus.
    • Business Hours: Time-of-day routing, schedules, and holidays.
    • Conference Rooms: Multi-party bridges with PIN protection.
    • AI Assistants: AI-powered voice agents.
    • AI Load Balancers: Call distribution across AI providers.
    • Call Logs: Call detail record viewing and exporting.
    • Live Calls: Real-time monitoring and disconnection of active calls.
    • Call Tracking Campaigns: Attribution of inbound calls to marketing sources.
    • Call Tracking DNI: Dynamic number insertion for websites.
    • Call Tracking Analytics: Conversion and performance exports.
    • Call Notifications: Webhook notifications for call events.
    • Recordings: Management of audio files for IVR and announcements.
    • Inbound Blacklist: Blocking unwanted callers.
    • Outbound Whitelist: Controlling dialable external numbers.
    • Auto Dialer Campaigns: Outbound calling campaigns.
    • Distribution Lists: Contact lists for auto-dialers.
    • Settings: Organization settings and Cloudonix integration.

  5. Overview of Cloudonix Container Application Runtimes

    Container Applications (or Container Application Resources) are voice applications executed within the Cloudonix platform, removing the need for customer-maintained application servers. They are owned by the Tenant and available across all tenant-owned Domains.

    Available run-time engines include:

    • cxml: Executes from a static CXML document with no additional dynamic processing.
    • forward: Transfers call control to a remote URL application resource.
    • javascript: Node-based Lambda functions written in JavaScript.
    • ruby: Ruby-based Lambda functions.
    • select: Uses DTMF (keypad) input to select the next block to execute, ideal for simple menus.

  6. Overview of Registration-Free (RegFree) Dialing

    The Registration-Free Dialing (RegFree) protocol allows mobile user agents to make and receive calls without the power and data overhead of maintaining a constant SIP registration. It replaces periodic SIP REGISTER messages with a server-side orchestration model using pre-authenticated bearer tokens or just-in-time call authorization. A custom server application handles call setup and notifies the mobile app of incoming calls via push notifications, bypassing slow SIP user/password authentication in favor of the application's existing authorization mechanisms.

  7. Overview of Cloudonix Communications Platform

    Cloudonix is an AI-first communications platform that abstracts telecommunications and telephony complexities for developers and no-code builders. It provides capabilities for inbound and outbound call routing, call forwarding, and transfers via REST APIs. The platform supports connecting any SIP-compliant platform (on-premise or cloud) and allows control over multiple voice agent platforms from a single interface.

  8. Overview of Cloudonix Web-To-Call

    Web-To-Call leverages WebRTC technology to enable voice communication directly from modern browsers (Chrome, Firefox, and Chromium-based). Unlike traditional Click-2-Call, which requires multiple phone numbers for tracking, Web-To-Call allows developers to pass data and context (such as specific product IDs or user tracking codes) seamlessly to a call center agent, improving sales acceleration and customer experience.

  9. Overview of Auto Dialer capabilities

    The Auto Dialer is an automated outbound calling system designed to dial phone numbers from distribution lists. Key capabilities include:

    • Scheduled Campaigns: Support for specific time windows and timezones.
    • Rate-Limited Dialing: Control over Concurrent Calls (CAC) and Call Initiation Speed (CPS).
    • Answering Machine Detection (AMD): Automatic detection and handling of voicemail systems.
    • Real-Time Monitoring: Tracking of active calls, campaign progress, and performance metrics.
    • Retry Logic: Configurable attempt limits for automatically retrying failed destinations.

  10. Overview of OPBX Reporting Tools

    OPBX provides reporting modules to monitor call activity, analyze usage patterns, and manage active calls in real time. Key capabilities include reviewing Call Detail Records (CDR), exporting call data to CSV, monitoring active calls, and viewing aggregate statistics.

  11. Overview of OPBX Conference Rooms

    Conference rooms provide multi-party audio bridges for meetings. This module allows administrators to create conference bridges, configure security via PINs, manage recording settings, and control participant behavior (such as entry muting and host-led starts).

  12. Overview of OPBX Webhook Categories

    OPBX utilizes three primary categories of inbound webhooks from Cloudonix CPaaS to handle call routing, event tracking, and AMD results.
    CategoryMiddlewareResponse FormatPurpose
    Voice routingvoice.webhook.authCXMLReal-time call routing instructions.
    Status / CDRwebhook.signature (+ webhook.idempotency)JSONAsynchronous call events and records.
    AMD actionInline Bearer checkJSONAMD worker callback with detection results.