API

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>API</title> <link rel="shortcut icon" href="/favicon.ico" type="image/vnd.microsoft.icon" /> <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" type="text/css" /> <link href="/CorporateStyles/Content/V2/bootstrap/css/bootstrap.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/bootstrap/css/bootstrap-override.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/kendo/kendo.common.min.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/kendo/kendo.default.min.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/kendo/kendo-incontact-corpit.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Site.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Button.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Menu.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Form.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/PopOverMenu.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/SearchControl.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/HomePage.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/PageFormat.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/kendo/kendo-incontact-custom.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Common.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Header.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Footer.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/NavBar.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/bodySass.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/Body.css" rel="stylesheet"/> <link href="/CorporateStyles/Content/V2/MediaQuery.css" rel="stylesheet"/>  <link href="/Content/Site.css" rel="stylesheet"/> </head> <body>  <noscript> <iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NQK7TT3J" height="0" width="0" style="display:none;visibility:hidden"></iframe> </noscript>  <script src="/Scripts/jquery-1.10.2.min.js"></script> <div id="header-v6"> <div id="header-hidden"></div> <div id="user-menu-responsive-hidden"></div> <div id="navbar-menu-responsive-hidden"></div> </div> <header id="header" class="header-global"> <div class="header-v6"> <div class="text-header color-white"> <div id="header-v6-search-container" class="background-gray-color search-container-v6"> <div class="container"> <div class="search"> <input type="text" class="searchText searchBoxV2" placeholder="Search" name="keywords" id="searchBoxV2" onkeydown="SearchValue()" maxlength="255"> <i class="fa fa-times-circle-o iconCloseSearch" onclick="HeaderDisplaySerch(false)"></i> </div> </div> </div> <div class="main-menu-container"> <div class="container"> <div class="user-container"> <div class="user-bu"> </div> <div class="user-menu"> <ul style="list-style-type: none"> <li> <a href="/Home/Login?returnUrl=%2FAPI">Login</a> </li> <li> <a href="https://support.incontact.com/">Support</a> </li> <li> <div id="contactUs-container" class="contactUs-container"> <button id="buttonContactUs" class="background-primary-color buttonContactUs button-v6"> Contact Us </button> <i id="iconContactUs" class="fa fa-chevron-right background-primary-dark-color iconContactUs"> </i> </div> </li> <li> <a class="fa fa-search iconSearch" href="/Search" id="SearchText"> </a> </li> </ul> </div> </div> <div class="menu-container-v6"> <div class="logo-container"> <a href="/"> <img class="logo-image" src="/Content/images/Dev-comm-logo-63.png" alt="DEVone NICE inContact"> </a> </div> <div class="menu-normal-container"> <nav id="nav-v6" class="nav-v6 navbar navbar-default navbar-static-top" role="navigation"> <div class="collapse navbar-collapse" id="navbar-v6"> <ul class="nav navbar-nav" style="list-style-type: none"> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="/API">API<i class="fa fa-angle-down custom-fa" aria-hidden="true"></i></a> <ul class="dropdown-menu" style="list-style-type: none"> <li><a href="/API/AdminAPI">Admin APIs</a></li> <li><a href="/API/AgentAPI">Agent APIs</a></li> <li><a href="/API/AuthenticationAPI">Authentication APIs</a></li> <li><a href="/API/PatronAPI">Patron APIs</a></li> <li><a href="/API/RealTimeDataAPI">Real-Time Data APIs</a></li> <li><a href="/API/ReportingAPI">Reporting APIs</a></li> <li><a href="/API/UserHubAPI">UserHub APIs</a></li> <li><a href="/API/DataExtractionAPI">Data Extraction APIs</a></li> <li><a href="/API/MediaPlaybackAPI">Media Playback APIs</a></li> <li><a href="/API/DigitalEngagementAPI">Digital Engagement APIs</a></li> <li><a href="/API/BusinessDataAPI">Business Data APIs</a></li> <li><a href="/API/WFMAPI">WFM APIs</a></li> <li><a href="/API/MultiACDAPI">Multi ACD APIs</a></li> <li><a href="/API/InteractionAnalyticsAPI">Interaction Analytics APIs</a></li> <li><a href="/API/PrivacyAPI">Privacy APIs</a></li> </ul> </li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="/Documentation">Documentation<i class="fa fa-angle-down custom-fa" aria-hidden="true"></i></a> <ul class="dropdown-menu" style="list-style-type: none"> <li><a href="/Documentation/GettingStarted">Getting Started</a></li> <li><a href="/Documentation/AgentSessionEvents">Agent Session Events</a></li> <li><a href="/Documentation/UsingEvents">Using Events</a></li> <li><a href="https://www.nice.com/devone-ecosystem">DEVone - Getting Started</a></li> <li><a href="/eLearning">eLearning</a></li> <li><a href="/Documentation/BYOCMiddleware">Set Up BYOC Middleware</a></li> </ul> </li> <li><a href="/Downloads">Downloads</a></li> <li><a href="/FAQ">FAQ</a></li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="/ForumHome">Forum<i class="fa fa-angle-down custom-fa" aria-hidden="true"></i></a> <ul class="dropdown-menu" style="list-style-type: none"> <li><a href="/Forum/cat/api-forum">API Forum</a></li> <li><a href="/Forum/cat/studio-forum">Studio Forum</a></li> </ul> </li> <li><a href="/WhatsNew">What`s New</a></li> <li class="dropdown"> <a class="dropdown-toggle" data-toggle="dropdown" href="https://www.nice.com/devone-ecosystem">DEVone Ecosystem<i class="fa fa-angle-down custom-fa" aria-hidden="true"></i></a> <ul class="dropdown-menu" style="list-style-type: none"> <li><a href="https://cxexchange.niceincontact.com/home">CXexchange Marketplace</a></li> <li><a href="https://www.nice.com/devone-ecosystem/#contact">Become a DEVone Partner</a></li> </ul> </li> </ul> </div> </nav> </div> <div class="menu-responsive-container"> <button id="custom-navbar" class="navbar-toggle background-primary-color"> <i class="fa fa-bars icon-responsive"></i> </button> <button id="user-button-responsive" type="button" class="navbar-toggle background-primary-color" onclick="switchMenuItemsResponsiveMode(this.id)"> <i class="fa fa-user icon-responsive"></i> </button> <button id="search-button-responsive" class="navbar-toggle background-primary-color" onclick="HeaderDisplaySerch(true)"> <i class="fa fa-search icon-responsive"></i> </button> </div> </div> </div> </div> </div> </div> </header> <div id="user-menu-responsive"> <nav id="user-nav-v6" class="nav-v6 navbar navbar-default navbar-static-top" role="navigation"> <div class="navbar-collapse" id="navbar-v6"> <ul class="nav navbar-nav" style="list-style-type: none"> <li class="dropdown"> <a class="dropdown-toggle" href="/Account/SignIn?returnUrl=%2FAPI">Login</a> </li> <li class="dropdown"> <a class="dropdown-toggle" href="https://support.niceincontact.com/" onclick="cleanMenu()"> Support </a> </li> <li class="dropdown"> <a class="dropdown-toggle" href="mailto:DEVone@niceincontact.com" onclick="cleanMenu()"> Contact Us </a> </li> </ul> </div> </nav> </div> <script> var userIsAuthenticated = false; $(document).ready(function () { $('#buttonContactUs,#iconContactUs').click(function () { location.href = '/ContactUs'; }); }); </script> <div id="body"> <div class="rest-api-home"> <div class="container"> <div class="row"> <div class="col-xs-12"> <div class="margin-top-bottom"> <h1 class="text-center primary-color">NICE CXone REST APIs</h1> <p> 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. </p> <div> <p> 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: </p> </div> <ul> <li><b>You should accept JSON elements in any order.</b></li> <li><b>Additional response elements may be added to released APIs.</b></li> <li><b>You should be able to serialize the collection despite any missing element.</b></li> </ul> <p class="margin-bottom-none"> 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. </p><br/> <p> For information on getting API access tokens see CXone Authentication: Getting Started <a href="/Documentation/GettingStarted">click here</a>. </p> </div> </div> </div> </div> </div> <div class="container"> <div class="marged-1"> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/AuthenticationAPI"><img src="/Content/images/API/Explore-Authentication-APIs.png" alt="Explore Authentication APIs" /></a> <a class="section-item__title" href="/API/AuthenticationAPI">Explore Authentication APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">The Authentication API is a collection of API calls that deal specifically with the system resources required to login to the CXone platform.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/AdminAPI"><img src="/Content/images/API/Explore-Admin-APIs.png" alt="Explore Admin APIs" /></a> <a class="section-item__title" href="/API/AdminAPI">Explore Admin APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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...</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/AgentAPI"><img src="/Content/images/API/Explore-Agent-APIs.png" alt="Explore Agent APIs" /></a> <a class="section-item__title" href="/API/AgentAPI">Explore Agent APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/PatronAPI"><img src="/Content/images/API/Explore-Patron-APIs.png" alt="Explore Patron APIs" /></a> <a class="section-item__title" href="/API/PatronAPI">Explore Patron APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/RealTimeDataAPI"><img src="/Content/images/API/Explore-Real-time-data-APIs.png" alt="Explore Real Time Data APIs" /></a> <a class="section-item__title" href="/API/RealTimeDataAPI">Explore Real Time Data APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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.).</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/ReportingAPI"><img src="/Content/images/API/Explore-Reporting-APIs.png" alt="Explore Reporting APIs" /></a> <a class="section-item__title" href="/API/ReportingAPI">Explore Reporting APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/UserHubAPI"><img src="/Content/images/API/Explore-Userhub-APIs.png" alt="Explore UserHub APIs" /></a> <a class="section-item__title" href="/API/UserHubAPI">Explore UserHub APIs</a> </div> <div class="section-item__right"> <p class="section-item__description"> The purpose of this page is to provide documentation on using Access Key APIs </p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/DataExtractionAPI"><img src="/Content/images/API/Explore-Data-Extraction-APIs.png" alt="Explore Data Extraction APIs" /></a> <a class="section-item__title" href="/API/DataExtractionAPI">Explore Data Extraction APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">The Data Extraction API lets you extract data from CXone for external reporting purposes.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/MediaPlaybackAPI"><img src="/Content/images/API/Explore-Media-Playback-APIs.png" alt="Explore Media Playback APIs" /></a> <a class="section-item__title" href="/API/MediaPlaybackAPI">Explore Media Playback APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">The Media Playback API lets you to access CXone recording media.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/DigitalEngagementAPI"><img src="/Content/images/API/Explore-Digital-Engagement-APIs.png" alt="Explore Digital Engagement APIs" /></a> <a class="section-item__title" href="/API/DigitalEngagementAPI">Explore Digital Engagement APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">Digital Engagement API can be used to configure an integration between the NICE CXone Digital platform and a third party messaging application.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/BusinessDataAPI"><img src="/Content/images/API/Explore-Business-Data-APIs.png" alt="Explore Business Data APIs" /></a> <a class="section-item__title" href="/API/BusinessDataAPI">Explore Business Data APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">The Business Data API lets you access business data microservice APIs.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/WFMAPI"><img src="/Content/images/API/Explore-WFM-APIs.png" alt="Explore WFM APIs" /></a> <a class="section-item__title" href="/API/WFMAPI">Explore WFM APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">Access information about individual agent schedules from the CXone Workforce Management application.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/MultiACDAPI"><img src="/Content/images/API/Explore-MultiACD-APIs.svg" alt="Explore Multi-ACD APIs" /></a> <a class="section-item__title" href="/API/MultiACDAPI">Explore Multi-ACD APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">CXone Multi-ACD (CXone Open) lets you take advantage of CXone cloud recording and business applications while still using your existing telephony system. The Multi-ACD APIs are a set of APIs to manage voice and screen recording in a Multi-ACD environment.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/InteractionAnalyticsAPI"><img src="/Content/images/API/Explore-IA-APIs.png" alt="Explore Interaction Analytics APIs" /></a> <a class="section-item__title" href="/API/InteractionAnalyticsAPI">Explore Interaction Analytics APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">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.</p> </div> </div> <div class="section-item"> <div class="section-item__left"> <a class="section-item__icon" href="/API/PrivacyAPI"><img src="/Content/images/API/Explore-Privacy-GDPR-APIs.png" alt="Explore Privacy APIs" /></a> <a class="section-item__title" href="/API/PrivacyAPI">Explore Privacy APIs</a> </div> <div class="section-item__right"> <p class="section-item__description">Manage requests to erase CXone user data. This helps you comply with privacy regulations like GDPR</p> </div> </div> </div> </div></div> <footer id="footer-v6" class="footer-v6 color-white-light"> <div class="container"> <div class="row"> <div class="col-xs-12"> <a href="/"> <img src="/Content/images/Dev-comm-logo-40.png" alt="logo" /> </a> </div> </div> <div class="row"> <div class="col-lg-3 col-md-3 col-sm-6 col-xs-12"> <h3><a href="https://www.nice.com/devone-ecosystem">DEVone Ecosystem</a></h3> <ul> <li><a href="https://cxexchange.niceincontact.com/home">Featured Applications</a></li> <li><a href="https://www.nice.com/devone-ecosystem/#contact">Become a DEVone Partner</a></li> <li><a href="mailto:iCEPartnerInfoRequests@incontact.com">Help Center</a></li> <li><a href="https://www.nice.com/company/legal">Terms & Conditions</a></li> <li><a href="mailto:devonesupport@nice.com">Feedback</a></li> <li><a href="mailto:devonesupport@nice.com">Contact CXexchange Support</a></li> </ul> </div> <div class="col-lg-3 col-md-3 col-sm-6 col-xs-12"> <h3><a href="https://www.nice.com/products">Products</a></h3> <ul> <li><a href="https://www.nice.com/products/digital-self-service">Digital and Self-Service</a></li> <li><a href="https://www.nice.com/products/workforce-engagement">Workforce Engagement</a></li> <li><a href="https://www.nice.com/products/journey-orchestration">Journey Orchestration and Routing</a></li> <li><a href="https://www.nice.com/products/agent-assist">Agent Assist</a></li> <li><a href="https://www.nice.com/products/cx-analytics">CX Analytics</a></li> <li><a href="https://www.nice.com/products/automation">Automation</a></li> <li><a href="https://www.nice.com/products/open-cloud-platform">Open Cloud Platform</a></li> <li><a href="https://www.nice.com/solutions/proactive-customer-engagement">Proactive Customer engagement </a></li> </ul> </div> <div class="clearfix visible-sm-block"></div> <div class="col-lg-3 col-md-3 col-sm-6 col-xs-12"> <h3><a href="https://www.nice.com/solutions">Solutions</a></h3> <ul> <li><a href="https://www.nice.com/solutions/enterprise">Enterprise</a></li> <li><a href="https://www.nice.com/solutions/small-business">Small Business</a></li> <li><a href="https://www.nice.com/solutions/call-center-software">Call Center Software</a></li> <li><a href="https://www.nice.com/solutions/self-service">Self Service</a></li> </ul> </div> <div class="col-lg-3 col-md-3 col-sm-6 col-xs-12"> <h3><a href="https://www.nice.com/company/about-us">Company</a></h3> <ul> <li><a href="https://www.nice.com/careers">Careers</a></li> <li><a href="https://www.nice.com/company/global-leadership">Global Leadership</a></li> <li><a href="https://www.nice.com/company/media-center">Media Center</a></li> <li><a href="https://www.nice.com/blog">Blog</a></li> <li><a href="https://www.nice.com/events">Events</a></li> <li><a href="https://www.nice.com/company/legal/privacy-policy">Privacy Policy</a></li> <li><a href="https://www.nice.com/company/legal">Legal</a></li> </ul> </div> </div> </div> </footer> <div id="scrollToTop"> <i class="fa fa-angle-up" aria-hidden="true"></i> </div> <script src="/Scripts/jquery-1.10.2.js"></script> <script src="/CorporateStyles/Content/V2/bootstrap/js/bootstrap.js"></script> <script src="/CorporateStyles/Scripts/Custom/footer.js"></script> <script src="/CorporateStyles/Scripts/Custom/header.js"></script> <script src="/CorporateStyles/Scripts/Custom/navbar.js"></script> <script src="/CorporateStyles/Scripts/Custom/body.js"></script> <script src="/Scripts/misc.js"></script> </body> </html>

CINXE.COM

API