Stay organized with collections
Save and categorize content based on your preferences.
Contact Center AI Platform (CCAI Platform) provides a number of API endpoints to support
integration with the platform. The manager API extends features related to the
settings and configuration of the system as well as events and
activities.
The manager API endpoints fall into a one of a few groupings:
Agent: individual agent resources
Agent activity: whenever an agent widget changes user status or receives
a notification
Campaigns: the events associated with the outbound dialer
Calls: a single call resource
Chats: a single chat resource
Emails: a single email resource
Menu: the queues that agents are assigned to and that end users access
to receive support from an agent.
Team: the teams that an agent belongs to
User status: individual statuses that the agent widget can be in
Basic authentication
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}/manager/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-08-25 UTC."],[[["\u003cp\u003eCCAI Platform's manager API offers endpoints for managing agents, agent activity, campaigns, calls, chats, emails, menus, teams, and user statuses within the system.\u003c/p\u003e\n"],["\u003cp\u003eAPI access requires basic authentication using a subdomain as the username and a generated token as the password, which can be created in the CCAI Platform portal's Developer Settings.\u003c/p\u003e\n"],["\u003cp\u003eThe base URL for all API requests is \u003ccode\u003ehttps://{subdomain}.{domain}/apps/api/v1\u003c/code\u003e, where \u003ccode\u003e{subdomain}\u003c/code\u003e and \u003ccode\u003e{domain}\u003c/code\u003e are unique to each installation, accessible via the URL in your browser.\u003c/p\u003e\n"],["\u003cp\u003eThe API is subject to rate limiting, allowing a maximum of 10 requests per second per customer.\u003c/p\u003e\n"]]],[],null,["# Manager API\n\nContact Center AI Platform (CCAI Platform) provides a number of API endpoints to support\nintegration with the platform. The manager API extends features related to the\nsettings and configuration of the system as well as events and\nactivities.\n\nThe manager API endpoints fall into a one of a few groupings:\n\n- **Agent**: individual agent resources\n\n- **Agent activity**: whenever an agent widget changes user status or receives\n a notification\n\n- **Campaigns**: the events associated with the outbound dialer\n\n- **Calls**: a single call resource\n\n- **Chats**: a single chat resource\n\n- **Emails**: a single email resource\n\n- **Menu**: the queues that agents are assigned to and that end users access\n to receive support from an agent.\n\n- **Team**: the teams that an agent belongs to\n\n- **User status**: individual statuses that the agent widget can be in\n\nBasic authentication\n--------------------\n\nRequests use basic authentication. To create API credentials, follow these steps:\n\n1. Go to the CCAI Platform portal.\n\n2. Go to **Settings \\\u003e Developer Settings \\\u003e API Credentials**.\n\n3. Add a new API credentials and provide a name.\n\n| **Note:** The API key that you provide can't be retrieved later. Be sure to store it securely.\n\nThe credentials for API calls are as follows:\n\n- The subdomain is used as the `{username}` variable.\n\n- The token is used as the`{password}` variable.\n\nEvery installation has its own subdomain. To find the subdomain, locate\nthe URL in your browser. It should look similar to the following:\n\n`https://customer.uc1.ccaiplatform.com`\n\nSubstitute the subdomain (`customer`, in this example) for the `\\{subdomain\\}`\nvariable. Substitute the remainder of the URL (`rest.of.url.com`, in this\nexample) for the `\\{domain\\}` variable.\n\nBase URL\n--------\n\nThe API uses the following base URL for all of its API requests\n\n`https://{subdomain}.{domain}/apps/api/v1`\n\nwhere a mention to `/calls` means `https://{subdomain}.{domain}/manager/api/v1/calls`\n\nRate Limits\n-----------\n\nThe system limits requests to a rate of 10 request per second per customer."]]
