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 |
AN | AgentIdentifier | string | false | 1 | 80 | The identifier of the agent endpoint to be forcibly logged out. |
CN | CampaignName | string | false | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; |
TD | TenantDescriptor | string | false | 1 | 80 | This parameter is alphanumeric and identifies to which tenant this message applies. |
TK | Token | string | false | 1 | 80 | Token parameter |
TX | TransactionIdentifier | string | true | 1 | 87 |
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. |