Omnix API Reference

Welcome to the Omnix developer API reference. Omnix exposes a single JSON-RPC 2.0 gateway endpoint for external services to execute omnichannel communications, manage contacts, query telephony assets, and schedule messaging campaigns.

To understand the core HTTP header structures, JSON payload formats, authentication rules, and global error codes, consult the shared API Integration Guide.

📚 Categorized API Endpoints

Below is the list of compiled RPC endpoints available in this application. For parameter definitions, return values, and cURL request/response examples for each method, select from the sections below:

Core External Integration API

• OmnixGatewayRpc — The primary external integration gateway. Use this to manage contacts, trigger OTP verification, send templated messages, and control SIP telephony.

Agent & UI Telemetry APIs

These RPC endpoints power the Omnix Agent console:

• UnifiedInboxRpc — Manage agent conversations, assignments, call recordings, and ticketing.
• OmniContactsRpc — Manage CRM contact database, segmentation, and custom context fields.
• CampaignRpc — Outbound messaging campaigns, schedules, and analytics.
• TemplateRpc — Manage WhatsApp and SMS templates.
• ChannelManagerRpc — WhatsApp, email, SMS/voice, and web chat channel configuration.
• CallQueueRpc — Telephony call queues, routing rules, and agent assignments.
• ExtensionManagerRpc — Assigned user SIP extensions and softphone configurations.
• WhatsAppRpc / TwilioRpc — Low-level channel-specific webhook handlers and configurations.

Administrative & Dashboard APIs

• AdminDashboardRpc / ManagerDashboardRpc / UserDashboardRpc — Dashboard metrics and layout statistics.
• BrandingKitRpc — Manage branding colors, white-labeling logos, and templates.
• PhoneNumberManagerRpc — Voice and SMS phone number acquisition and settings.
• TicketRpc — Customer support ticketing system CRUD.