| 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 details of queue metrics. CallGem responds with periodic QueueMetrics [MZ] messages as defined in the TimeoutValue (TV) parameter. |
| Example | EM\TDdefault\TXABC001\CNCustCare\GA0001\TV20\TW30 |
| Explanation | The control application is requesting (with transaction identifier ABC001) periodic updates (every 20 seconds) of the performance metrics for queue '0001' of the CustCare campaign. Metrics which are over a period of time will be over the last 30 minutes. |
| Notes |
For an 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 |
| CN | CampaignName | string | false | 1 | 80 | If specified, will only advise transfer activity on a given campaign. |
| 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. |
| EV | EveryEvent | boolean | false | 0 | 0 | From V10.6.476 - This parameter indicates that a metrics event message should be sent every time the metrics change. This is mutually exclusive with the TV param. |
| GA | GroupAddress | string | false | 1 | 80 | If specified, will only advise activity on a specific queue. |
| 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 |
| TS | TimeStamp | string | false | 1 | 50 | From V10.6.476 - The UTC timestamp of the time messages are to be sent from. Note this parameter only applies if the EV parameter is specified. |
| TV | TimeoutValue | int | false | 15 | 999 | Indicates the number of seconds that should elapse between MZ (MetricsData) update messages. The default value is 15 seconds. |
| TW | TimeWindow | int | false | 1 | 1440 | Indicates the time window size in minutes for queue metrics that will be reported over a period of time rather than cumulatively (The Y0 and Y1 parameters of the MZ message). The range is between 1 minute and 1 day (1440 minutes). The default value is 60 minutes. |
| TX | TransactionIdentifier | string | true | 1 | 87 | Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests. |