KA - Kill Agent

Layer	Management
Direction	To CallGem
Type of Service	CG
Interface ID	MA
Message Purpose	This message is sent by the control application to CallGem to remove an agent from a campaign with immediate effect.
Example	KA\TDdefault\CNCustCare\AN2\TXABC001
Explanation	The control application is requesting that CallGem remove agent with identifier 2 from the CustCare campaign.
Notes	CallGem will perform all the necessary transactions without further intervention, except when using Switch-Determined Routing. See Agent Removal and Emergency Shutdown for more details.

Parameters

Code

Name

Type

Mandatory?

Min Val

Max Val

Description

AgentIdentifier

string

false

The identifier of the agent endpoint to be forcibly logged out. This parameter is mutually exclusive with Group Address [GA] and User Identifier [QI].

CampaignName

string

false

User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;

GroupAddress

string

false

If specified, the group of agents that are to be forcibly logged out. This parameter is mutually exclusive with Agent Identifier [AN] and User Identifier [QI].

Priority

int

false

If this parameter is not present the default is zero, otherwise:

0	Release the agent at the end of talk/ wrap, only if no predial is in progress. If predial has begun, or if the agent is currently waiting to take another call, then depending upon the likely impact on the algorithms, the agent may be asked to take another call by Softdial CallGem™ in order to avoid the possibility of an abandoned call.
1	Release the agent if he is waiting, or as soon as he has finished talk/ wrap, without regard for the impact on the algorithms, and with the possibility of an abandoned call occurring.
2	Release the agent immediately, terminating any live call that may be in progress.

UserIdentifier

string

false

From V10.7.338 - The identity of the user to be forcibly logged out. This will have the effect of logging out any agent endpoints associated with the user. This parameter is mutually exclusive with Group Address [GA] and Agent Identifier [AN].

TenantDescriptor

string

false

This parameter is alphanumeric and identifies to which tenant this message applies.

Token

string

false

Token parameter

TransactionIdentifier

string

true

Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests.

If this Kill Agent [KA] request forms part of a Kill Campaign [KC] request, CallGem will append each TX parameter with '-000001' for the first agent, '-000002' for the second, and so on. See Agent Removal and Emergency Shutdown for more details.