Patron API

The Patron Services API is a collection of API calls that can be used to create patron-facing applications. A few examples may be:

• Mobile application that allows a patron to request a call back at a future time
• Web site that allows users to request a live chat session with an agent
• Applications or services that create "work items" to be routed in the NICE CXone system (such as routing trouble tickets or sales opportunities from a web request, or from a process that is monitoring a CRM system.)

General Requirements

To use any of the NICE CXone APIs in your application, you must have an API authentication token from the token service. See the Getting Started tutorial for information on what type of token is needed for your application and how to get an API Authentication Token.

NOTE : The application calling APIs can inject an ID called the CorrelationId in the API headers. In such a case, the API response will send back the injected CorrelationId in the API response. There is no change in the API response if the CorrelationID is not injected. See the CorrelationId: Getting Started for more information on CorrelationId.