| Layer | Campaign |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | CA |
| Message Purpose | This message purges all the numbers from either CallGem's predictive queue only, or from all CallGem's queues. |
| Example | PQ\CNCustCare |
| Explanation |
The agent application is asking CallGem to purge the predictive queue.
No Number Back [NB] messages are sent. When the agent application uses this message there is an implicit assumption that it is tracking the progress of all the numbers it has passed to CallGem, and will know exactly which ones are being purged without requiring a Number Back [NB] message. |
| Notes |
This message may be sent at any time
Numbers in the process of being called are unaffected. These numbers are those for which a Call Initiate [CI] message has already been sent by CallGem. |
| Last Changed | Pre V9.2 |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| CN | CampaignName | string | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; | |
| PA | PurgeAll | boolean | false | 0 | 0 | If this parameter is omitted, then the queue for predictive calls is purged. If it is included, then both the predictive queue and also the timed queue are purged. See also the two topics starting Number Management. |
| PP | PurgeProgressing | boolean | false | 0 | 0 |
This is not a parameter that should be used by integrators.
You may see an internal Purge Queue [PQ] message being generated in response to a telephony or campaign interface failure. This additional parameter is used to tear down calls being dialed. This is necessary to ensure that the system can be maintained in a stable state after telephony failure. |
| 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 |