TERMINATE AGENT SESSION

An API action that forces an agent session to end. Typically used for removing a stuck agent session.

Supported Script Types

Generic	Email	Chat	Phone	Voicemail	Work Item	SMS

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. This field accepts variable formatted with curly brackets ( { } ). The default value is SecurityUser (same default output value of SetSecurityUser).
Agent Id	ID for the agent whose session you want to forcibly terminate.

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.

Property	Description
Error Arg List	Variable name for any errors that are output.

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.
OnSuccess	Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).
OnInvalidAgentId	Path taken if the Agent ID is invalid.
OnUnauthorized	Path taken if there are insufficient permissions to forcibly terminate the session.
OnInvalidSecurityUser	Path taken when an invalid security user is used.
OnTooManyRequests	Path taken if the API call has made too many requests.