Unexus Integration API

The Unexus Integration API lets you integrate your own applications with the Unexus Connect contact center platform. It offers two complementary integration styles:

• REST API — control calls and agents, and manage your webhook subscriptions.
• Webhooks — Unexus pushes real-time events (call status, agent status) to an HTTPS endpoint that you host. No polling required.

flowchart LR
    App["Your application"]
    API["REST API<br/>/api/v1"]
    WH["Webhook delivery"]
    UCS["Unexus Connect<br/>platform"]

    App -- "control calls & agents,<br/>manage subscriptions" --> API
    API --> UCS
    UCS -- "real-time events" --> WH
    WH -- "POST (JSON)" --> App

Base URL

https://{your-unexus-host}/api/v1

All endpoints are versioned in the path (v1). Breaking changes will only be introduced under a new version segment; additive changes (new optional fields, new event types) may appear within a version. Build your integration to ignore unknown JSON fields.

Quick start

sequenceDiagram
    autonumber
    participant App as Your application
    participant Entra as Microsoft Entra ID
    participant API as Integration API
    participant EP as Your HTTPS endpoint

    App->>Entra: Request token (client credentials)
    Entra-->>App: Access token
    App->>API: POST /webhooks/subscriptions (Bearer token)
    API-->>App: 201 Created
    API-)EP: POST call.status event
    EP-->>API: 2xx

1. Authenticate — obtain a bearer token via the Microsoft Entra ID client credentials flow. See Authentication.

2. Host an HTTPS endpoint — any URL that accepts POST requests with a JSON body and returns 2xx quickly.

3. Subscribe — register your endpoint:

   POST /api/v1/webhooks/subscriptions
   Authorization: Bearer {token}
   Content-Type: application/json
   
   {
     "url": "https://example.com/unexus/events",
     "eventTypes": ["call.status", "agent.status"],
     "description": "CRM integration"
   }

4. Receive events — Unexus delivers each subscribed event as an HTTP POST to your URL. See Webhooks overview for the envelope format and Event catalog for payloads.

Contents

Section	Description
Authentication	How to obtain and use access tokens
API explorer	Browse the API and send test requests from your browser
Voice Calls API	Dial, answer, hang up, hold, resume, transfer
Voice Agents API	Agent state, call state, presence
Webhook Subscriptions API	Manage your webhook subscriptions
Webhooks overview	Delivery model, envelope format, headers
Event catalog	All event types with example payloads
Webhook best practices	Reliability, idempotency, and security guidance
Errors	HTTP status codes and error response formats

Conventions

• All request and response bodies are JSON with camelCase property names.
• Timestamps are ISO 8601 in UTC (e.g. 2026-07-21T09:15:23.412Z).
• Enum values are transmitted as numbers in webhook payloads; the event catalog lists the meaning of each value.