| Layer | Management |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | MA |
| Message Purpose | Enumerate Chat [QC] can be used to register for advice of chat messaging activity on filtered by tenant, campaign, queue. |
| Example | QC\TDdefault\TXABC001\TDdefault\QIFred |
| Explanation | The control application is requesting (with transaction identifier ABC001) detail on chat messages sent to and from |
| Notes |
For an overview of the query process, see Resource Enumeration API |
| Introduced | V10.7.697 |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| AN | AgentIdentifier | string | false | 1 | 80 | Allows the enumerate query to filter by endpoint. If passed, only chat activity relating to the endpoint will be sent in the Chat data [XD] message. |
| CN | CampaignName | string | false | 1 | 80 | If specified, will only advise chat message activity associated with a given campaign. If this parameter is passed, the Tenant Descriptor [TD] parameter must also be passed. |
| GA | GroupAddress | string | false | 1 | 80 | If specified, will only advise chat message activity on a specific queue. If this parameter is passed, the Campaign Name [CN] and Tenant Descriptor [TD] parameter must also be passed. |
| 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. |
| QI | UserIdentifier | string | false | 1 | 80 | Allows the enumerate query to filter by Turret. If passed, only chat activity relating to endpoints forming part of the turret will be sent in the Chat Data [XD] message. |
| TD | TenantDescriptor | string | false | 1 | 80 |
If specified, will only advise chat message activity associated with a given tenant. |
| 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. |