| 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 request a list of running campaigns. |
| Example | EC\TXABC001 |
| Explanation | The control application is requesting (with transaction identifier ABC001) a list of all campaigns currently running. |
| Notes |
Produces
Campaign Data [CZ] responses from CallGem. If a campaign is in any state other than 'running' at the
time the request is made, it will not be included in the subsequent
Campaign Data [CZ] message set.
For on overview of the query process, see Resource Enumeration API From V10.6.263 there is a change to Enumeration behaviour when using the PersistToken (PS) parameter - see Resource Enumeration API. |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| CS | RateControl | string | false | 1 | 1000000 | From V10.6.660 - The number of event messages per second that the subscriber can handle during rollforward after re-subscribing. Defaults to 100 (per PersistToken). See Resource Enumeration API. |
| PS | PersistToken | string | false | 1 | 80 | Persist token. This tells CallGem to persist this transaction even if the socket connection from the originator fails. The transaction will buffer events in anticipation of reconnect and re-issue of the transaction. |
| 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 |
| TW | TimeWindow | int | false | 1 | 1440 | From V10.7.454 - Indicates the Time interval between 'refresh' CZ messages being sent. If not set, no periodic refresh is made. |
| TX | TransactionIdentifier | string | true | 1 | 87 | Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests. |