Terminate Agent Session

Forces an agent session to end. Typically used for removing a stuck agent session.

This is an API action.

Dependencies

You always need to precede this action with the SetSecurityUser action to get the security user.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

 Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

SecurityUser

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 braces ( { } ). The default value is SecurityUser (same default output value of SetSecurityUser).

AgentId

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

errorArgList(out)

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.