| Layer | Campaign |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | CA |
| Message Purpose | This message asks CallGem to close a campaign. |
| Example | CC\CNCustCare\SB |
| Explanation | The agent application is asking CallGem to close the CustCare campaign immediately, and send back all numbers held by CallGem to it. |
| Notes |
This message may be sent at any time. Once this message has been issued, there
is no need for the agent application to issue
Agent Unavailable [AU] or
Log Out [LO] messages, as agents cease to take calls.
See Closing a campaign in Changing Campaign State for a detailed explanation of how shutdown occurs. |
| Last Changed | Pre V9.2 |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| C2 | CampaignTwo | string | false | 1 | 80 | The C2 parameter on the close campaign message indicates the campaign to which agents should be transferred. |
| CN | CampaignName | string | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; | |
| SB | SendNumbersBack | boolean | false | 0 | 0 |
This parameter is included if an immediate shutdown is wanted.
As of Version 8.0.63.0, CallGem assumes this parameter to be present, whether or not it has been included in this message. |
| 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 |
| TV | TimeoutValue | int | false | 1 | 3600 | The number of seconds to wait before killing an open campaign. If not specified a default value of 3600 (or 1 hour) is asserted. |
| WC | WorkCache | boolean | false | 0 | 0 | Work Cache Parameter |