Each HTTPS request requires a valid "API access token," which is retrieved via an OAuth2, Access Key or OpenID Connect authentication process. Because the RESTful API works over HTTPS, it can be used from any platform, programming language, or environment that supports HTTPS.
When parsing the responses for our APIs, we recommend using publicly available internal or easily accessible third party libraries for serializing and deserializing JSON. If, however, you write your own JSON parser, please keep the following in mind:
API calls are grouped in documentation based on their common use or function. In order to use all of the APIs you will need to validate you have access under the Permissions tab, in your NICE CXone Central Security Profile or CXone UserHub Role. You will also need to review configuration in the Restrict Data tab as that may limit the data in the API responses based on your campaign and team data settings.
For information on getting API access tokens see CXone Authentication: Getting Started click here.
The Authentication API is a collection of API calls that deal specifically with the system resources required to login to the CXone platform.
The Admin API is a collection of calls that deal with system resources in the NICE CXone and Customer Interaction Cloud system such as Agents, Skills, AddressBooks etc...
The Agent API is used to create, manage, and end "agent sessions." With an agent session, you are able to manage interactions on channels such as Phone Calls, Chats, Emails, Voice Mails, SMS, and Work Items.
The Patron API can be used to create patron-facing applications. For example, you can create a mobile application that allows a patron to request a call back or a web site that allows users to request a live chat session.
The Real-time Data API is a collection of API calls that provide access to "real-time" data on the platform. This API can be used to create custom dashboards and control panels, and to provide information to agents (leaderboards, etc.).
The Reporting API is a collection of API calls that provide access to "historical" data on the platform. This API can be used to run Custom Reporting reports and retrieve calculated metrics.
The purpose of this page is to provide documentation on using Access Key APIs
The Data Extraction API lets you extract data from CXone for external reporting purposes.
The Media Playback API lets you to access CXone recording media.
Digital Engagement API can be used to configure an integration between the NICE CXone Digital platform and a third party messaging application.
The Business Data API lets you access business data microservice APIs.
Access information about individual agent schedules from the CXone Workforce Management application.
Access information about individual agent schedules from the CXone Workforce Management application.
Interaction Analytics is an intelligent linguistic analytics application. It converts contact center interactions into easily understood data. If you have Interaction Analytics set up, these APIs provide access to your interaction data.
Manage requests to erase CXone user data. This helps you comply with privacy regulations like GDPR
