API Message Reference

KC - Kill Campaign

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 shut down a campaign and log out any agents on that campaign with immediate effect.
Example	KC\TDdefault\CNCustCare\TXABC001
Explanation	The control application is requesting that CallGem shut down the CustCare campaign and log out all agents currently on that 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.
Last Changed	Pre V9.2

Parameters
Code	Name	Type	Mandatory?	Min Val	Max Val	Description
CN	CampaignName	string	true	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.