XIMA CCaaS Licensing Guide

Complete guide to license types, seat configurations, AI services, and validation rules for the XIMA CCaaS platform.

API Endpoint & Validation Rules

The XIMA CCaaS Licensing API provides two main operations: POST /v1/licensing/update to modify existing licenses, and DELETE /v1/licensing/update to schedule complete resource removal. Both endpoints use comprehensive validation to ensure data integrity and business compliance.

Key Validation Pattern: All seat fields follow the "0 or minimum" rule - values must be either 0 (remove license) or meet the minimum requirement for that seat type.

Basic Seat Types

Digital Only, Essential, Professional, Elite Seats

Rule: Must be either 0 (remove license) or ≥ 5

These are the core seat types for different service tiers. Each has different feature inclusions.

Workforce Optimization & Management Seats

Rule: Must be either 0 (remove license) or ≥ 5

Advanced workforce management features require minimum 5-seat purchases.

Speech Analytics Seats

Rule: Must be either 0 (remove license) or ≥ 5

Analytics capabilities with minimum 5-seat requirement.

Dialer Seats

Rule: Must be either 0 (remove license) or ≥ 10

Specialized dialing capabilities require minimum 10-seat purchases.

SIP Credentials Validation

SIP credentials are optional but if included, username, password, sipServer, and outboundProxy are required. The sipPort (1-65535) and transport (udp/tcp/tls) fields are optional but must be provided together. When both are omitted, the system uses SRV lookup to automatically discover the port and transport.

Common API Usage Patterns

Examples of typical licensing operations using the validation rules.

Adding New Licenses

Provision new seats with minimum values:

{
      "ccId": {"resellerId": "RESELLER001", "tenantId": "TENANT456"},
      "digitalOnlySeats": 5,
      "speechAnalyticsSeats": 5,
      "dialerSeats": 10,
      "aiMessaging": {"standardBundles": 3, "advancedBundles": 0}
    }

Removing Licenses

Set values to 0 to remove licenses:

{
      "ccId": {"resellerId": "RESELLER001", "tenantId": "TENANT456"},
      "essentialSeats": 0,
      "dialerSeats": 0,
      "aiMessaging": {"standardBundles": 0, "advancedBundles": 0}
    }

Switching AI Messaging Tiers

Switch from Standard to Advanced (note mutual exclusivity):

{
      "ccId": {"resellerId": "RESELLER001", "tenantId": "TENANT456"},
      "aiMessaging": {"standardBundles": 0, "advancedBundles": 2}
    }

License Deletion

DELETE /v1/licensing/update schedules all licensing resources for a customer to be deleted within 1 week. Only requires the ccId object for identification. This operation is irreversible after the deletion period expires.

Transcription & Sentiment Analysis

This service provides automated transcription of voice calls and sentiment analysis on the conversation text. Licensing is based on a shared pool of hours available to all authorized agents on the account.

Minimum Requirement: A customer must have at least one **Voice Office User / Essentials license** (or higher) to enable the necessary call recording features.

License Types

WFA-200-SA (Base License)

This is a per-agent named license. For each agent assigned this license, **48 hours/month** are added to the account's shared transcription pool.

WFA-201-SA (Bulk Hour Add-on)

This license adds a bulk amount of **24 hours (1,440 minutes)** to the account's shared transcription pool. It can be purchased multiple times.

Elite License Inclusion

Each Elite agent seat automatically includes the benefits of the `WFA-200-SA` base license, contributing **48 hours/month** to the shared pool.

AI Messaging

This service provides an AI-powered messaging bot for automated customer interactions, using a knowledge base for its responses. Licensing is based on purchasing mutually exclusive bundles for the entire account.

Minimum Requirement: A customer must have at least one **Professional license** (or higher) to be eligible for any AI Messaging licenses.

Mutual Exclusivity Rules

Critical Rule: Only one bundle type can be > 0 at a time. You cannot have both standardBundles > 0 AND advancedBundles > 0 simultaneously.

Bundle Types

Standard Bundles

API Field: standardBundles

5,000 Messages per bundle
2 Knowledge Bases per bundle
No 3rd Party Integrations

Advanced Bundles

API Field: advancedBundles

5,000 Messages per bundle
5 Knowledge Bases per bundle
3rd Party Integrations

Elite License Benefit & Upgrade Path

An account with at least one Elite license automatically includes one (1) `Xima-MAI-Standard-1` bundle. This provides 5,000 messages and 2 knowledge bases and does not increase with more Elite seats.
To get more messages and knowledge bases, purchase additional Standard bundles. Each bundle adds 5,000 messages and 2 knowledge bases to your account's pool.
To get 3rd party integration support, you MUST purchase Advanced bundles.