Omnix Developer Hub

Omnix is an intelligent, AI-powered omnichannel communications platform. This hub covers everything you need to integrate Omnix into your own application — from sending your first API call to managing contacts, delivering messages across channels, and embedding telephony into your product.

Not a developer? If you're a subscriber using the Omnix product, see the Omnix User Guide.

What You Can Do with the Omnix API

The Omnix Gateway API lets external applications:

Capability	What it enables
Contact management	Look up or create contacts by any identifier (email, phone, WhatsApp)
OTP delivery	Send and verify one-time passwords across SMS, email, or WhatsApp
Outbound messaging	Deliver templated messages on any supported channel
Conversation injection	Push system messages into existing Omnix conversations
AI agent relay	Relay remote AI agent responses into live Omnix conversations
Telephony control	Assign SIP extensions, retrieve credentials, control calls, query call state

All of these capabilities are available through a single JSON-RPC endpoint and a single API key.

Start Here

Authentication — Get your API key and understand how subscription scoping works.
Your First API Call — From ping to sending a real message in under 5 minutes.
Error Handling — Error codes, retry strategy, and how to debug failures.

Core Concepts

Contacts — The ContactInfo object, identifier resolution, and the context field.
Conversations — What a conversation is, channel types, and statuses.
Subscriptions — How subscriptionId scopes all API calls.
Channels — Supported channel types and their constraints.

Use Cases

Send an OTP — Full flow: find/create contact → request OTP → verify code.
Send a Notification — Templated outbound messaging and system message injection.
Embed Web Chat — Widget snippet and contact pre-fill.
AI Agent Handoff — The sendRemoteAgentResponse relay pattern.
Telephony Integration — SIP credentials, call control, and extension management.

API Reference

The complete method-level reference is auto-generated from source:

OmnixGatewayRpc — The external-facing gateway (contact management, OTP, messaging, telephony).
Reference Index — Base URL, authentication header, rate limits, error codes, and pagination.

Quick Example

# 1. Test your API key
curl -X POST "https://your-omnix-instance.com/api/rpc" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"method": "OmnixGatewayRpc.ping", "params": {}}'

# Expected response:
# {"success": true, "message": "Pong!", "subscriptionId": "...", "userId": "..."}

See Your First API Call for the full walkthrough.