---
title: NICE CXone API Integration on Truto
slug: nicecxone
category: Voice
canonical: "https://truto.one/integrations/detail/nicecxone/"
---

# NICE CXone API Integration on Truto



**Category:** Voice  
**Status:** Beta

## MCP-ready AI tools

Truto exposes 609 tools for NICE CXone that AI agents can call directly.

- **list_all_nice_c_xone_access_keys** — Returns a list of access keys. This method will return a list of â€œaccessKeyIdsâ€ and the agentId who can use it.It can be filter by adding â€œagentIdâ€ or paging parameters to the request. Required: agentId.
- **create_a_nice_c_xone_access_key** — Creates an accessKey. This method will create an accessKey for an agentId. Response will provide the public accessKeyId and the private accessKeySecret. Those parameters will can then be used to request a token.
- **get_single_nice_c_xone_access_key_by_id** — Returns the configuration of an accessKey. This method will return the configuration of an accessKey. NOTE: The Access Key APIs in this section are only to be used with Central. Required: id.
- **update_a_nice_c_xone_access_key_by_id** — Updates an accessKey by Id. This method updates an access keys configuration of â€œisActiveâ€ to true or false.AgentIds can only have 20 active or inactive accessKeys configured. Required: id.
- **delete_a_nice_c_xone_access_key_by_id** — Deletes an accessKey. This method will delete an accessKey configured for an agent.The maximum number of configured access keys for and agentId is 20.That includes active and inactive access keys. Required: id.
- **list_all_nice_c_xone_activesupervisors** — Returns Active supervisors status. This method will return all active supervisors status based on Teamid selected.
- **list_all_nice_c_xone_activity_audit** — New in 26.3: Retrieve activity audit events. Returns a paginated list of activity audit events for the authenticated tenant within the specified date range.
- **list_all_nice_c_xone_address_book_agents_assigned** — Lists all assigned agents for an address book. This method returns assigned agents for an address book Required: address_book_id.
- **list_all_nice_c_xone_address_book_agents_unassigned** — Lists all unassigned agents for an address book. This method returns unassigned agents for an address book Required: address_book_id.
- **list_all_nice_c_xone_address_book_dynamic_entries** — Lists all dynamic address book entries for an address book. This method returns all of the entries in the Address Book identified by addressBookId.This method utilizes a set of parameters that allow you to paginate the results of… Required: address_book_id, fullLoad.
- **nice_c_xone_address_book_dynamic_entries_bulk_update** — Create or Update Dynamic Address Book Entries. This method allows you to create or update entries in a Dynamic Address Book identified by addressBookId. Required: address_book_id, fullLoad, addressBookEntries.
- **delete_a_nice_c_xone_address_book_dynamic_entry_by_id** — Delete a Dynamic Address Book Entry. This method allows you to delete an entry identified by externalId in a Dynamic Address Book identified by addressBookId. Required: id, address_book_id.
- **list_all_nice_c_xone_address_book_entries** — Lists all standard address book entries for an address book. This method returns all of the entries in the Standard Address Book identified by addressBookId. Required: address_book_id.
- **create_a_nice_c_xone_address_book_entry** — Create Standard Address Book Entries. This method allows you to create new address book entries and associate them with a single address book identified by addressBookId. Required: address_book_id, addressBookEntries.
- **nice_c_xone_address_book_entries_bulk_update** — Update Standard Address Book Entries. This method allows you to update existing address book entries associated with a single address book identified by addressBookId. Required: address_book_id, addressBookEntries.
- **delete_a_nice_c_xone_address_book_entry_by_id** — Delete a Standard Address Book Entry. This method allows you to delete a single address book entry from an address book using the addressBookId and addressBookEntryId. Required: id, address_book_id.
- **list_all_nice_c_xone_address_books** — Returns a list of Address Books. This method returns a list of Address books for the Business Unit.
- **create_a_nice_c_xone_address_book** — Create a new Address Book. This method allows you to create an Address Book. Required: addressBookName, addressBookType.
- **delete_a_nice_c_xone_address_book_by_id** — Delete an existing Address Book. This method allows you to delete an existing Address Book specified by addressBookId. Required: id.
- **nice_c_xone_address_books_assign** — Assign Entities to an Address Book. This method allows you to assign an Address Book specified by addressBookId to one set of entities such as Agents, Teams, Skills or Campaigns exclusively, which means the Address Book can only… Required: address_book_id, entityType, addressBookAssignments.
- **list_all_nice_c_xone_agent_address_books** — Returns Address Books for an Agent. This method returns a list of Address Books currently assigned to the Agent identified by agentId. Address Books are assigned to Agents, Teams, Skills or Campaigns exclusively (i.e. Required: agent_id, includeEntries, addressBookType.
- **list_all_nice_c_xone_agent_client_data** — Gets a JSON object client data.
- **nice_c_xone_agent_client_data_bulk_update** — Updates or inserts a clientData record.
- **list_all_nice_c_xone_agent_configuration** — Returns agent configuration details for an agent with generic properties. This method returns agent configuration and settings related information. Required: agent_id.
- **list_all_nice_c_xone_agent_groups** — Returns a list of groups an agent is assigned. This method returns a list of groups an agent is assigned. Required: agent_id.
- **list_all_nice_c_xone_agent_indicators** — Returns an Agent Indicator List. This method will return all indicators currently queued for the agent specified by agentId. Required: agent_id.
- **list_all_nice_c_xone_agent_interaction_history** — Returns Contact history for all Agents. This method returns information on the contacts that the Agents were involved in between the dates specified, or since the ISO 8601 date/time provided in updatedSince parameter.
- **list_all_nice_c_xone_agent_interaction_history_by_agent** — Returns Contact history for an Agent. This method takes an agentId as input and will return back information on the contacts that Agent was involved in between the dates specified, or since the ISO 8601 date/time provided in… Required: agent_id, startDate, endDate, mediaTypeId.
- **list_all_nice_c_xone_agent_interaction_recent** — Returns info on Recent Contacts. This method returns information for all outbound phone contacts handled by the Agent identified by agentId over the reporting period specified by startDate and endDate. Required: agent_id, startDate, endDate.
- **list_all_nice_c_xone_agent_login_history** — Returns State duration for an Agent. This method will return the list of unique logins for the Agent identified by "agentId" within the period defined by "startDate" and "endDate" or return all of the logins if no reporting period… Required: agent_id, startDate, endDate.
- **create_a_nice_c_xone_agent_message** — Create an Agent message. This method creates, configures and assigns agent messages. Required: agentMessages.
- **get_single_nice_c_xone_agent_message_by_id** — Lists agent group messages. This method returns agent group messages Required: id.
- **delete_a_nice_c_xone_agent_message_by_id** — Delete agent message. This method deletes an Agent message. Required: id.
- **list_all_nice_c_xone_agent_messages** — Returns an Agent Message List. This method will return all messages currently queued for the agent specified by agentId. Required: agent_id.
- **list_all_nice_c_xone_agent_patterns** — Returns Agent Dialing patterns. This method will return a list of all possible Agent Dialing patterns that can be used for an Agent.
- **nice_c_xone_agent_patterns_transform_phonenumbers** — Transform Input Number. This Method takes Multiple Input Number and a dialing pattern set id which is a set of multiple dialing patterns. Required: agentpattern_id.
- **list_all_nice_c_xone_agent_performance** — Returns a performance summary of all Agents. This method returns a per-agent summary for all Agents in the business unit over the time frame between "startDate" and "endDate".The date fields require quarter hour time stamps. Required: startDate, endDate.
- **list_all_nice_c_xone_agent_performance_by_agent** — Returns performance summary for a specific agent. This method returns a summary for the Agent specified over the time frame between "startDate" and "endDate".The date fields require quarter hour time stamps. Required: agent_id, startDate, endDate.
- **list_all_nice_c_xone_agent_profile_configurations** — Returns Assignable Configurations for an Agent Profile. This method return agent profiles configurations which is a list of settings that you can see on agent profiles UI.
- **nice_c_xone_agent_profile_teams_search** — Returns all the team details. This method returns details of the teams for a particular tenant and their mapping to desktop profile if any.
- **list_all_nice_c_xone_agent_profile_teams** — Get Teams assigned to an Agent Profile. This method fetches the team details of teams assigned to desktop profile. Required: profile_id.
- **create_a_nice_c_xone_agent_profile_team** — Assigs team to an Agent Profile. This method assigns teams to DesktopProfiles based on the unique desktop profile id provided. Required: profile_id.
- **nice_c_xone_agent_profile_teams_bulk_delete** — Removes the assigned team(s) to an Agent Profile. This method removes the assigned teams to desktop profiles based on the unique desktop profile id provided Required: profile_id.
- **list_all_nice_c_xone_agent_profiles** — Returns all Desktop Profiles. This method returns a list of desktop profiles for the tenant. This method also supports pagination parameters and gives the list as per the parameters provided.
- **create_a_nice_c_xone_agent_profile** — To create a new agent profile. This method creates a new desktop profile with profile name, description and list of configurations and their values
- **nice_c_xone_agent_profiles_search** — Returns all Agent Profiles for the search filters provided. This method returns a list of desktop profiles for the tenant.
- **nice_c_xone_agent_profiles_update_status** — To update the status of agent profile. This method updates status of existing desktop profile with new status for mentioned id.
- **get_single_nice_c_xone_agent_profile_by_id** — To get agent profile details by ID. This method returns details of a particular desktop profile for the tenant based on the unique agent profile id provided. Required: id.
- **update_a_nice_c_xone_agent_profile_by_id** — To update a agent profile. This method updates an existing desktop profile with profile name, description and list of configurations and their values for the desktop profile with mentioned id Required: id.
- **list_all_nice_c_xone_agent_profiles_assigned** — Returns agent profile details for CMA. This method returns a agent profile for the team to which the agent belongs.
- **list_all_nice_c_xone_agent_queues** — Returns contact summary for personal queue. This method returns information on the contact summary along with skill information for personal queue of an agent. Note: Recommended polling frequency for this API is 15 seconds. Required: agent_id.
- **list_all_nice_c_xone_agent_queues_detail** — Returns contact detail for personal queue agent. This method returns information on the contact detail along with skill information for personal queue of an agent. Required: agent_id.
- **list_all_nice_c_xone_agent_quick_replies** — Returns a list of Quick Replies. This method enables you to return all of the Quick Replies that are available in the Business Unit and a list of Skills that each Quick Reply is associated with.
- **list_all_nice_c_xone_agent_quick_replies_by_agent** — Returns a list of Quick Replies for an Agent. This method returns an Agent's Quick Replies associated with a specific Skill. Required: agent_id, skillId.
- **delete_a_nice_c_xone_agent_routing_attribute_by_id** — Unassigns a Routing Attribute from an Agent. Required: id.
- **list_all_nice_c_xone_agent_routing_attributes** — Retrieves an Agent's assigned Routing Attribute. Required: agent_no, status, maximumRows, startRowIndex, orderColumn, orderAsc, searchText, assigned.
- **nice_c_xone_agent_routing_attributes_bulk_update** — Updates an Agent's assigned Routing Attribute. Update an Agent's assigned Routing Attribute Required: agent_no.
- **list_all_nice_c_xone_agent_scheduled_callbacks** — Updated in v33.0 Returns Scheduled Callbacks for an Agent. This method allows you to request any waiting Scheduled Callback requests for the Agent identified by agentId in order to display them to the Agent in your application. Required: agent_id.
- **nice_c_xone_agent_session_interactions_add_chat** — Add a Chat Contact. If an agent is routed an incoming chat, and accepts it (i.e. the agent has an active chat), the agent is able to request additional chats be routed, allowing them to handle multiple chats at one time. Required: session_id.
- **nice_c_xone_agent_session_interactions_add_email** — Add an Email Contact. This method accepts an Email Contact for the Agent and places that Email into the Inbox for that Agent. Required: session_id.
- **nice_c_xone_agent_session_interactions_add_text** — Add chat or sms contact. If an agent is routed an incoming chat or sms, and accepts it (i.e. Required: session_id, mediaType.
- **nice_c_xone_agent_session_interactions_conference_calls** — Conference calls together. In order to conference two calls, you simply make the Conference Call API Request. You must have two calls in the Active or Holding state in order to conference them. Required: session_id.
- **nice_c_xone_agent_session_interactions_email_outbound** — Creates an outbound Email Contact. This method creates a contact used to send an email using the /agent-sessions/{sessionId}/interactions/{contactId}/email-send API. Required: session_id, skillId, toAddress.
- **nice_c_xone_agent_session_interactions_sms_outbound** — Creates an outbound SMS contact. This method creates an outbound SMS contact. Required: session_id, skillId.
- **nice_c_xone_agent_session_interactions_transfer_calls** — Transfer call. In order to transfer a call, you must have two calls active or holding. Required: session_id.
- **nice_c_xone_agent_session_interactions_cancel** — Cancels a presented scheduled callback. This method allows an agent to accept or reject a scheduled callback that has been presented. Required: session_id, callback_id.
- **nice_c_xone_agent_session_interactions_dial** — Dial a Scheduled Callback. This method accepts a Scheduled Callback and dials the number associated with that Callback. These Callbacks are also referred to as Promise Keepers or Promises. Required: session_id, callback_id.
- **nice_c_xone_agent_session_interactions_reschedule** — Reschedule a Scheduled Callback. This method reschedules a scheduled callback and for some future date. These callbacks are also referred to as Promise Keepers or Promises. Required: session_id, callback_id, rescheduleDate.
- **nice_c_xone_agent_session_interactions_accept** — Accepts an incoming contact. This API method allows an agent to indicate that they are willing to accept the chat. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_accept_consult** — Accept consult request. When one agent attempts to "consult" with another (by dialling an agent consult), the target agent receives an event indicating that a consult request is pending. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_activate** — Moves contact to in focus. This method moves an email contact into focus inside of MAX when the agent has multiple emails active at the same time. %VERSION_UPDATED_NOTE% adds support for “mediaType” 7 for SMS. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_activate_chat** — Restore a chat to an active state. The most recently routed chat becomes "active" for the agent. Only one chat can be considered "active" at any given time. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_amd_override** — Override AMD on a call. This method allows you to pre-empt the platform AMD process and label the contact as either an answering machine or a fax machine and moves the contact to it's next state. Required: session_id, contact_id, type.
- **nice_c_xone_agent_session_interactions_set_custom_data** — Post custom data to a Contact. This method enables you to create call-attached data for an existing contact identified by contactId. The method will send the script associated with the contactId into the OnData branch. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_set_disposition** — Dispositions a Contact. This method sets the primary and secondary dispositions on a contact after that contact has been disconnected. Required: session_id, contact_id, primaryDispositionId.
- **nice_c_xone_agent_session_interactions_email_forward** — Forwards an Email. This method allows the Agent to forward an Email contact they are working on to other Agents or even external addresses. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_park** — Parks an Email. This method allows the agent to park email once it is accepted by the agent Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_preview** — Preview an Email. This method allows the agent to preview emails Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_reply** — Reply to an Email. This method allows the Agent to reply to an Email contact they are working on. The Agent must have an outbound Email Skill assigned to them that must be passed in using the skillId parameter. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_restore** — Restore an Email. This method allows the agent to restore the emails Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_save_draft** — Email Save Draft. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_send** — Sends an Email. This method allows the Agent to send an Email to other Agents or external addresses. The Agent must have an outbound Email Skill assigned to them that must be passed in using the skillId parameter. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_email_unpark** — Unparks an Email. This method allows the agent to unpark the parked emails Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_end** — Ends a contact.In the case of a voice call, this action will hang up the call. This method will end the chat contact. This is similar to ending a phone call or work item. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_hold** — Places a contact on hold. Use this API to place an active call on hold. You must have the "contact ID" of the active call. The "contact ID" is delivered when the call is first active, in a "CallContactEvent". Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_independent_dial** — Dial an Independent call. This method is used for outbound phone contacts that will be made on an independent telephony system. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_independent_dial_outcome** — Disposition an Independent call. This method will update the outcome value of an independent call contact after the call is placed in a separate telephony system. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_mask** — Masks a recording with white noise. Whether a call is being recorded through an agent-initiated request, through an admin-initiated request, or through the LOGCALL action in an IVR script, the agent may need to "mask" the… Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_pause_voicemail** — Pause a Voicemail. This method pauses a recorded voicemail through the inContact Media Server. Each time you call this API, an event will be generated by the Media Server indicating the position at which the file is paused. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_play_voicemail** — Play a Voicemail. This method plays a recorded voicemail through the inContact Media Server. The playback occurs through the phone number assigned to the agent when the session was started. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_record** — Record a call. Calls can be recorded on the inContact platform through three different methods:. An administrator can begin recording a call from an administrative application, such as the inContact Central web site. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_reject** — Rejects an incoming contact. This API method allows an agent to indicate that they are unwilling to accept the chat. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_resume** — Resume call. Use this API request to "resume" a holding call. You must use the contact ID of a holding call. When a call is placed on hold, a "CallContactEvent" is generated. This event will contain the "contact ID" of the call. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_send_chat_text** — Send chat text to the patron. Use this API method to send text to a patron in a chat contact. Required: session_id, contact_id, chatText, chatTarget.
- **nice_c_xone_agent_session_interactions_snooze** — Snooze a Preview contact. This method snoozes a preview personal connection contact. The contact will be delivered to another agent. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_transfer_chat_to_agent** — Transfer chat to an agent. You can transfer a chat into an agent's personal queue, allowing the chat to be routed to a specific agent. Required: session_id, contact_id, targetAgentId.
- **nice_c_xone_agent_session_interactions_transfer_chat_to_skill** — Transfer chat to skill. You can transfer a chat into a skill queue, allowing the chat to be routed to another available agent with that skill. Required: session_id, contact_id, targetSkillId.
- **nice_c_xone_agent_session_interactions_transfer_email_to_agent** — Transfer Email to Agent. This method to enable your users to transfer an Email Contact to a different Agent. Make sure to use the Agent ID rather than the Agent name when transferring the Email. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_transfer_email_to_skill** — Transfer an Email to a skill. This method to enable your users to transfer an Email Contact to a different Skill queue. Make sure to use the Skill ID rather than the Skill name when transferring the Email. Required: session_id, contact_id.
- **agent_session_interactions_transfer_voicemail_to_agent** — Transfer Voicemail to an Agent. This method to enable your users to transfer an Voicemail Contact to a different Agent. Make sure to use the Agent ID rather than the Agent name when transferring the Voicemail. Required: session_id, contact_id, targetAgentId.
- **agent_session_interactions_transfer_voicemail_to_skill** — Transfer Voicemail to a Skill. This method to enable your users to transfer an Voicemail Contact to a different Skill queue. Make sure to use the Skill ID rather than the Skill name when transferring the Voicemail. Required: session_id, contact_id, targetSkillId.
- **nice_c_xone_agent_session_interactions_typing** — Notify Patron Agent is Typing. Use this API method to indicate to a Patron in a chat session that the Agent is typing a response or has entered the response in the session. Required: session_id, contact_id.
- **nice_c_xone_agent_session_interactions_unmask** — Stop masking a call recording. This API call will end the masking of a call recording. See "Mask a Call Recording" for details on masking. Required: session_id, contact_id.
- **nice_c_xone_agent_session_phone_dial** — Dial agent phone. The platform will automatically attempt to connect the agent phone or station if it is not connected, and a call is routed to the agent. Required: session_id.
- **nice_c_xone_agent_session_phone_end** — Ends the agent's phone call. The platform will automatically disconnect the agent phone after a configurable period of time of unused (see the inContact NG documentation for information on how to configure the timeout period). Required: session_id.
- **nice_c_xone_agent_session_phone_mute** — Mute agent phone. You can mute the agent phone so that other parties on the call cannot hear the agent. This allows you to place a control in your user interface that allows the agent to request that the agent phone be muted. Required: session_id.
- **nice_c_xone_agent_session_phone_unmute** — Unmute agent leg. If the agent phone is muted, you can use this API call to unmute the agent phone. See "Mute Agent Phone" above. No data is returned with the API call. Required: session_id.
- **create_a_nice_c_xone_agent_session** — Starts an agent session. Most of the Agent API resources can only be accessed through an "Agent Session". An agent session is started by POST-ing a new session request to the "agent-sessions" collection resource. Required: stationId.
- **nice_c_xone_agent_sessions_join** — Joins an existing agent session. Multiple devices or applications can log into the same agent session simultaneously. Required: asAgentId.
- **delete_a_nice_c_xone_agent_session_by_id** — Ending an agent session. Ending an agent session is similar to "logging off". Note that the Password Token is still valid and can be used in other API requests. The "end session" API request simply ends the agent’s session. Required: id.
- **nice_c_xone_agent_sessions_add_contact** — Requests an additional contact for MCH. This method adds a media type, like chat or email, for routing. Default would add the next available media type. Required: session_id.
- **nice_c_xone_agent_sessions_barge** — Gives a supervisor the ability to barge an agent on a live call. Barge mode can be activated on an active monitoring session, similar to coach mode. Required: session_id.
- **nice_c_xone_agent_sessions_coach** — Gives the ability to coach an agent on a live call. A supervising agent can "coach" an active agent while on a call. Required: session_id.
- **nice_c_xone_agent_sessions_consult_agent** — Dial agent consult. Used to call another agent as a "consultation". Dialing an agent as a consultation differs from dialing the target agent’s "personal queue" in that consultations are tracked and reported. Required: session_id.
- **nice_c_xone_agent_sessions_continue_reskill** — Continue or cancel a reskill call during closed hours. This method allows an application to decide how to handle a call received outside of the normal operating hours of an agent. Required: session_id.
- **nice_c_xone_agent_sessions_dial_agent** — Dials an agent's personal queue. Used to initiate a transfer of a call to another agent. The sending agent must have a single holding call in order to dial another agent, or the API will respond with a 409 status code. Required: session_id.
- **nice_c_xone_agent_sessions_dial_phone** — Dials an outbound call. This method is used to place an outbound phone call. You must include an "outbound skill id" to place a phone call. Required: session_id.
- **nice_c_xone_agent_sessions_dial_skill** — Dials a skill. Used to create an outbound phone call and place it into the named skill’s queue. The skillName parameter is required. Required: session_id.
- **nice_c_xone_agent_sessions_dialer_login** — Log into a dialer campaign. This API call allows an agent to log into (or join) a running Personal Connection outbound skill. In future releases we will replace skillName with skillId. Required: session_id, skillName.
- **nice_c_xone_agent_sessions_dialer_logout** — Log out of a dialer campaign. Logs the agent out of a running outbound Personal Connection skill (if the agent is logged into an outbound skill). Required: session_id.
- **nice_c_xone_agent_sessions_get_next_event** — Gets the next agent event description. When an agent session is started, events related to the session will occur on the platform. Required: session_id, timeout.
- **nice_c_xone_agent_sessions_monitor** — Gives the ability to monitor an agent on a live call. This API call allows an agent to monitor a call that is active for another agent using their active agent login/session. Required: session_id, targetAgentId.
- **nice_c_xone_agent_sessions_send_dtmf** — Send DTMF tones. This method is used to send specific DTMF tones to non-agent parties in the active session. Required: session_id, dtmfSequence, toneDurationMS.
- **nice_c_xone_agent_sessions_set_state** — Set agent status. This method will set the state of the Agent who owns the session specified by sessionId. An Agent can only be set to either "Available" or "Unavailable" state. Required: session_id, state.
- **nice_c_xone_agent_sessions_submit_feedback** — Post a Feedback. This method allows agents to enter "feedback" from an agent application. This feedback can be viewed by Managers, as well as by inContact personnel, so that patterns of issues can be identified (i.e. Required: session_id, categoryId, priority, comment.
- **nice_c_xone_agent_sessions_take_over** — Gives the ability to take over an agent on a live call. Entering Takeover mode is similar to coaching or barging: an active monitoring session must exist. Required: session_id.
- **list_all_nice_c_xone_agent_settings** — Get Agent Settings. This method returns the agent configuration to be used by agent applications, like MAX. Note: This API will be depricated by fall 2024 , for details on alternate API visit What's New Required: agent_id.
- **list_all_nice_c_xone_agent_skill_data** — Returns summary of all agent's contacts by skill. This method will return summary information about the contacts handled for each skill assigned to an agent over the period of time specified by "startDate" and "endDate". Required: startDate, endDate.
- **list_all_nice_c_xone_agent_skill_data_by_agent** — Returns summary of an agent's contacts by skill. This method will return summary information about the contacts handled for each skill assigned to an agent identified by agentId over the period of time specified by "startDate" and… Required: agent_id, startDate, endDate.
- **list_all_nice_c_xone_agent_skills** — Returns Skills assigned to all agents. This method will return the skill mappings for all agents currently configured in the business unit. Required: isAgentActive, isActive.
- **create_a_nice_c_xone_agent_skill** — Add or Modify skill assignments for multiple agent. This API helps to assign multiple skills to multiple agents
- **nice_c_xone_agent_skills_bulk_update** — Modify Skill assignments for an Agent. This method will modify the skill assignments for the Agent identified by agentId. Required: agent_id.
- **nice_c_xone_agent_skills_bulk_delete** — Remove Skill assignments for an Agent. This method will remove the skill assignments for the Agent specified by agentId. Required: agent_id.
- **list_all_nice_c_xone_agent_skills_by_agent** — Returns Skills assigned to an agent. This method will return the skill mappings for the Agent specified by agentId. Required: agent_id.
- **create_a_nice_c_xone_agent_skills_by_agent** — Assigns Skills to an Agent. This method will create new skill assignments for the Agent identified by agentId. Required: agent_id.
- **list_all_nice_c_xone_agent_skills_download** — Lists existing skills for download. This method returns existing skills for download
- **list_all_nice_c_xone_agent_skills_unassigned** — Returns Skills not assigned to an Agent. This method will return the Skills that are not currently assigned to the Agent specified by agentId. Required: agent_id.
- **list_all_nice_c_xone_agent_state_history** — Returns State duration for all Agents. This method returns the total time the Agents spent in each state over the time period spanned by "startDate" and "endDate".
- **list_all_nice_c_xone_agent_state_history_by_agent** — Returns State duration for an Agent. This method returns the total time the Agent specified by "agentId" spent in each state over the time period spanned by "startDate" and "endDate". Required: agent_id.
- **list_all_nice_c_xone_agent_states** — Returns the current state for all Agents. This method returns information on the current state of all Agents in the business unit, however if "updatedSince" is included in the query string, then only agents whose status has…
- **list_all_nice_c_xone_agent_states_by_agent** — Returns the current state for an Agent. This method returns information on the current state of the Agent identified by "agentId", however if "updatedSince" is included in the query string, then only agents whose status has… Required: agent_id.
- **list_all_nice_c_xone_agents** — Updated in v34.0 Get Agents List. This method will return a list of all agents currently configured in the business unit.After API version v31 and up to the latest version v34, the following fields were added and updated:…
- **create_a_nice_c_xone_agent** — Updated in v34.0 Create an agent. This method will create new Agents in the business unit.The Integrated Softphone (WebRTC) URLs and their weights for the Agent. Required: agents.
- **nice_c_xone_agents_bulk_update** — Updated in v34.0 Update an array of agents. In CXone User Hub, this API is not applicable and should not be used to update user records. Required: agents.
- **nice_c_xone_agents_search** — Get Agents that are assigned to Multiple agents. This method allows you to get all the agent details for all the specified agent IDs.
- **get_single_nice_c_xone_agent_by_id** — Updated in v34.0 Returns agent details by Agent ID. This method returns agent details by Agent ID. Required: id.
- **update_a_nice_c_xone_agent_by_id** — Updated in v34.0 Update Agent by Agent ID. This method will update the attributes for the Agent specified by agentId. Version 34 introduces a new parameter called DigitalEngagementEnabled,ACWEnabled and ACWRange. Required: id.
- **nice_c_xone_agents_update_custom_event** — Creates a Custom Agent Event. This method allows you to send an event to the agent identified by agentId. This event has no system triggers but can be called at any point from an external application. Required: agent_id.
- **nice_c_xone_agents_logout** — Forces an agent session to end. This can be useful if an agent has left their computer, and remains logged in, or if an agent session somehow becomes "stuck" and the agent is not able to log off using agent software (a rare… Required: agent_id.
- **nice_c_xone_agents_set_state** — Sets an Agent's State. This method will set the state of the Agent who owns the session specified by sessionId. An Agent can only be set to either "Available" or "Unavailable" state. Required: agent_id, state.
- **nice_c_xone_agents_change_password** — Changes an Agent's Password. This method will change the password of the Agent that retrieved the token being used to make this call. It will not change the password of other Agents. Required: currentPassword, newPassword.
- **nice_c_xone_agents_reset_password** — Resets an agent's password. This method requires the agentId and will reset the password for this Agent to the string supplied in the requestedPassword parameter. Required: agent_id.
- **list_all_nice_c_xone_agents_extended** — Get Agents Extended.
- **list_all_nice_c_xone_agents_issues** — Lists all agent issues. This method returns all agent issues Required: isClosed.
- **list_all_nice_c_xone_agents_states** — Returns a list of Agent States. This method will return a list of all possible Agent States that can be used for an Agent.
- **list_all_nice_c_xone_analytics_segment_analyzed_transcript** — Get analyzed interaction segment transcript. Returns the full transcript of an analyzed segment of an interaction. Returned data includes all licensed annotations (e.g. Required: segment_id.
- **list_all_nice_c_xone_analytics_segments_analyzed** — Get all analyzed interaction segments for a tenant. This API helps you get all analyzed interaction segments for your tenant. This API can be invoked by a valid user with Interaction Analytics license enabled.
- **list_all_nice_c_xone_apiversion** — Get All API version. This API returns the names of all the ACD APIs with their available versions in production.
- **list_all_nice_c_xone_apiversionreleaseinfo** — Get API version release information. This API returns all the names of all the ACD APIs with their Marketing release version.
- **list_all_nice_c_xone_applications** — Return all applications. This API will return all registered applications.
- **create_a_nice_c_xone_application** — Create a new application. Create a new application and return the new application including its assigned identifier and other fields.
- **get_single_nice_c_xone_application_by_id** — Return a single application based on its identifier. Required: id.
- **update_a_nice_c_xone_application_by_id** — Edit an existing application. Edit an existing application. Immutable fields may be present and will be ignored. Note that the type of the application may not be modifed. Any attempt to do so will result in a failure. Required: id.
- **delete_a_nice_c_xone_application_by_id** — Schedule the deletion of an existing application. Deletion of an application can have a huge impact, immediately disabling the ability of many users to authenticate. Because of the possible impact a staged deletion is provided. Required: id.
- **nice_c_xone_applications_disable** — Disable an existing application. Required: application_id.
- **nice_c_xone_applications_enable** — Enable an existing application. Enable an existing application. This action will also cancel any pending delete operation. Required: application_id.
- **list_all_nice_c_xone_associations** — Get associated/equivalent users to owner of access token. This api takes the jwt access token of the requesting user and returns any associated users
- **create_a_nice_c_xone_auth** — Exchange the connected access key ID and secret for a CXone bearer access token. The connector calls this on install and on a schedule; the token is stored in the account context.
- **nice_c_xone_authorization_roles_search** — Get role details as per given filter and metrices. This API searches for roles based on given search criteria and can return only expected fields.
- **create_a_nice_c_xone_billing_product_usage** — Submit product usage. This API supports both service-token-based and user-token-based requests. For service-token requests, a valid partnerBillingId is required.
- **get_single_nice_c_xone_billing_product_usage_by_id** — Fetch product usage by ID. Fetches submitted product usage data based on productTypeId with pagination. Supports only user-token-based requests. Required: id, startDate, endDate.
- **list_all_nice_c_xone_branding_profiles** — Returns Branding Profile. This method will return the active Branding Profile for the Business Unit specified by "businessUnitId", including base64 encoded image artifacts that can be used for branding custom applications. Required: businessUnitId.
- **update_a_nice_c_xone_business_data_contact_by_id** — Update business data for closed interactions. For all the segments available for the given acdContactId, replace/update the business data with the user provided business data Required: id.
- **update_a_nice_c_xone_business_data_contact_segment_by_id** — For defined segment for the given acdContactId, replace/update the business data with the user provided business data. Update business data at segment level for closed interaction. Required: id, contact_id.
- **list_all_nice_c_xone_business_unit** — Returns Business Unit config. This method will return the configuration elements of your Business Unit. This includes what features are available and whether or not they have been enabled.
- **list_all_nice_c_xone_business_unit_outbound_routes** — Get business unit outbound routes available for skills. Gets all the outbound telecom routes, for a specific BU, that have been configured to be assigned to a specific Outbound Dialer skill.
- **list_all_nice_c_xone_business_unit_time_zones** — Returns a list of enabled timezones. This method returns a list of timezones enabled for a business unit.
- **nice_c_xone_business_unit_time_zones_bulk_update** — Updates the enabled time zones. This method updates enabled time zones for a business unit. All time zones to be made available must be listed.
- **list_all_nice_c_xone_call_list_attempts** — Download a Calling List's attempts. This method will download the records of the attempts, or contacts, made for a calling list that has been previously uploaded for use in Personal Connection. Required: list_id.
- **list_all_nice_c_xone_call_list_jobs** — Returns the status of calling list upload jobs. This method returns the status of all currently in process calling list upload jobs. Required: startDate, endDate.
- **get_single_nice_c_xone_call_list_job_by_id** — Returns the status of calling list upload job. This method returns the status of all currently in process calling list upload for a job. Required: id.
- **delete_a_nice_c_xone_call_list_job_by_id** — Cancel Pending/Processing List Process. Cancels a Pending/Processing calling list upload. Required: id.
- **list_all_nice_c_xone_call_lists** — Returns all Calling Lists. This method will return a summary of data from all calling lists that have been previously uploaded.
- **create_a_nice_c_xone_call_list** — Create a Calling List mapping. This method will create a new Calling List container an define the mappings to be used when a file is uploaded into this container using the POST /lists/call-lists/{listId}/upload . Required: listName, externalIdColumn, destinationMappings.
- **get_single_nice_c_xone_call_list_by_id** — Download a Calling List. This method will download a specific calling list that has been previously uploaded. This download is not the equivalent of downloading a file from the inContact file system. Required: id.
- **delete_a_nice_c_xone_call_list_by_id** — Remove a Calling List. This method will remove a calling list that has been previously created. This method will allow you to mark a calling list as inactive as well as mark the list ready for deletion from the file system. Required: id.
- **nice_c_xone_call_lists_upload** — Upload new records to a call list. This method uploads new records to a previously created calling list. NOTE: There is a 2 MB file size limit. If the file is larger than this limit, the request will fail. Required: list_id, listFile, forceOverwrite, expirationDate, startSkill, sendEmail.
- **nice_c_xone_call_lists_remove_prospects** — Remove Prospects from a Source. This method removes prospective contacts from a list by “sourceName”. Required: source_name.
- **list_all_nice_c_xone_campaign_address_books** — Returns Address Books for a Campaign. This method returns a list of Address Books currently assigned to the Campaign as identified by campaignId. Required: campaign_id, includeEntries.
- **list_all_nice_c_xone_campaign_audit_history** — Returns a list of audit entries for a campaign. The campaigns GET API is designed to obtain a campaign audit-history Required: campaign_id.
- **list_all_nice_c_xone_campaign_skills** — Updated in v33.0 Returns a list of assigned skills to a campaign. The campaigns GET API is designed to obtain a list of assigned skills of a campaign Required: campaign_id.
- **create_a_nice_c_xone_campaign_skill** — Updated in v33.0 Assign Skills to Campaign. This API allows to assign an existing skills to existing a Campaign by ID Required: campaign_id.
- **nice_c_xone_campaign_skills_bulk_delete** — Updated in v33.0 Unassign Skills to Campaign. This API allows to unassign skills to existing a Campaign by ID Required: campaign_id.
- **list_all_nice_c_xone_campaign_skills_unassigned** — Updated in v33.0 Returns a list of unassigned skills to a campaign. The campaigns GET API is designed to obtain a list of unnasigned skills to a campaign Required: campaign_id.
- **list_all_nice_c_xone_campaigns** — Updated in v33.0 Returns a list of paginated Campaigns. The campaigns GET API is designed to obtain a campaign
- **create_a_nice_c_xone_campaign** — Creates a campaign. The campaigns POST API is designed to create a new campaign Required: name.
- **get_single_nice_c_xone_campaign_by_id** — Updated in v33.0 Returns the details of a campaign by ID. The campaigns GET API is designed to obtain a campaign by its identifier number Required: id.
- **update_a_nice_c_xone_campaign_by_id** — Updated in v33.0 Campaign Update. This API allows to update an existing Campaign by ID . NOTE: The divisionId cannot be modified Required: id, name.
- **nice_c_xone_campaigns_update_status** — Updated in v33.0 Update a Campaign status. The campaigns PATCH API is designed to update a campaign status Required: campaign_id.
- **list_all_nice_c_xone_communication_agent_messages** — Returns a list of paginated Messages for a determined Agent. The Agent Messaging GET API is designed to obtain an Agent Message
- **create_a_nice_c_xone_communication_agent_message** — Creates a new Agent Message. The Agent Messaging POST API is designed to create an Agent Message Required: expireMinutes, message, subject, targetType, validUntil.
- **nice_c_xone_communication_agent_messages_bulk_delete** — Deletes Agent Messages in Batch according to group of guids. Agent Messages Batch Delete
- **get_single_nice_c_xone_communication_agent_message_by_id** — Returns a list of paginated agent group messages. The Agent Messaging GET API is designed to obtain an Agent Message by Group ID Required: id.
- **delete_a_nice_c_xone_communication_agent_message_by_id** — Deletes an Agent Message by Group Message Guid. Required: id.
- **list_all_nice_c_xone_contact_chat_transcript** — Returns active Chat or SMS transcript. This method returns the transcript of an active Chat or SMS contact identified by contactId. This method will only return the chat transcript for up to 48 hours. Required: contact_id.
- **create_a_nice_c_xone_contact_chat** — Starts a Chat Session. This method should be used to request a chat session on behalf of a Patron. A contact will be created and queued to the Skill associated with the Point Of Contact identified by Point Of Contact. Required: pointOfContact, mediaType.
- **nice_c_xone_contact_chats_send_email** — Sends chat transcript via email. This method sends the chat transcript to an email address. Required: toAddress, fromAddress, emailBody.
- **get_single_nice_c_xone_contact_chat_by_id** — Gets any inbound chat text from an active chat session. Returns the chat messages associated with an active chat session as well as returns the new "chatSession" value that should be passed into subsequent calls. Required: id, timeout.
- **delete_a_nice_c_xone_contact_chat_by_id** — Ends an active Chat Session. Ends the chat identified by {chatSession}. Required: id.
- **nice_c_xone_contact_chats_send_text** — Sends a text to members of the chat session. Posts the string provided in "message" to the chat session identified by "chatSession". Text used to label the message when viewed by the recipient. Required: chat_session, label, message.
- **nice_c_xone_contact_chats_typing** — Notify Agent Patron is Typing. Use this API method to indicate to an Agent in a chat session that the Patron is typing a response or has entered the response in the session. Required: chat_session.
- **nice_c_xone_contact_chats_typing_preview** — Sends Agent a Chat Preview. This method sends the text typed into the chat interface as the Patron is typing it and before they have hit the enter key. This functionality must be enabled on the Chat Skill as defined in Central. Required: chat_session.
- **list_all_nice_c_xone_contact_custom_data** — This method will return any custom data by date range of maximum 15 days. This method will return information on all custom contacts within the period defined by startDate and endDate. The requested data should not exceed 15 days. Required: startDate.
- **list_all_nice_c_xone_contact_custom_data_by_contact** — Returns Contact Custom Data. This method will return any custom data for the Contact specified by contactId. Required: contact_id.
- **list_all_nice_c_xone_contact_disposition** — Returns disposition details for that particular digital/ACD contact id. The Disposition details API endpoint is designed to facilitate the retrieval of disposition details associated with a specific ACD or digital contact ID. Required: contact_id.
- **list_all_nice_c_xone_contact_email_transcript** — Returns an Email Transcript. This method returns the transcript of the Email contact identified by contactId. Required: contact_id.
- **list_all_nice_c_xone_contact_files** — Returns a Contacts Files. This method returns the files associates with the Contact identified by "contactId". Required: contact_id.
- **list_all_nice_c_xone_contact_hierarchy** — List of associated contacts by ID. This method returns the associated contactIds by contactId. Method will return the master contact ID and the associated contact IDs to that master contactId. Required: contact_id.
- **list_all_nice_c_xone_contact_historical_chat_transcript** — Returns historical chat transcript. This method returns a historical chat transcript by ContactId. Required: contact_id.
- **list_all_nice_c_xone_contact_sms_historical_contacts** — Returns past SMS contacts. This method will return all past contactIds for a requested “skillId” and “ani” from storage services. “ani”, “skillId”, and “businessUnitId” are required as part of the request url. Required: ani, skillId, businessUnitId.
- **list_all_nice_c_xone_contact_sms_historical_transcript** — Returns SMS transcript. This method will return a sms transcript from storage services by “contactId”. “businessUnitId” is a required parameter added to the request url. Required: contact_id, businessUnitId.
- **list_all_nice_c_xone_contact_sms_transcripts** — Returns SMS Transcripts for a date range and transport code. This method returns an array of sms messages for the specified date range and transport code. Required: transportCode, startDate, endDate, agentId.
- **list_all_nice_c_xone_contact_sms_transcripts_by_contact** — Returns SMS Transcripts for a contactId. This method returns an array of completed sms transcripts for the specified date range and transport code. Required: contact_id, transportCode, startDate, endDate.
- **list_all_nice_c_xone_contact_state_descriptions** — Returns a list of contact states. Can be useful in presenting categories of contact states in a report or dashboard.
- **get_single_nice_c_xone_contact_state_description_by_id** — Returns a single contact state. Can be useful in presenting categories of contact states in a report or dashboard. Required: id.
- **list_all_nice_c_xone_contact_state_history** — Returns State duration for all Agents. This method returns the total time the Agents spent in each state over the time period spanned by "startDate" and "endDate". Required: startDate, endDate.
- **list_all_nice_c_xone_contact_state_history_by_contact** — Returns Contact State History. This method will return information on the states that a Contact, identified by "contactId", has gone through. Required: contact_id.
- **list_all_nice_c_xone_contact_states** — Returns active Contacts states. This method will return the real time state for all active Contacts in the business unit, however, if "updatedSince" is included in the body request, all the contacts whose status is active and…
- **create_a_nice_c_xone_contact_tag** — Assigns Tags to a Contact. This method assigns Tags to the contact identified by contactId. Required: contact_id, tags.
- **nice_c_xone_contacts_end** — Force a contact to be disconnected and to end. Can be useful for ending "stuck" contacts (where both parties have ended their respective legs, but the contact still shows as "active" on the platform). Required: contact_id.
- **nice_c_xone_contacts_monitor** — Starts monitoring a phone call. The inContact platform will call the phone number you specify, and begin streaming the voice interaction to that phone. Required: contact_id, phoneNumber.
- **nice_c_xone_contacts_record** — Allows to begin the recording of an active phone call. Once you begin recording a call, there is no way to stop the recording until the call is ended. Required: contact_id.
- **nice_c_xone_contacts_set_disposition** — Set Disposition For Contact. Sets the disposition for an active outbound dialer contact. This is only available for outbound dialer. This will then suppress the agent disposition experience in MAX. Required: contact_id.
- **list_all_nice_c_xone_contacts** — Returns details for all Contacts. Gets the information of each Contacts Completed and Contacts Active in the Business Unit.
- **get_single_nice_c_xone_contact_by_id** — Returns Contacts details. This method will return information on the Contact specified by contactId. This method will return different information based on if the Contact is active or completed. Required: id.
- **list_all_nice_c_xone_contacts_active** — Returns Active Contacts. This method will return a list of active Contacts for the Business Unit. For this method, active Contacts are defined as those whose current state is not set to "EndContact"
- **list_all_nice_c_xone_contacts_completed** — Completed Contacts. This method will return information on all of the completed Contacts within the period defined by startDate and endDate or return all the completed Contacts that have been updated since the time specified by…
- **list_all_nice_c_xone_contacts_parked** — Returns Parked Contacts. This method will return a list of parked Email Contacts for the Business Unit.
- **get_single_nice_c_xone_conversation_metadata_survey_by_id** — New in 26.3: Get survey metadata. API Purpose Use this API to retrieve comprehensive survey metadata - including contact fields, survey questions, and custom follow-up fields for a specific survey. Required: id.
- **list_all_nice_c_xone_conversation_metadata_surveys** — New in 26.3: Get all surveys metadata. API Purpose Use this API to retrieve comprehensive survey metadata - including contact fields, survey questions, and custom follow-up fields.
- **create_a_nice_c_xone_correlation** — Create correlation. This method creates new correlation for the specified primary or secondary (BCP) tenant. Required: correlationId, entity, domain, entityId, entityName, isPrimary.
- **nice_c_xone_correlations_search** — Search correlations. This method searches the correlations based on provided filter which include fields correlationId, entityType, domain, entityId, status fields and tenantId, page, pageSize attributes.
- **update_a_nice_c_xone_correlation_by_id** — Update correlation. This method updates the correlation with provided details. Correlation details like status, version can be updated. Required: id, correlation_id.
- **list_all_nice_c_xone_countries** — Returns Countries. This method will return the list of Countries. This can be used when creating Agents through the POST /agents method.
- **list_all_nice_c_xone_country_states** — Returns States or Provinces. This method will return the list of States or Provinces if the Country identified by "countryId" is configured for either. This can be used when creating Agents through the POST /agents method. Required: country_id.
- **list_all_nice_c_xone_cxone_configuration** — Retrieve the standard discovery document for a tenant. Retrieve the standard discovery document for a tenant in the CXone environment. Required: tenantId.
- **nice_c_xone_dashboard_autopilot_grtable_export_data** — Export Autopilot Generative Response table data. Export Generative Response analytics data for Autopilot with basic time range filtering. Here is a guide of how to download data using the APIs - Help Center Guide Required: dateRange, timeZone.
- **nice_c_xone_dashboard_autopilot_knowledge_grtable_export_data** — Export Autopilot Knowledge Generative Response table data. Export Generative Response analytics data for Autopilot Knowledge with basic time range filtering. Required: dateRange, timeZone.
- **nice_c_xone_dashboard_copilot_aqtable_export_data** — Export Copilot Agent Query table data. Export Agent Query analytics data for Copilot with profile and agent filtering options. Here is a guide of how to download data using the APIs - Help Center Guide Required: dateRange, timeZone.
- **nice_c_xone_dashboard_copilot_astable_export_data** — Export Copilot Auto Summary table data. Export Auto Summary analytics data for Copilot with comprehensive filtering options. Here is a guide of how to download data using the APIs - Help Center Guide Required: dateRange, timeZone.
- **nice_c_xone_dashboard_copilot_kbtable_export_data** — Export Copilot Knowledge Base table data. Export detailed Knowledge Base analytics data for Copilot with comprehensive filtering options including team, skill, profile, and agent filters. Required: dateRange, timeZone.
- **list_all_nice_c_xone_data_definition_types** — Returns Data Types. This method will return all Data Definition types for use with defining custom data definitions that can be used when mapping columns of data when uploading a calling list.
- **list_all_nice_c_xone_data_extraction_jobs** — Gets status for all jobs. View a list of all job statuses per tenant. Possible statuses are Running, Succeeded, Failed, Cancelled, and Expired.
- **create_a_nice_c_xone_data_extraction_job** — Prepares requested data for extraction. After a request to extract data is made, the data is gathered and prepared for extraction. The data is available in S3 as a csv file for 24 hours. When done, a job ID is returned.
- **get_single_nice_c_xone_data_extraction_job_by_id** — Gets a specific job status. View the status for a specific job per its job Id. Required: id.
- **list_all_nice_c_xone_data_policy_instance_evidence_reports** — Get an S3 presigned evidence report URL for a specific policy based on the policy instance ID. This API retrieves a pre-signed URL for the evidence report. The report can be downloaded directly using this URL. Required: policy_id, policy_instance_id.
- **nice_c_xone_data_policy_instances_search** — Get All Policy Instances by status. Get list of all policy instances created by a tenant based on the policy instance status. Required: filters.
- **list_all_nice_c_xone_data_policy_instances** — Get details for all instances of a policy. Retrieves a list of policy instances associated with the specified policyId for the tenant. Required: policy_id.
- **get_single_nice_c_xone_data_policy_instance_by_id** — Get details of a policy instance. Retrieves the details of a policy instance, identified by policyInstanceId, for recurring policies created by the tenant. Required: id, policy_id.
- **create_a_nice_c_xone_data_policy_policy** — Create new policy. This API creates a new data policy (Retention Change, Media Deletion, or Data Erasure). Policies created via this API are visible in CXone. Approver permissions are required to create policies through this API. Required: policyName, policyType, entityType, criteria.
- **nice_c_xone_data_policy_policies_search** — Search and retrieve details for all policies. Get a list of all policies created by a tenant based on the filtering criteria provided. Required: filters.
- **get_single_nice_c_xone_data_policy_policy_by_id** — Fetch policy definition. This API retrieves the details of a policy created by the tenant, using the specified policyId. Required: id.
- **create_a_nice_c_xone_digital_attachment_temporary** — Upload base64 encoded file. Required: content, mimeType.
- **list_all_nice_c_xone_digital_channel_external_platform_templates** — Get list of external platform templates. Required: channel_id.
- **create_a_nice_c_xone_digital_channel_message** — Create message in DFO. Store message in DFO platform Required: channel_id, idOnExternalPlatform, direction, createdAtWithMilliseconds, thread, messageContent, authorEndUserIdentity.
- **nice_c_xone_digital_channel_messages_update_status** — Update message status. Update message status (seen, delivered or failed) Required: channel_id, message_id_on_external_platform, status, updatedAt.
- **update_a_nice_c_xone_digital_channel_thread_by_id** — Update thread. Update thread flags Required: id, channel_id.
- **nice_c_xone_digital_channel_threads_sender_actions** — Send sender action. Send typing indicator to connected channel Required: channel_id, thread_id_on_external_platform.
- **list_all_nice_c_xone_digital_channels** — Get list of existing channels.
- **create_a_nice_c_xone_digital_channel** — Create/Update Digital Channel (Point of Contact). Required: id, idOnExternalPlatform, channelIntegrationId, realExternalPlatformId, name, isPrivate, hasTreeStructure.
- **delete_a_nice_c_xone_digital_channel_by_id** — Delete existing channel in DFO platform. Required: id.
- **nice_c_xone_digital_channels_inbound** — Send inbound message. This endpoint is designed specifically to support case where you want to open email contact in DFO based on inputs from external system. (e.g. Required: channel_id, messageContent, authorCustomerIdentity.
- **nice_c_xone_digital_channels_outbound** — Send outbound message. Send message to connected channel and store message in DFO platform Required: channel_id, thread.
- **list_all_nice_c_xone_digital_consumer_contact_custom_fields** — Get Contact's Custom Field Definitions.
- **nice_c_xone_digital_contact_agent_contacts_close** — Close agent contact in contact. Required: contact_number, agent_contact_id.
- **delete_a_nice_c_xone_digital_contact_custom_field_by_id** — Remove custom field value from Contact. Required: id, contact_number.
- **list_all_nice_c_xone_digital_contact_detail_pagination** — Get pagination of contact detail. Required: contact_number.
- **nice_c_xone_digital_contact_inbox_assignment_bulk_update** — Change inbox assignee for contact. Required: contact_number, userId.
- **list_all_nice_c_xone_digital_contact_messages** — Get Contact messages. Messages are trimmed to 3000 characters, to get full message use GET /dfo/3.0/messages/:messageId Required: contact_number.
- **list_all_nice_c_xone_digital_contacts** — Get list of Contacts based on filter/s.
- **get_single_nice_c_xone_digital_contact_by_id** — Get Contact detail. Required: id.
- **update_a_nice_c_xone_digital_contact_by_id** — Update of selected contact's properties. Required: id.
- **nice_c_xone_digital_contacts_abandon** — Set contact as abandoned. Required: contact_number, type.
- **nice_c_xone_digital_contacts_update_custom_fields** — Change custom field values for contact. Required: contact_number.
- **nice_c_xone_digital_contacts_delete_inbox_assignment** — Unassign inbox assignee from contact. Required: contact_number.
- **nice_c_xone_digital_contacts_update_routing_properties** — Update Routing Properties for Contact. Required: contact_number.
- **nice_c_xone_digital_contacts_update_routing_queue** — Change routing queue for contact. Required: contact_number.
- **nice_c_xone_digital_contacts_update_status** — Change status of contact. Required: contact_number, status.
- **nice_c_xone_digital_contacts_send_transcript** — Send transcript. Send transcript to recipients Required: contact_number.
- **list_all_nice_c_xone_digital_customer_custom_field_definitions** — Get Customer's Custom Field Definitions.
- **digital_customer_custom_field_definitions_bulk_update** — Create or update Customer Custom Field Definition. Create or update Customer Custom Field Definition (based on ident) Required: ident, label, type.
- **delete_a_nice_c_xone_digital_customer_custom_field_by_id** — Remove custom field value from Customer. Required: id, customer_id.
- **list_all_nice_c_xone_digital_customer_notes** — Get list of customer notes. Required: customer_id.
- **create_a_nice_c_xone_digital_customer_note** — Create customer note. Required: customer_id, content.
- **update_a_nice_c_xone_digital_customer_note_by_id** — Update customer note. Required: id, customer_id, content.
- **delete_a_nice_c_xone_digital_customer_note_by_id** — Delete customer note. Required: id, customer_id.
- **list_all_nice_c_xone_digital_customers** — Get list of Customers based on filter.
- **get_single_nice_c_xone_digital_customer_by_id** — Get detail of the customer. Required: id.
- **nice_c_xone_digital_customers_update_custom_fields** — Update values of customer custom fields. Required: customer_id.
- **nice_c_xone_digital_customers_merge** — Merge customer with another customer. Required: customer_id.
- **create_a_nice_c_xone_digital_message_note** — Create new note to message. Required: message_id.
- **update_a_nice_c_xone_digital_message_note_by_id** — Update note of the message. Required: id, message_id, content.
- **delete_a_nice_c_xone_digital_message_note_by_id** — Remove note from message. Required: id, message_id.
- **create_a_nice_c_xone_digital_message_reaction** — Add reaction to a message in channel. Required: message_id, reaction_type.
- **nice_c_xone_digital_message_reactions_bulk_delete** — Delete reaction from a message in channel. Required: message_id, reaction_type.
- **update_a_nice_c_xone_digital_message_tag_by_id** — Add tag to message. Required: id, message_id.
- **delete_a_nice_c_xone_digital_message_tag_by_id** — Remove tag from message. Required: id, message_id.
- **list_all_nice_c_xone_digital_messages** — Get list of Messages based on filters. Message content is trimmed to 3000 characters, to get full message use GET /dfo/3.0/messages/:messageId
- **get_single_nice_c_xone_digital_message_by_id** — Get Message detail. Required: id.
- **nice_c_xone_digital_messages_remove_author_name** — Remove author name from message. Required: message_id.
- **nice_c_xone_digital_messages_remove_content** — Remove content of a message. Remove content of a message including attachments Required: message_id.
- **nice_c_xone_digital_messages_soft_delete** — This request deletes message on external platform and also adjusts flags in DFO platform to mark that this message is deleted. Required: message_id.
- **nice_c_xone_digital_messages_mark_read** — Set read status of a message. Required: message_id, isRead.
- **nice_c_xone_digital_messages_update_sentiment** — Set sentiment of a message. Required: message_id, sentiment.
- **nice_c_xone_digital_one_time_token_verification** — Verify one-time token and get CXone JWT authentication token. Required: brandId, userId, token, purpose.
- **list_all_nice_c_xone_digital_one_time_token_authentication** — Authenticate redirect URL for one-time token. Required: redirectUrl, state.
- **list_all_nice_c_xone_digital_routing_queues** — Get list of routing queues based on filter.
- **list_all_nice_c_xone_digital_tags** — Get list of Tags.
- **nice_c_xone_digital_tags_bulk_update** — Create Tag. Create new tag Required: title.
- **list_all_nice_c_xone_digital_threads** — Get list of threads based on a filter.
- **list_all_nice_c_xone_disposition_audit_history** — Returns a list of audit entries for Dispositions. This API allows to get a list of audit entries for a Disposition Required: disposition_id.
- **list_all_nice_c_xone_disposition_classifications** — Returns a list of disposition classifications. This method returns a list of the disposition classifications
- **list_all_nice_c_xone_disposition_skills** — Returns a list of dispositions with skill assignment. This method will return a list of dispositions and the â€œskillIdâ€ with â€œmediaTypeNameâ€ associated with each disposition.
- **list_all_nice_c_xone_disposition_skills_by_disposition** — Updated in v33.0 Returns a list of skills assigned to a disposition. This method will return a list of skills assigned to a disposition by dispositionId. Required: disposition_id.
- **list_all_nice_c_xone_dispositions** — This API Returns a list of paginated Dispositions. Returns the complete list of available paginated dispositions configured in the system.
- **create_a_nice_c_xone_disposition** — Create Dispositions. This API allows to create new Dispositions Required: dispositions.
- **get_single_nice_c_xone_disposition_by_id** — Get a Disposition By Id. This API get a Disposition By Id Required: id.
- **update_a_nice_c_xone_disposition_by_id** — Update an existing Disposition. This API allows to update a Disposition by Id Required: id.
- **nice_c_xone_dispositions_update_status** — Change status of existing Disposition By Id. Change status of Disposition By Id Required: disposition_id.
- **nice_c_xone_division_billing_codes_validate** — Validate Billing Code. Validates if the billing code is unique and within the allowed limit for the tenant. Required: billing_code.
- **create_a_nice_c_xone_division_identity** — API search divisions identities by filter. This API is used to search paginated divisions identities by filter
- **create_a_nice_c_xone_division** — Create division. Create a new division Required: name, status, isDefault.
- **nice_c_xone_divisions_bulk_update** — Update division. Update an existing division Required: name, status, isDefault.
- **nice_c_xone_divisions_search** — Search divisions. Search for divisions based on the provided criteria.
- **get_single_nice_c_xone_division_by_id** — Get division by ID. Retrieve a division by its ID. Required: id.
- **nice_c_xone_divisions_list_billing_codes** — Get All Billing Codes. Fetch all parent billing codes for a division. Required: division_id.
- **list_all_nice_c_xone_dnc_group_contributing_skills** — Returns Contributing Skills for a DNC Group. This method will return a list of all Skills that are configured to be able to contribute phone numbers to a Do Not Call (DNC) group identified by groupId. Required: group_id.
- **create_a_nice_c_xone_dnc_group_contributing_skill** — Assign a Contributing Skill. This method will assign a Skill specified by skillId as a contributing skill for a Do Not Call (DNC) Group. This means the Skill will be allowed to add records to the DNC Group. Required: group_id, skill_id.
- **delete_a_nice_c_xone_dnc_group_contributing_skill_by_id** — Removes a Contributing Skill. This method will remove a Skill specified by skillId as a contributing skill for a Do Not Call (DNC) Group. This means the Skill will no longer be allowed to add records to the DNC Group. Required: id, group_id.
- **list_all_nice_c_xone_dnc_group_records** — Returns Records in a DNC Group. This method will return all Records that are associated with the DNC Group identified by groupId. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: group_id.
- **create_a_nice_c_xone_dnc_group_record** — Add Records to a DNC Group. This method will add Records to a DNC Group identified by groupId. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: group_id, dncGroupRecords.
- **nice_c_xone_dnc_group_records_bulk_delete** — Expire Records from a DNC Group. This method will expire Records in a DNC Group identified by groupId. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: group_id, dncGroupRecords.
- **list_all_nice_c_xone_dnc_group_scrubbed_skills** — Returns Scrubbed Skills for a DNC Group. This method will return a list of all Skills that are configured to have the Do Not Call (DNC) group identified by groupId enforced. We refer to these as Scrubbed Skills. Required: group_id.
- **create_a_nice_c_xone_dnc_group_scrubbed_skill** — Assign a Scrubbed Skill. This method will assign a Skill specified by skillId as a scrubbed skill for a Do Not Call (DNC) Group. This means the Skill will not be allowed to dial records from the DNC Group. Required: group_id, skill_id.
- **delete_a_nice_c_xone_dnc_group_scrubbed_skill_by_id** — Remove a Scrubbed Skill. This method will remove a Skill specified by skillId as a scrubbed skill for a Do Not Call (DNC) Group. This means the Skill will no longer be restricted by this DNC Group. Required: id, group_id.
- **list_all_nice_c_xone_dnc_groups** — Returns list of DNC Groups. This method will return a list of all Do Not Call (DNC) groups. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier.
- **create_a_nice_c_xone_dnc_group** — Create a DNC Group. This method will create a new Do Not Call (DNC) Group to the Business Unit.These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: dncGroupName.
- **nice_c_xone_dnc_groups_search** — Search for a Phone Number. This method will search for the phone number provided in phoneNumber parameter in all DNC Groups. Required: phoneNumber.
- **get_single_nice_c_xone_dnc_group_by_id** — Returns a DNC Group. This method will return a Do Not Call (DNC) group. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: id.
- **update_a_nice_c_xone_dnc_group_by_id** — Update a DNC Group. This method will update a Do Not Call (DNC) Group. These groups replace the previous functionality of the DNC lists used in version 14.2 and earlier. Required: id.
- **list_all_nice_c_xone_dnis** — Get DNIS entries. This method will get DNIS entries
- **list_all_nice_c_xone_dr_tenant_config** — New in 26.3: Get DR configuration for a tenant. This method retrieves the DR configuration for a primary or secondary tenant. If a Primary Tenant ID is passed, the API returns the full configuration directly. Required: tenant_id.
- **create_a_nice_c_xone_dr_tenant_config** — New in 26.3: Create DR configuration for a tenant. This API is used to create a new Disaster Recovery configuration for a tenant when one does not already exist. Required: tenant_id, secondaryTenants, primaryTenantSchema.
- **nice_c_xone_dr_tenant_config_bulk_update** — New in 26.3: Update DR configuration for a tenant. This method updates the DR configuration for a tenant. Update operation is inferred by payload (server-side precedence):. multiRegionHA . drEnabled . entitySyncConfiguration . Required: tenant_id, ifMatchVersion, multiRegionHA.
- **create_a_nice_c_xone_enhancedcustomercard** — New in v33.0 A New proxy API endpoint within the monolith application that connects to the ECC Lambda. This method allows you to invoke ECC lambda which is responsible for invoking the LiveVox APIs.
- **list_all_nice_c_xone_feedback_categories_and_priorities** — Get all feedback categories and priorities. This method returns a list of all of the system assigned Feedback Categories and Priorities that can be used with the POST /agent-sessions/{sessionId}/submit-feedback method to allow an…
- **list_all_nice_c_xone_files** — Get a File. This method will return a file from the file server as identified by the fileName. The file is returned in a Base64 encoded format. Required: fileName.
- **create_a_nice_c_xone_file** — Uploads a File. This method will upload a file to the file server as identified by "fileName". The file is uploaded in a Base64 encoded format. The parameter "fileName" must contain the filename as well as the directory path. Required: fileName, file.
- **nice_c_xone_files_bulk_update** — Moves or Renames a File. This method will move a file on the file server as identified by "fileName" to a new location or rename the file in the existing location. Required: oldPath, newPath.
- **nice_c_xone_files_bulk_delete** — Deletes a File. This method will delete a file on the file server as identified by "fileName". The parameter "fileName" parameter must contain the filename as well as the directory path. Required: fileName.
- **list_all_nice_c_xone_files_external** — Returns a list of unprocessed files. This method returns a list of unprocessed files without a contactId.
- **create_a_nice_c_xone_files_external** — Marks a file to be processed. This method marks a file as “needs to be processed” Required: fileName, file.
- **nice_c_xone_files_external_bulk_update** — Marks a file as processed. This method marks a file as processed. Required: fileName, needsProcessing.
- **list_all_nice_c_xone_folders** — Returns a Directory Listing. This method will return the directory listing of a folder in the file server as identified by "folderName". Required: folderName.
- **nice_c_xone_folders_bulk_delete** — Deletes a Folder. This method will delete a folder on the file server as identified by "folderName". Required: folderName.
- **list_all_nice_c_xone_group_agents** — Returns a list of agents assigned to a group. This method returns a list of agents assigned to a group. Groups are an optional field set during agent configuration. Required: group_id.
- **create_a_nice_c_xone_group_agent** — Assigns Agents to a Group. This method assigns an array of Agents to a Group. NOTE: In CXone User Hub , this API is not applicable and should not be used to create any agents assigned to group records. Required: group_id.
- **nice_c_xone_group_agents_bulk_delete** — Removes agents from a group. This method removes agents from a group. NOTE: In CXone User Hub , this API is not applicable and should not be used to delete any agents assigned to group records. Required: group_id.
- **list_all_nice_c_xone_groups** — Get Groups. This method returns an array of groups with fields values for a business unit. NOTE: In CXone User Hub , this API is not applicable and should not be used to retrieve group records.
- **create_a_nice_c_xone_group** — Create Groups. This method creates a group and returns a groupId. NOTE: In CXone User Hub , this API is not applicable and should not be used to create group records. Required: groups.
- **get_single_nice_c_xone_group_by_id** — Returns a group config. This method returns the configuration for a group. NOTE: In CXone User Hub , this API is not applicable and should not be used to retrieve group records. Required: id.
- **update_a_nice_c_xone_group_by_id** — Updates a Group. This method modifies a group. NOTE: In CXone User Hub , this API is not applicable and should not be used to edit or update group records. Required: id, groupName.
- **list_all_nice_c_xone_hiring_sources** — Returns Hiring Sources. This method will return all Hiring Sources for your Business Unit. This can be used when creating Agents through the POST /agents method.
- **create_a_nice_c_xone_hiring_source** — Create a Hiring Source. This method will create a Hiring Source for your Business Unit. This can be used when creating Agents through the POST /agents method. Required: sourceName.
- **list_all_nice_c_xone_hours_of_operation** — Get the list of hours of operations paginated. This API gets the list of hours of operations paginated Required: isDeleted.
- **create_a_nice_c_xone_hours_of_operation** — Creates an hours of operation profile. This method will let you create an hours of operation profile. Only “profileName” is required to create a profile with no holidays and open 24/7. Required: profileName.
- **get_single_nice_c_xone_hours_of_operation_by_id** — Get an hour of operation detail by id. This API gets an hour of operation detail by id Required: id.
- **update_a_nice_c_xone_hours_of_operation_by_id** — Update the information of an Hour of operation. This API updates the information of an Hour of operation - application/json Required: id, hoursOfOperationProfileName, days, holidays.
- **delete_a_nice_c_xone_hours_of_operation_by_id** — Delete an hour of operation from the list. This API deletes hours of operations Required: id.
- **nice_c_xone_hours_of_operation_update_skills** — Updated in v33.0 Update an hour of operation skill list. This API udpates an hour of operation skill list Required: hours_of_operation_profile_id.
- **list_all_nice_c_xone_hours_of_operation_identities** — Get the list of hours of operations for identities. This API gets the list of hours of operation identities
- **create_a_nice_c_xone_interaction_work_item** — Create a new work item. Creates a work item and launches the Point of Contact script for the named point of contact. Required: pointOfContact.
- **create_a_nice_c_xone_interaction_work_items_persistent** — Queues up a new persistent work item.
- **nice_c_xone_interactions_signal** — Create a Signal for a Contact. This method can be used to send up to 9 custom data variables into a script environment. This call can be made outside of an Agent Session with only the contactId value needed. Required: contact_id.
- **create_a_nice_c_xone_knowledge_hub_document_snapshot** — New in 26.1 release - Get snapshot of ingested documents. Retrieves a snapshot view of successfully ingested documents in the Knowledge Base. Returns document metadata including filename, last ingestion timestamp, and status. Required: kh_id, dataSourceId.
- **create_a_nice_c_xone_knowledge_hub_document** — Process documents. This API is used to ingest document content and metadata into knowledgehub and datasource. Required: clientToken, dataSourceId, knowledgeHubId, documents.
- **list_all_nice_c_xone_locations** — Returns Locations. This method will return the list of Locations configured for your Business Unit. This can be used when creating Agents through the POST /agents method.
- **create_a_nice_c_xone_media_download_contact** — New in 26.3: Create bulk download request for CONTACT media files. Submit an asynchronous request to download media files (voice or screen) for one or more contacts. Required: media-type, entityIds.
- **create_a_nice_c_xone_media_download_segment** — New in 26.3: Create bulk download request for SEGMENT media files. Submit an asynchronous request to download media files (voice or screen) for one or more segments. Required: media-type, entityIds.
- **get_single_nice_c_xone_media_download_status_by_id** — New in 26.3: Get download request status. Retrieve the current processing status of a previously submitted bulk download request. When the status is COMPLETED, the downloadLocation field contains the URL to the media archive. Required: id.
- **get_media_playback_acd_contact_statement_by_id** — Access a recording statement based on ACD Contact ID and Statement ID. Access a recording statement based on ACD Contact ID and and Statement ID. Required: id, acd_contact_id.
- **list_all_nice_c_xone_media_playback_contacts** — Access the full contact (the entire interaction with all segments) based on ACD Contact ID. Access the full contact (the entire interaction with all segments) based on the ACD Contact ID. Required: acd-call-id.
- **get_single_nice_c_xone_media_playback_segment_by_id** — Access a single segment independent of the contact (voice-only, voice-and-screen, chat, or email). Access a recording segment using the Segment ID, independent of the associated contact ID. Required: id.
- **list_all_nice_c_xone_media_types** — Returns a list of media types. This method will return a list of all of the media types available. These values will be integers that can be used in the /media-types/{mediaTypeId} API to return the names of the media types as well.
- **get_single_nice_c_xone_media_type_by_id** — Returns a single media type. Useful for mapping media type ID's that are returned in other API calls to textual, human-friendly descriptions, for display in reports or on dashboards. Required: id.
- **list_all_nice_c_xone_message_templates** — Gets all Message Templates. This method will return all Message Templates for use with agentless SMS or Email using Personal Connection.
- **create_a_nice_c_xone_message_template** — Creates a Message Template. This method will return all Message Templates for use with agentless SMS or Email using Personal Connection. Required: templateName, templateTypeId, subject, body.
- **get_single_nice_c_xone_message_template_by_id** — Returns a Message Template. This method will return the Message Template indicated by "templateId" for use with agentless SMS or Email using Personal Connection. Required: id.
- **update_a_nice_c_xone_message_template_by_id** — Updates a Message Template. This method will update a Message Template indicated by "templateId" for use with agentless SMS or Email using Personal Connection. Required: id.
- **list_all_nice_c_xone_permissions** — Returns a list of permissions. This method returns a list of all available permissions.
- **get_single_nice_c_xone_permission_by_id** — Returns a list of permissions for an agent. This method returns a list of all permissions assigned to the agent specified by agentId. Required: id.
- **update_a_nice_c_xone_persistent_contact_by_id** — Update Persistent Contact. This method is used to update a persistent contact that is in queue. NOTE: Persistent contacts are limited to 10 per second. Required: id, persistentContact.
- **list_all_nice_c_xone_phone_codes** — Returns SMS Phone Codes. This method will return the list of SMS Phone Codes configured for your Business Unit.
- **list_all_nice_c_xone_phone_numbers** — Returns a list of configurable phone number. This method returns a list of phone number available to configure as points of contact. GET /points-of-contact will return the list of already points of contact including phone numbers.
- **list_all_nice_c_xone_points_of_contact** — Returns a list of points of contact. A point of contact is essentially an "address" where patrons can request an interaction with an agent.
- **create_a_nice_c_xone_points_of_contact** — Creates a point of contact. This method will create a point of contact for any media type. Depending on the media type requested different parameters will be required. Required: pointOfContact, pointOfContactName, skillId, scriptName.
- **get_single_nice_c_xone_points_of_contact_by_id** — Returns a single point of contact. A point of contact is essentially an "address" where patrons can request an interaction with an agent. Required: id.
- **update_a_nice_c_xone_points_of_contact_by_id** — Updates a point of contact. This method will update a point of contact for any media type. Depending on the media type requested different parameters will be required. Required: id, pointOfContactName, skillId, scriptName.
- **list_all_nice_c_xone_points_of_contact_chat_profile** — Return Chat Profile config. This method returns the configuration for a chat profile. Required: points_of_contact_id.
- **nice_c_xone_privacy_erase** — Create GDPR Erasure Request. This api creates an erasure request and returns created request with requestId Required: subjectIdentifier, subjectIdentifierType.
- **create_a_nice_c_xone_promise** — Schedule a callback. This method allows you to schedule a call back for a future time. Required: firstName, lastName, phoneNumber, skill, promiseDate, promiseTime.
- **create_a_nice_c_xone_queuecallback** — Request an immediate callback. This method allows you to request that a callback be made "immediately" (i.e. as soon as an agent is available to call back). Required: phoneNumber, skill.
- **nice_c_xone_recording_interactions_update_business_data** — Allow Business data update during ongoing interaction. The API allows an agent/application to update business data during a call in progress for a specific user. Required: userId.
- **nice_c_xone_recording_interactions_do_not_record** — Disable the option to record the call. The API allows to disable the option to record voice and screen of a call in case the customer declices conset and does not agree to be recorded. Required: userId.
- **nice_c_xone_recording_interactions_get_recording_status** — Get recording status. The API allows to get the voice recording status of an agent live call. Required: userId.
- **nice_c_xone_recording_interactions_mask** — Mask voice and screen recording for privacy compliance. Stop voice and screen recording of a call in which the agent associated with the specified user ID is participating. Required: userId.
- **nice_c_xone_recording_interactions_start_recording_on_demand** — Start recording on demand. The API allows an agent/application to start recording a call in progress for a specific user. Required: userId.
- **recording_interactions_start_screen_interaction_recording** — Start screen interaction recording. The API enables to initiate screen recording for a specific user that is not on an active call. You must specify the recording duration by providing it as a parameter in the start command. Required: userId, recordingDuration.
- **nice_c_xone_recording_interactions_stop_recording_on_demand** — Stop recording on demand. The API allows to stop recording of voice and screen of a call in progress for a specific user. Required: userId.
- **recording_interactions_stop_screen_interaction_recording** — Stop screen interaction recording. The API enables to stop the screen recording for contact ID of a specific user that was started using start-screen-interaction-recording command. Required: userId, contactId.
- **nice_c_xone_recording_interactions_unmask** — Unmask voice and screen recording for privacy compliance. Resume voice and screen recording of a call in which the agent associated with the specified user ID is participating. Required: userId.
- **create_a_nice_c_xone_report_job_datadownload** — Generates a link to a datadownload report. This method will allow you to generate a datadownload report as a either a base 64 encoded string or a file in central. Required: report_id, startDate, endDate.
- **list_all_nice_c_xone_report_jobs** — Returns a list of Reporting Jobs. This method will allow you to retrieve a list of Custom Reporting Jobs made up of jobs that have already completed and those that are currently running.
- **get_single_nice_c_xone_report_job_by_id** — Returns a Reporting Job. This method will allow you to retrieve information about a Custom Reporting Job. The information for completed jobs will include a URL that can be used to retrieve the results of the completed report job. Required: id.
- **create_a_nice_c_xone_report_job** — Start a Custom Reporting Job. This method will allow you to start a report job for a Custom Reporting Template identified by reportId. Required: report_id.
- **list_all_nice_c_xone_reports** — Returns a list of Custom Reports. This method will allow you to get a list of all reports listed under Custom Reporting in Central for your Business Unit.
- **list_all_nice_c_xone_routing_attribute_agents** — Retrieves a Routing Attribute's assigned Agents. Required: routing_attribute_no, maximumRows, startRowIndex, orderAsc, searchText, assigned, status.
- **list_all_nice_c_xone_routing_attributes** — Retrieves a list of Routing Attributes. Retrieves a list of Routing Attributes associated with the User's BusinessUnit Required: status, maximumRows, startRowIndex, orderColumn, orderAsc.
- **get_single_nice_c_xone_routing_attribute_by_id** — Retrieves a Routing Attribute. Retrieves a Routing Attribute based on Routing Attribute ID Required: id.
- **update_a_nice_c_xone_routing_attribute_by_id** — Updates or Adds a Routing Attribute. Updates or Adds a Routing Attribute based on Routing Attribute ID. Required: id.
- **create_a_nice_c_xone_scheduled_callback** — Updated in v33.0 Creates a Scheduled Callback. This method allows you to create a Scheduled Callback request for either an Outbound Skill identified by skillId or an Agent identified by targetAgentId.
- **update_a_nice_c_xone_scheduled_callback_by_id** — Updated in v33.0 Updates a Scheduled Callback. This method allows you to update an exisiting Scheduled Callback identified by callbackId. These Callbacks are also referred to as Promise Keepers or Promises. Required: id.
- **delete_a_nice_c_xone_scheduled_callback_by_id** — Deletes a Scheduled Callback. This method allows you to delete an exisiting Scheduled Callback identified by callbackId. These Callbacks are also referred to as Promise Keepers or Promises. Required: id.
- **nice_c_xone_schedules_export** — Get agent’s schedules from CXone WFM. Retrieves the agent's schedule and accompanying activity information from CXone WFM. Provide the start and end dates in ISO-8601 format (YYYY-MM-DD) along with the agent’s user ID. Required: startDate, endDate, userID.
- **list_all_nice_c_xone_scim_schemas** — Schema for User Entity. This API is used to get Schema for user Entity
- **list_all_nice_c_xone_scim_users** — API to search user based on user name. This API will be used by SCIM Clients(like OKTA) to check if user with given user name exists in User Hub Required: filter.
- **create_a_nice_c_xone_scim_user** — API Create SCIM User. This API will be used to create a SCIM User in User Hub Required: userName, name, emails.
- **get_single_nice_c_xone_scim_user_by_id** — API to get SCIM User By ID. This API will be used to get SCIM User by ID Required: id.
- **update_a_nice_c_xone_scim_user_by_id** — API Update SCIM User. This API will be used to update a SCIM User in User Hub Required: id, userName, name, emails, active.
- **nice_c_xone_scim_users_partial_update** — API for Partial Updates SCIM User. This API will be used to update a SCIM User in User Hub Required: user_id, schemas, Operations.
- **list_all_nice_c_xone_script_files** — Get file configuration info and content. This method gets the configuration info of a File and the content. Required: fileFullName.
- **create_a_nice_c_xone_script_file** — Save file in file server. This method will save a new file on the file server, if the file already exists it will be overwritten. Required: fileFullName, fileContent.
- **nice_c_xone_script_files_bulk_update** — Update File configuration. This method modifies the configuration of an existing file.
- **nice_c_xone_script_files_bulk_delete** — Delete a File from the file server. This method delete a file from the file server. Required: fileFullName.
- **nice_c_xone_script_files_search** — Return a list of Files and Folders from the file server. This method returns a list structure of Files and Folders from FileServer. Required: rootFolder.
- **list_all_nice_c_xone_script_folders** — Get the list of folders and scripts. This method list folders and scripts with the given criteria within a business unit.
- **list_all_nice_c_xone_script_history_by_name** — Return a history of a script. This method will returns a history of a script by name. Required: scriptPath.
- **list_all_nice_c_xone_script_schedule_audit_history** — Returns a list of audit entries for script schedules. This API returns a list of audit entries for script schedules Required: script_schedule_id, searchString.
- **list_all_nice_c_xone_script_schedule_scripts** — Returns a list of Scripts to assign to the Script Scheduler. This API returns a list of scripts to assign to the Script Required: searchString.
- **list_all_nice_c_xone_script_schedule_skills** — Returns a list of Skills to assign to the Script Scheduler. This API returns a list of Skills to assing to the Script Schedule Required: searchString.
- **list_all_nice_c_xone_script_schedules** — Returns a list of paginated Script Schedules. This API returns a list of paginated Script Schedules Required: searchString.
- **get_single_nice_c_xone_script_schedule_by_id** — Get Unavailable Code Details By Id. This API returns code details sorted by Id Required: id.
- **list_all_nice_c_xone_scripts** — Open a JSON script. This method will return the script in JSON format from the database. API returns just single script. NOTE: Any one of the input parameter is required.
- **create_a_nice_c_xone_script** — Save a JSON script. This method will save a new Script in JSON format into the data base, if the Script already exists it will be overwritten
- **nice_c_xone_scripts_bulk_update** — Update an existing script. This method will update the state of a Script only to Lock or Unlock. Required: scriptPath, lockScript.
- **nice_c_xone_scripts_bulk_delete** — Deletes script. Delete script by scriptPath. Required: scriptPath.
- **nice_c_xone_scripts_kick** — Kick a locked script. This method will force the unlock of a script. Required: scriptPath.
- **nice_c_xone_scripts_search** — Search Script. This method searches for a script by name within a business unit.
- **nice_c_xone_scripts_start** — Starts a Script. This method will start a script that is identified by scriptId. Currently this only supports channel related scripts such as Email, Phone, Chat etc. You cannot start Generic or API scripts using this method. Required: skillId, scriptId, scriptPath.
- **get_single_nice_c_xone_script_by_id** — Returns a Script. This method will get the Script requested by ScriptId or ScriptName. Required: id.
- **list_all_nice_c_xone_security_profiles** — Return all or selected security profiles. This API will return all or selected security profiles
- **get_single_nice_c_xone_security_profile_by_id** — Returns a Security Profile. This method will return the a Security Profile indicated by "profileId" including all of the Agents currently assigned to this profile and information on the password complexity for this profile. Required: id.
- **list_all_nice_c_xone_server_time** — Returns the server time in ISO 8601. This is an important operation, as all times specified in events and other API return data are relative to the server's clock, which may differ significantly from the agent's local machine…
- **list_all_nice_c_xone_skill_activity** — Returns activity for all Skills. This method returns activity information for all Skills. This is some of the same data that was returned by the /skills/summary API in previous versions.
- **nice_c_xone_skill_activity_search** — Search current activity levels for skills or campaign. This API returns activity information for Skills based on input as a search criterion which can accept combination of Skill Ids and Campaign Ids
- **list_all_nice_c_xone_skill_activity_by_skill** — Returns activity for a Skill. This method returns activity information on the Skill identified by "skillId". This is some of the same data that was returned by the /skills/summary API in previous versions. Required: skill_id.
- **list_all_nice_c_xone_skill_address_books** — Returns Address Books for a Skill. This method returns a list of Address Books currently assigned to the Skill as identified by "skillId". Required: skill_id.
- **list_all_nice_c_xone_skill_agents** — Returns Skills assignments. This method will return the Skill assignment mappings for an array of skills. If no value is provided in the "updatedSince" parameter, then all active Skill Assignment mappings will be returned. Required: skills.
- **nice_c_xone_skill_agents_search** — Get Agents that are assigned to Multiple Skills. This method allows you to get all the agent details for all the specified skill IDs.
- **create_a_nice_c_xone_skill_agent** — Assign Agents to a Skill. This method will assign the list of Agents in the "agents" parameter, to a Skill identfied by "skillId". Required: skill_id, agents.
- **nice_c_xone_skill_agents_bulk_update** — Update Skill Agent assignments. This method will modify the Agent assignments for a Skill identfied by "skillId". Required: skill_id, agents.
- **nice_c_xone_skill_agents_bulk_delete** — Remove Skill Agent assignments. This method will remove the assignments for the list of Agents in the "agents" parameter for a Skill identfied by "skillId". Required: skill_id.
- **delete_a_nice_c_xone_skill_agent_by_id** — Delete skills based on skillid and agentid. This method delete skills based on skillid and agentid. Required: id, skill_id.
- **list_all_nice_c_xone_skill_agents_by_skill** — Returns Agents assigned to a Skill. This method will return the list of Agents, both active and inactive, who have a Skill assignment for the Skill identfied by "skillId". Required: skill_id.
- **list_all_nice_c_xone_skill_agents_unassigned** — Get Agents that are not assigned to Skill. Required: skill_id.
- **list_all_nice_c_xone_skill_call_data** — Returns contacts summary for all skills. This method will return summary information about the contacts handled for each Skill in a business unit over the period of time specified by "startDate" and "endDate".
- **list_all_nice_c_xone_skill_call_data_by_skill** — Returns contacts summary for a single skill. This method will return summary information about the contacts handled for a Skill identified by "skillId" over the period of time specified by "startDate" and "endDate". Required: skill_id.
- **list_all_nice_c_xone_skill_dispositions** — Returns a Skill Dispositions. This method returns all available dispositions for the Skill provided by skillId. Required: skill_id.
- **list_all_nice_c_xone_skill_dispositions_unassigned** — Returns unassigned dispositions for a Skill. Required: skill_id.
- **nice_c_xone_skill_parameter_cadence_settings_bulk_update** — Update Skill Cadence Settings. Updates the cadence setting for an outbound dialer skill. Required: skill_id.
- **list_all_nice_c_xone_skill_parameter_cpa_management** — Returns CPA Management configuration for a skill. This method will return the CPA Management settings for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_cpa_management_bulk_update** — Updates CPA Management configuration for a skill. This method modifies the CPA Management settings for a skill. This method is for Personal Connection skills only. Required: skill_id, cpaSettings.
- **list_all_nice_c_xone_skill_parameter_delivery_preferences** — Returns the Delivery Preferences configuration for a skill. This method will return the Delivery Preferences for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_delivery_preferences_bulk_update** — Updates Delivery Preferences configuration for a skill. This method modifies the Delivery Preferences for a skill. This method is for Personal Connection skills only. Required: skill_id, deliveryPreferences.
- **list_all_nice_c_xone_skill_parameter_general_settings** — Returns the General settings for a skill. This method will return the General-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_general_settings_bulk_update** — Updates the General settings for a skill. This method modifies the General-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id, generalSettings.
- **nice_c_xone_skill_parameter_list_management_bulk_update** — Update Skill List Management Settings. Updates list management parameters for an outbound dialer skill like display fields, list ordering, Order type, and direction. Required: skill_id.
- **list_all_nice_c_xone_skill_parameter_retry_settings** — Returns Retry settings for a skill. This method will return the Retry-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_retry_settings_bulk_update** — Updates Retry settings for a skill. This method modifies the Retry-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id, retrySettings.
- **list_all_nice_c_xone_skill_parameter_schedule_settings** — Returns the Schedule settings for a skill. This method will return the Schedule-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_schedule_settings_bulk_update** — Updates Schedule settings for a skill. This method modifies the Schedule-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id, scheduleSettings.
- **list_all_nice_c_xone_skill_parameter_time_zones** — List of the timezone boundings for the given skill. This method returns a list of the timezone boundings for a skill Required: skill_id.
- **nice_c_xone_skill_parameter_time_zones_bulk_update** — Updates the timezone boundings for the given skill. This method updates the timezone boundings information for the given skill. All timezone boundings to be made active must be given in a request. Required: skill_id.
- **list_all_nice_c_xone_skill_parameter_xs_settings** — Returns the XS configuration for a skill. This method will return the XS-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id.
- **nice_c_xone_skill_parameter_xs_settings_bulk_update** — Updates XS settings for a skill. This method modifies the XS-Settings for a skill. This method is for Personal Connection skills only. Required: skill_id, xsSettings.
- **list_all_nice_c_xone_skill_parameters** — Get skills settings list. Gets all outbound skill parameters for all outbound dialer skills. (General, Cadence, Delivery, list management, etc.)
- **list_all_nice_c_xone_skill_parameters_by_skill** — Get skill settings. Gets all skill parameters for a specific outbound dialer skill. (General, Cadence, Delivery, list management, etc.) Required: skill_id.
- **list_all_nice_c_xone_skill_scheduled_callbacks** — Returns Scheduled Callbacks for a Skill. This method allows you to request any waiting Scheduled Callback requests for the Skill identified by skillId in order to display them in your application. Required: skill_id.
- **list_all_nice_c_xone_skill_sla_summary** — Returns SLA summary for all Skills. This method will return summary information on the SLA compliance of contacts for all Skills that were created during the time specified between "startDate" and "endDate". Required: startDate, endDate.
- **list_all_nice_c_xone_skill_sla_summary_by_skill** — Returns single SLA summary for specified skill. This method will return summary information on the SLA compliance of contacts for the Skill specified by "skillId" that were created during the time specified between "startDate" and… Required: skill_id, startDate, endDate.
- **list_all_nice_c_xone_skill_summary** — Returns statistics for all Skills. This method returns both real time and reporting summary data for every Skill in the business unit. Required: startDate, endDate.
- **list_all_nice_c_xone_skill_summary_by_skill** — Returns statistics for a Skill. This method returns both real time and reporting summary data for a Skill. Required: skill_id, startDate, endDate.
- **list_all_nice_c_xone_skill_tags** — Returns Tags for a Skill. This method returns all Tags assigned to the Skill identified by "skillId". Required: skill_id.
- **create_a_nice_c_xone_skill_tag** — Assigns a Tag to a Skill. This method assigns Tags to the Skill identified by "skillId". Required: skill_id, tags.
- **nice_c_xone_skill_tags_bulk_delete** — Removes Tags from a Skill. This method removes Tags from the Skill identified by "skillId". Required: skill_id.
- **list_all_nice_c_xone_skill_thank_you_page** — Returns config for thank you page. This method returns the configuration for the chat thank you page. Required: skill_id.
- **list_all_nice_c_xone_skills** — Get Skills. This method returns a complete list of Skills configured in the business unit. "mediaTypeId" is required filter parameter. Email = 1, Chat = 3, Phone = 4, Voice Mail = 5, Work Item = 6, Social = 8, Digital = 9.
- **create_a_nice_c_xone_skill** — Creates a Skill. This method creates a Skill, added 'Require Manual Agent Accept' feature. Required Permissions : Skills Create.
- **get_single_nice_c_xone_skill_by_id** — Get Skill details. This method returns details for the Skill identified by skillId. Required: id.
- **update_a_nice_c_xone_skill_by_id** — Updates a Skill. This method updates a Skill, added 'Require Manual Agent Accept' feature. The divisionNo cannot be modified. Required: id, skill.
- **nice_c_xone_skills_start** — Start a Personal Connection Skill. This method will allow you to start a Personal Connection Skill identified by skillId. Required: skill_id.
- **nice_c_xone_skills_stop** — Stop a Personal Connection Skill. This method will allow you to stop a Personal Connection Skill identified by skillId. Required: skill_id.
- **list_all_nice_c_xone_station_audit_history** — Get station audit history paginated. This API gets the station audit history Required: station_id.
- **list_all_nice_c_xone_station_login_history** — Get station login history paginated. This API get the station login history Required: station_id.
- **list_all_nice_c_xone_station_profile_audit_history** — Returns a list of audit entries for a Station Profile. This API allows to get a list of audit entries for a Station Profile Required: station_profile_id, searchString.
- **list_all_nice_c_xone_station_profiles** — Returns a list of paginated Station Profiles. This API Returns a list of paginated Station Profiles
- **create_a_nice_c_xone_station_profile** — Creates a Station Profile. This API allows to create a new Station Profile
- **get_single_nice_c_xone_station_profile_by_id** — Get Station Profile Details By Id. This API allows to get a Station Profile by its ID Required: id.
- **update_a_nice_c_xone_station_profile_by_id** — Updates an existing Station Profile. This API allows to update an existing Station Profile by ID Required: id.
- **delete_a_nice_c_xone_station_profile_by_id** — Delete a Station Profile. This API allows you to Delete a Station Profile by ID Required: id.
- **list_all_nice_c_xone_stations** — Get the list of stations paginated. This API gets the list of stations paginated
- **create_a_nice_c_xone_station** — Create an station. This API creates a new station Required: stationName, phoneNumber, callerId, stationProfileId, isActive.
- **get_single_nice_c_xone_station_by_id** — Get an station detail by id. This API gets an station detail by id Required: id.
- **update_a_nice_c_xone_station_by_id** — Update an station. This API updates an station Required: id, stationName, phoneNumber, callerId, stationProfileId, isActive.
- **nice_c_xone_stations_update_status** — Update an station status. This API updates an station status Required: station_id, isActive.
- **list_all_nice_c_xone_suppressed_contact** — List of suppressed contacts. This method returns a list of suppressed contact information for the business unit.
- **create_a_nice_c_xone_suppressed_contact** — Create a suppressed contact. This method creates a suppressed contact. Required: suppressedContactData.
- **get_single_nice_c_xone_suppressed_contact_by_id** — Returns a suppressed contact by ID. This method returns a suppressed contact by contact ID. Required: id.
- **update_a_nice_c_xone_suppressed_contact_by_id** — Updates a suppressed contact by ID. This method updates a suppressed contact by contact ID. Required: id, suppressedContactData.
- **delete_a_nice_c_xone_suppressed_contact_by_id** — Deletes a suppressed contact by ID. This method deletes a suppressed contact by contact ID. Required: id.
- **nice_c_xone_survey_data_feedback_search** — New in 26.3: Open search for feedback export. API Purpose Use this API to retrieve survey feedback records for archival in data warehouses, or for generating analytics and insights. Required: limit.
- **nice_c_xone_survey_data_feedback_export_initiate** — New in 26.3: Initiate feedback export. API Purpose Use this API to initiate a full export request for survey responses older than 1 month, with support for exporting data across up to 5 years (1 year per request).
- **get_single_nice_c_xone_survey_data_feedback_export_status_by_id** — New in 26.3: Check feedback export status. API Purpose Use this API to check the real-time status of a feedback export request that was previously initiated using the Initiate Feedback Export API. Required: id.
- **nice_c_xone_survey_data_invitation_search** — New in 26.3: Open search for survey invitation. API Purpose Use this API to retrieve survey invitation records for archival in data warehouses, or for generating analytics and insights. Required: limit.
- **nice_c_xone_survey_data_invitation_export_initiate** — New in 26.3: Initiate invitation export. API Purpose Use this API to initiate a full export request for survey invitation older than 1 month, with support for exporting data across up to 5 years (1 year per request).
- **get_survey_data_invitation_export_status_by_id** — New in 26.3: Check invitation export status. API Purpose Use this API to check the real-time status of a invitation export request that was previously initiated using the Initiate Invitation Export API. Required: id.
- **list_all_nice_c_xone_tags** — Returns a list of Tags. This method will return the details of all Tags in the Business Unit.
- **create_a_nice_c_xone_tag** — Creates a Tag. This method will create a new Tag in the Business Unit. Required: tagName.
- **get_single_nice_c_xone_tag_by_id** — Returns a Tag. This method will return the details of a Tag identified by "tagId". Required: id.
- **update_a_nice_c_xone_tag_by_id** — Updates a Tag. This method will update the details of a Tag identified by "tagId". Required: id.
- **list_all_nice_c_xone_team_address_books** — Returns Address Books for a Team. This method returns a list of Address Books currently assigned to the Team as identified by teamId. Required: team_id.
- **list_all_nice_c_xone_team_agents** — Updated in v34.0 Get list of teams and their agents. Returns a list of teams and their agents.
- **create_a_nice_c_xone_team_agent** — Updated in v34.0 Assign Agents to a Team. This method assigns the Agents in the agents parameter to the Team identified by teamId. Required: team_id, agents.
- **nice_c_xone_team_agents_bulk_delete** — Updated in v34.0 Remove Agents from a Team. This method deletes the Agents in the agents parameter from the Team identified by teamId. NOTE: This method should not be used to remove an assigned user from a team in UserHub. Required: team_id, transferTeamId, agents.
- **list_all_nice_c_xone_team_agents_by_team** — Updated in v34.0 Get list of teams and their agents. This method returns the full list of Teams including the Agents on each of the Teams. Required: team_id.
- **list_all_nice_c_xone_team_performance_total** — Returns performance summary of all Teams. This method returns a Team summary for all Teams in the business unit over the time frame between "startDate" and "endDate". NOTE : The times need to be in 15 minute increments. Required: startDate, endDate.
- **list_all_nice_c_xone_team_performance_total_by_team** — Returns performance summary of a Team. This method returns a summary for the Team identified by teamId over the time frame between "startDate" and "endDate". The date fields require quarter hour time stamps. Required: team_id, startDate, endDate.
- **list_all_nice_c_xone_team_unavailable_codes** — Updated in v34.0 Gets all outstates that are valid for a team. This method returns the unavailable codes that are available for a Team identified by teamId. Required: team_id.
- **create_a_nice_c_xone_team_unavailable_code** — Updated in v34.0 Assign an Unavailable Code to a Team. This method assigns unavailable codes to a Team identified by teamId. Required: team_id, codes.
- **nice_c_xone_team_unavailable_codes_bulk_update** — Updated in v34.0 Updates an Unavailable Code for a Team. This method modifies unavailable codes of a specific team identified by teamId. Required: team_id, unavailableCodes.
- **nice_c_xone_team_unavailable_codes_bulk_delete** — Updated in v34.0 Remove an Unavailable Code from a Team. This method removes unavailable codes from a Team identified by teamId. Required: team_id, codes.
- **list_all_nice_c_xone_teams** — Updated in v34.0 Returns list of Teams. This method returns a list of details for all teams in the business unit. Version 34 added as list unavailableCodes in list detail of team and division no.
- **create_a_nice_c_xone_team** — Updated in v34.0 This method will create a new Team in the business unit. This method will create a new Team in the business unit. Version 34 added one parameter 'DivisionNo'. Required: teams.
- **get_single_nice_c_xone_team_by_id** — Updated in v34.0 Get Team by TeamId. This method returns a list of details for the Team specified by "teamId" and includes an array of elements containing information about the Agents assigned to that Team. Required: id.
- **update_a_nice_c_xone_team_by_id** — Updated in v34.0 This method updates the Team specified by teamId. This method updates the Team specified by teamId. Version 34 added one parameter divisionNo. Required: id, team.
- **nice_c_xone_timeoff_manager_allotments_import** — Import Users Allotment by Activity Code. Update the agent's allotment into CXone WFM. Provide the activity code name, user id along with allotment and unit of allotment (Day/Hour). Required: activityCodeName, allotmentType, allotmentByUserName.
- **get_single_nice_c_xone_timeoff_manager_summary_by_id** — Get Time Off Summary by Activity Code Name. Retrieves the summary by activity code name from CXone WFM. Provide the activity code name. This API will return user summary. In case of any error, the API will return an error message. Required: id.
- **list_all_nice_c_xone_timezones** — Returns possible Timezones. This method will return a list of possible timezones that can be used to interact with the API methods. These values are derived from the Windows TimeZoneInfo.GetSystemTimeZones call.
- **list_all_nice_c_xone_unavailable_code_audit_history** — Returns a list of audit entries for an unavailable code. This API allows to get a list of audit entries for an unavailable code Required: unavailable_code_id, searchString.
- **list_all_nice_c_xone_unavailable_code_teams** — Returns a list of assigned teams to an unavailable code. Returns a list of assigned teams to an unavailable code by ID Required: unavailable_code_id.
- **create_a_nice_c_xone_unavailable_code_team** — Assign teams unassigned to an unavailable code. This API allows to assign teams unassigned to an unavailable code Required: unavailable_code_id, addAll, teams.
- **nice_c_xone_unavailable_code_teams_bulk_update** — Assign Unavailable Code to Teams. This method will assign an array of teams to an unavailable code. “unavailableCodeId” may also be referenced as “outStateId” as in the response from GET /unavailable-codes. Required: unavailable_code_id, teams.
- **nice_c_xone_unavailable_code_teams_bulk_delete** — Unassign teams assigned to an unavailable code. This API allows to unassign teams assigned to an unavailable code Required: unavailable_code_id, removeAll, teams.
- **list_all_nice_c_xone_unavailable_code_teams_unassigned** — Returns a list of unassigned teams to an unavailable code. Returns a list of unassigned teams to an unavailable code by ID Required: unavailable_code_id.
- **list_all_nice_c_xone_unavailable_codes** — This API Returns a list of paginated Unavailable Codes. Returns a paginated list of unavailable codes with support for filters and limits, ensuring efficient handling of large datasets.
- **create_a_nice_c_xone_unavailable_code** — Creates an Unavailable Code. This API allows to create a new Unavailable Code Required: name.
- **get_single_nice_c_xone_unavailable_code_by_id** — Get Unavailable Code Details By Id. Required: id.
- **update_a_nice_c_xone_unavailable_code_by_id** — Updates an existing Unavailable Code record. This API allows to update an existing Unavailable Code by ID Required: id, name.
- **nice_c_xone_unavailable_codes_update_status** — Change status of existing Unavailable Code By Id. Change status of Unavailable Code By Id Required: unavailable_code_id, isActive.
- **list_all_nice_c_xone_user_identities** — API search user identities by filter. This API is used to search paginated user identities by filter, default and mandatory filter is user should be active
- **list_all_nice_c_xone_user_identities_by_user** — API get basic identity of the user. This API is used to fetch basic identity of the user based on userId Required: user_id.
- **list_all_nice_c_xone_userhub_access_keys** — Returns a list of access keys. This method will return a list of access keys. Permissions on the user’s role will affect the response. Paging parameters top, skip, orderby, fields can be used to filter the request.
- **create_a_nice_c_xone_userhub_access_key** — Create an access key for a user. This method will create an access key. Note: This request uses “https://na1.nice-incontact.com” as its base URI.
- **nice_c_xone_userhub_access_keys_bulk_update** — Updates an access key for a user. This method will update an access key.Update will only allow an access key “isActive” flag to be set. Note: This request uses “https://na1.nice-incontact.com” as its base URI. Required: accessKeyId.
- **get_single_nice_c_xone_userhub_access_key_by_id** — Returns an access key config. This method will return an access key configuration. Note: This request uses “https://na1.nice-incontact.com” as its base URI. Required: id.
- **delete_a_nice_c_xone_userhub_access_key_by_id** — Deletes an access key. This method will delete an access key. Once deleted it can’t be used again. Note: This request uses “https://na1.nice-incontact.com” as its base URI. Required: id.
- **create_a_nice_c_xone_userhub_team** — Create a new team. This api creates a new team and returns created team with teamId. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: name, status.
- **nice_c_xone_userhub_teams_bulk_update** — Update Team details. This API updates the existing team and returns updated team. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: id, name, status.
- **nice_c_xone_userhub_teams_search** — Returns a list of teams per given filter and metrices. This API takes input as a search criteria which can accept any combination of given attributes as a filter and can return only expected fields.
- **get_single_nice_c_xone_userhub_team_by_id** — Get team details by team Id. This API returns team details for given teamId. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: id.
- **list_all_nice_c_xone_userinfo** — Get basic information about an authenticated user. Provide the OpenID Connect standard UserInfo endpoint.
- **list_all_nice_c_xone_users** — Get list of all users for a tenant. This API is used to get list of users under a tenant based on filters includeDeleted, withAndWithoutEmail, includeDeletedAfter, fullNameContains, onlyImpersonated, excludeImpersonated. NOTE: .
- **create_a_nice_c_xone_user** — Create user under tenant. This API is used to create user under a tenant. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: firstName, lastName, emailAddress, role.
- **nice_c_xone_users_bulk_update** — API to update user details. This API is used to update user details. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: firstName, lastName, emailAddress, assignedGroup, role, userName, emailToBeVerified, id.
- **nice_c_xone_users_deactivate** — Deactivates a user. This API deactivates the user whose ids are given as input . NOTE: . 1.It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: userIds.
- **nice_c_xone_users_invite_by_email** — Invite user By Email. This API is used to send invitation on user email address. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: emailAddressesList, senderEmail.
- **nice_c_xone_users_invite_by_id** — Invite user By User ID. This API is used to send invitation to user based on user ID. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: inviteUserIds, senderUserId.
- **nice_c_xone_users_search** — Get user details as per given filters and fields. This API takes input as a search criterion with a new operation â€˜ORâ€™ that can accept any combination of given attributes as a filter supported with the V1 version and can…
- **nice_c_xone_users_update_login_authenticator** — Assign LA to user. This API is to assign a login-authenticator to a given user Required: user_id.
- **nice_c_xone_users_revive** — Revive a user. This API revives a users for given userId. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: user_id.
- **get_single_nice_c_xone_user_by_id** — API to get user details by user Id. This API is used to get user details by user Id. NOTE: It is recommended that user-manager APIs should not be called in parallel to avoid throttling. Required: id.
- **nice_c_xone_voice_biometric_perform_action** — New in 26.3: Perform Voice Biometric Action. Initiates a voice biometric action such as authentication, enrollment, or opt-out. This endpoint handles various voice biometric operations based on the RequestType parameter. Required: contactId, PersonId, RequestType.
- **list_all_nice_c_xone_voice_biometric_health_check** — Health Check. New in 26.3: Simple health check endpoint to verify the API is operational. Returns the current status and timestamp. This endpoint does not require authentication and can be used for:. - Load balancer health checks.
- **list_all_nice_c_xone_voice_biometric_print_status** — Get Voice Biometric Print Status. New in 26.3: Retrieves the current enrollment status of a user's voice biometric profile. Required: contactId, PersonId.
- **list_all_nice_c_xone_voice_biometric_result** — New in 26.3: Long Poll Voice Biometric Result. Long-polling endpoint to retrieve the result of a voice biometric operation. This endpoint holds the connection open for up to 30 seconds waiting for results. Behavior: . Required: PersonId.
- **list_all_nice_c_xone_wfm_data_agent_schedule_adherence** — Returns adherence statistics. This method will return the schedule adherence statistics generated by the WFM Data Collector for a specific date range bounded by the "startDate" and "endDate" parameters.The maximum range for this… Required: startDate, endDate.
- **list_all_nice_c_xone_wfm_data_agent_scorecards** — Returns scorecard statistics. This method will return the daily scorecard statistics generated by the WFM Data Collector for a specific date range bounded by the "startDate" and "endDate" parameters. Required: startDate, endDate.
- **list_all_nice_c_xone_wfm_data_agents** — Returns agent metadata. This method will return the agent metadata changes for a specific date range bounded by the "startDate" and "endDate" parameters. The maximum range for this method is 14 days. Required: startDate, endDate.
- **list_all_nice_c_xone_wfm_data_skill_agent_performance** — Returns agent-performance. This method will return the daily agent-performance generated by the WFM Data Collector for a single day range bounded by the "startDate" and "endDate" parameters. Required: startDate, endDate.
- **list_all_nice_c_xone_wfm_data_skill_contacts** — Returns contact statistics for WFM. This method will return the Contact statistics generated by the WFM Data Collector for a specific date range bounded by the startDate and endDate parameters. Required: startDate, endDate, mediaTypeId.
- **list_all_nice_c_xone_wfm_data_skill_dialer_contacts** — Returns dailer contact statistics. This method will return the dialer-contact generated by the WFM Data Collector for a specific date range bounded by the "startDate" and "endDate" parameters. Required: startDate, endDate, mediaTypeId.
- **list_all_nice_c_xone_workflow_data** — Returns a list of paginated Workflow Data list. This API gets the list of workflowData paginated
- **create_a_nice_c_xone_workflow_datum** — Create a new Workflow Data Profile.
- **nice_c_xone_workflow_data_bulk_update** — Update a Workflow Data Profile.
- **get_single_nice_c_xone_workflow_datum_by_id** — This method returns a Workflow Data Profile identified by its id. This API gets the workflowData profile identified by its id. Required: id.
- **nice_c_xone_workflow_data_activate** — Activate a Workflow Data Profile. Required: workflow_data_id.
- **nice_c_xone_workflow_data_deactivate** — Deactivate a Workflow Data Profile. Required: workflow_data_id.
- **list_all_nice_c_xone_workflow_data_identities** — Returns a list of paginated Workflow Data Identity list. This API gets the list of workflowData identities
- **list_all_nice_c_xone_workflow_data_list** — Get a list of Workflow Data Profiles based on the active flag. Required: active_flag.

## How it works

1. **Link your customer's NICE CXone account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app.
2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request.
3. **Call Truto's API to reach NICE CXone.** The Proxy API is a 1-to-1 mapping of the NICE CXone API.
4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field.

## Use cases

- **Embed a native CTI inside your CRM or helpdesk** — Give your users an in-app agent workspace so they stop toggling between NICE CXone's MAX client and your product. Truto handles the session lifecycle, interaction events, and call controls across every customer tenant.
- **Ingest 100% of contact center interactions for QA and conversational AI** — Pull voice recordings, chat and SMS transcripts, and analyzed segments from CXone into your platform to run sentiment, scoring, and coaching workflows. Ideal for revenue intelligence, QA automation, and compliance monitoring SaaS.
- **Automate outbound call lists and TCPA compliance** — Let sales engagement, marketing automation, or collections platforms push high-intent leads directly into CXone's Personal Connection dialer and sync opt-outs to DNC groups in real time — without your team learning the CXone API.
- **Enable PCI-safe payment capture over voice** — Payment, verification, and compliance SaaS can mask and unmask CXone recordings on demand so agents collect card or PHI data in your UI while the audio and screen capture pause automatically.
- **Sync agents, states, and WFM data for HR and workforce tools** — HRIS, payroll, gamification, and WFM platforms can provision CXone users via SCIM, read schedule adherence and scorecards, and push state changes based on calendar or shift events.

## What you can build

- **Embedded softphone with screen pop** — Create an agent session on login, accept/reject/hold/transfer calls through interaction endpoints, and pop the matching customer record using caller ID metadata.
- **Automatic call logging and disposition write-back** — Mirror completed contacts into your CRM as activities with duration, outcome, agent, and a link to the CXone recording, and push wrap-up codes back using set_disposition.
- **Recording ingestion pipeline for AI analysis** — Trigger media downloads for completed contacts, fetch analyzed transcript segments, and attribute each interaction to an agent and skill for QA scoring or conversation intelligence.
- **Dialer list and DNC sync** — Programmatically create CXone call lists, upload prospects, remove them when they convert or unsubscribe, and append numbers to DNC groups for compliant outbound campaigns.
- **PCI/HIPAA-safe recording masking** — Expose a one-click 'Pause Recording' control in your UI that calls mask/unmask on the active interaction so sensitive data never lands in CXone storage.
- **Agent provisioning and state automation** — Create, update, deactivate, and invite agents through SCIM and the Users API, assign skills and teams, and flip agent state based on external triggers like calendar events.

## FAQs

### How do end users authenticate their NICE CXone account?

Truto handles the full CXone OAuth and access-key flow for you. Your users connect their tenant once through Truto's connect UI or a custom auth form, and Truto manages token refresh, region routing, and credential storage per connected account.

### Can we control live calls (accept, hold, transfer, conference) from our UI?

Yes. The full agent_session_interactions surface is exposed — accept, reject, hold, resume, mute/unmute, transfer to agent or skill, conference, park, dial, send DTMF, and end — so you can build a complete embedded softphone.

### How do we get call recordings and transcripts out of CXone?

Use the media playback and media download endpoints to retrieve audio and segment files, and the analytics segment analyzed transcript endpoints for text. You can poll for completed contacts or trigger downloads on demand after an interaction closes.

### Does the integration support outbound dialing and DNC compliance?

Yes. You can create call lists, upload prospects, remove prospects, manage campaigns and skills, and add or bulk-manage DNC group records and contributing/scrubbed skills to keep outbound dialing TCPA-compliant.

### Can we mask recordings mid-call for PCI or HIPAA workflows?

Yes. The recording_interactions_mask and recording_interactions_unmask operations let you pause and resume both audio and screen recording on a live interaction, which is the standard pattern for taking card or PHI data in a third-party UI.

### How do we provision agents and read workforce data?

Agents can be created, updated, deactivated, invited, and bulk-updated through the agents and SCIM users endpoints, including skill, team, profile, and routing attribute assignment. WFM data such as schedule adherence, scorecards, agent state history, and login history is available for read.

### How fresh is interaction and agent state data?

Truto exposes CXone's real-time endpoints (active contacts, agent states, get_next_event) for live use cases like CTI and supervisor dashboards, and the historical/reporting endpoints for batch analytics. You can also layer Truto's polling or webhook delivery on top to push changes into your app.
