GET NEXT EVENT

An API action that sends an event poll request to the platform to receive the next agent event in the event queue. See the get-next-event agent sessions API on the DEVone developer portal for more information. This API is typically only used when building an agent application or replicating that type of behavior and functionality.

Dependencies

This is an API action. It is found on the API Actions palette in Desktop Studio.

Supported Script Types

Generic	Email	Chat	Phone	Voicemail	Work Item	SMS	Digital

Input Properties

These properties define data that the action uses when executing.

Property	Description
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
Security User	The output value of the SetSecurityUser action which authenticates a selected agent based on their permissions in the security profile. The default value is SecurityUser (same default output value of SetSecurityUser). You do not need to use curly brackets ( {} ) with this property.
Session Id (in/out)	The unique ID assigned to the agent's login session within the NiCE CXone system.
Event Messages (out)	Any variables and information that result from executing the action.
Timeout	The number of seconds the action waits to execute before timing out. The value must be between 0 and 60.

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Each request for events from the NiCE CXone platform returns two items:

• A new session ID, which should be used in the subsequent event poll request.
• A collection of events that have occurred since the previous event poll request, if any.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnNewEvents	Path taken if the poll request receives a new event.
OnNoEvents	Path taken if the poll request does not receive a new event.
OnEventMissed	Path taken if an event occurred and was missed by the poll request.
OnSessionEnded	Path taken if the agent session ended.
OnInvalidAgentSession	Path taken if the Session Id entered is invalid.
OnInvalidSecurityUser	Path taken when an invalid security user is used.
OnInvalidTimeout	Path taken if the value entered in the Timeout property is invalid.

Other Options

You can leverage the existing agent applications that provide this functionality.