Stay organized with collections
Save and categorize content based on your preferences.
The Contact Center AI Platform (CCAI Platform) provides API endpoints to support integration with the
platform. The Apps API extends features of the channels that the platform
supports, including calls, chats and SMS. The endpoints are grouped into the
following categories:
Requests use basic authentication. To create API credentials follow these steps:
Go to the CCAI Platform portal.
Go to Settings > Developer Settings > API Credentials.
Add a new APi credentials and provide a name.
The credentials for API calls are as follows:
The subdomain is used as the {username} variable.
The token is used as the{password} variable.
Every installation has its own subdomain. To find the subdomain, locate
the URL in your browser. It should look similar to the following:
https://customer.uc1.ccaiplatform.com
Substitute the subdomain (customer, in this example) for the {subdomain}
variable. Substitute the remainder of the URL (rest.of.url.com, in this
example) for the {domain} variable.
Base URL
The API uses the following base URL for all of its API requests
https://{subdomain}.{domain}/apps/api/v1
where a mention to /calls means https://{subdomain}.{domain}/apps/api/v1/calls
Rate Limits
The system limits requests to a rate of 10 request per second per customer.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["The CCAI Platform offers an Apps API with various endpoints to enhance call, chat, and SMS functionalities."],["API endpoints are categorized by features such as agent status, bulk user management, calls, campaigns, chats, co-browse, company do not call list, contact data, end users, force agent logout, SMS, and wait times."],["API requests utilize basic authentication, with the subdomain acting as the username and the token as the password."],["The base URL for all API requests follows the format: `https://{subdomain}.{domain}/apps/api/v1`."],["The system imposes a rate limit of 10 requests per second per customer."]]],[]]
