FAQ

The best place to start is by reading the Getting Started tutorial from the Documentation section.

Application registration is covered click here.

A 200 return code means that a synchronous request was completed successfully. A 202 return code means that an asynchronous action request completed successfully but further action should be done by the client to complete the final status.

Review the Getting Started guide for information on submitting your application registration.

Review the Getting Started and the App lifecycle page for information.

After processing your application registration, NICE emails you your app credentials. The credentials are in a password protected ZIP file. Ensure that your organization’s email too allows you to receive emails with such attachments. You may need to work with your IT group if your email tool already filtered out this registration email. For any additional issues, contact your CXone account representative.

Password and Client tokens are generally set to expire after an hour. When a token has expired, using the token with an API call will generate an error. Your application must then re-request a new token. This can be done by sending the authorization key again (for the Password and Client grant types), or by using a refresh_token to request a new API token (for the Implicit grant type). The refresh_token is provided with the API token when the API token is initially granted. Your application can store the refresh token for use when it is notified by the NICE CXone API Framework that your API token has expired. To learn more, see the Getting Started tutorial.

We do not have a standardized rate limit for CXone APIs. Individual APIs may have a published rate limit.

To use CXone APIs, you use credentials from a CXone user account. This is part of the authentication process. This user account must have a role assigned with the necessary permissions to use the API. You can review each endpoint’s documentation for required permissions. You can also learn about roles and permissions on the CXone online help site.

Pagination in APIs is a technique used to divide a large set of data into smaller, manageable chunks or "pages." This is particularly useful when working with databases or services that return a large number of records. Instead of retrieving the entire dataset at once, which can be inefficient and slow, pagination allows you to request and process one page of data at a time.

• skip: This parameter is used to specify the number of records to bypass or "skip" in the result set. For example, if you want to start retrieving data from the 11th record, you would set skip=10.
• top: This parameter is used to define the maximum number of records to return in a single page. For example, if you want to retrieve 10 records at a time, you would set top=10.

When used together, skip and top allow you to navigate through large datasets by controlling the starting point and the number of records per page. For example:

• First Page: skip=0&top=10 (retrieves the first 10 records)
• Second Page: skip=10&top=10 (retrieves the next 10 records, i.e., records 11 to 20)
• Third Page: skip=20&top=10 (retrieves records 21 to 30)

This approach helps in managing data retrieval efficiently and avoids the overhead of loading all records at once.

• Efficiency: Reduces memory usage and improves performance by loading only a subset of data at a time.
• Scalability: Allows APIs to handle large datasets without overloading the server or the client.
• User Experience: Provides a smoother experience for end-users by loading data in chunks, making applications more responsive.