API Action List

The information on this help page applies to both CXone Studio and Desktop Studio.

Documentation for API actions on the Framework tab in Desktop Studio and the API Actions palette in CXone Studio is available in the CXone developer portal A square with an arrow pointing outside. . This page lists API actions and their corresponding APIs.

API Action	Corresponding API and Details
Active Contact Details	Returns a list of active contacts on the tenant GET /contacts/active
Address Book Assignment	Allows you to assign the address book specified by {addressBookId} to one set of entities such as agents, teams, skills, or campaigns exclusively. POST /address-books/{addressBookId}/assignment
address book entries	Returns a list of all entries in the address book specified by {addressBookId}. GET /address-books/{addressBookId}/entries
Address Book List	Returns a list of address books for the business unit High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment. GET /address-books
Address book list for an Agent	Returns a list of address books currently assigned to the agent specified by agentId. GET /agents/{agentId}/address-books
Address Book List for a Skill	Returns a list of all address books currently assigned to the ACD skill Used to automate delivery of interactions based on agent skills, abilities, and knowledge specified by {skillId}. GET /skills/{skillId}/address-books
Address Book List for a Team	Returns a list of address books currently assigned to the team specified by {teamId}. GET /teams/{teamId}/address-books
Assigned Agents for an address book	Returns a list of assigned agents for the address book specified by {addressBookId}. GET /address-books/{addressBookId}/agents/assigned
Address Book for a Campaign	Returns a list of address books currently assigned to the campaign specified by {campaignId}. GET campaigns/{campaignId}/address-books
Contact List Details v23	Returns a list of contacts. Data returned depends on whether the contact is active or completed. GET /contacts
Create Address Book	Creates an address book. POST /address-books
Create address book entries	Creates new address book entries in the address book specified by {addressBookId}. POST /address-books/{addressBookId}/entries
Create Calling List Mapping	Allows you to define the mapping used when a file is uploaded with the POST /lists/call-lists/{listId}/upload API. POST /lists/call-lists
Create Or Update Dynamic AddressBook	Creates or updates entries in the dynamic address book specified by {addressBookId}. PUT /address-books/{addressBookId}/dynamic-entries
Delete Address Book	Deletes the address book specified by {addressBookId} . DELETE /address-books/{addressBookId}
Delete Address Book Entry	Deletes a single address book entry specified by {addressBookEntryId} from the address book specified by {addressBookId}. DELETE /address-books/{addressBookId}/entries/{addressBookEntryId}
Delete Dynamic Address Book Entry	Deletes an entry identified by {externalID} in the dynamic address book specified by {addressBookId}. DELETE /address-books/{addressBookId}/dynamic-entries/{externalId}
Dynamic Address Book Entries	Opens an address book on the CXonetenant and looks up a name, phone number, or other detail. GET /address-books/{addressBookId}/dynamic-entries
END AGENT SESSION	Ends an agent session in the agent application. DELETE /agent-sessions/{sessionId}
Get Agents List	Returns a list of all agent users on thetenant . GET /agents
Get All Address Books	Returns a list of all address books in the business unit High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment. See also: Address Book List. GET /address-books
Get Contact List
Get Skill Activity	Returns activity information for all skills. GET /skills/activity
Get Skill Details	Returns details for the specified skill ID. GET /skills/{skillId}
Get Skill General Settings	Returns the General Settings for a skill. Only for use with Personal Connection skills. GET /skills/{skillId}/parameters/general-settings
Server Time	Returns the server time in ISO 8601, the international standard for the exchange and communication of date and time-related information. GET /server-time
Skill Call Data	Returns summary information about the contacts handled for the ACD skill specified by {skillId} over the specified time period. GET /skills/{skillId}/call-data
Unassigned agents for address book	Returns unassigned agents for the address book specified by {addressBookId}. GET /address-books/{addressBookId}/agents/unassigned
Update Address Book Entries	Updates existing address book entries associated with a single address book specified by {addressBookId}. PUT /address-books/{addressBookId}/entries