| 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 agents currently logged in, either to a specified campaign or across all campaigns. |
| Example | EA\TXABC001\TDdefault\CNCustCare\LD2 |
| Explanation | The control application is requesting (with transaction identifier ABC001) a list of all agents currently logged in to the CustCare campaign. |
| Notes |
Produces
Agent Data [AZ] responses from CallGem. If an agent is in any state other than 'logged in and working'
at the time the request is made, he will not be included in the subsequent
Agent Data [AZ] 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 |
| CN | CampaignName | string | false | 1 | 80 | If CN is not present then the EA message enumerates all agents across all campaigns. |
| 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. |
| LD | LevelOfDetail | int | false | 1 | 4 |
Level of Detail. Determines which parameters are included in the AZ message.
1 is the default and includes basic logged in / available / logged out state provided by the ZA, W0 and W1 parameters. Set to 2 to include the DS, OS, Z3 and Z4 parameters. Set to 3 to include the Z0, Z1, Z2 and DT parameters. See the Agent Data [AZ] message for more information. |
| 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' AZ messages being sent. If not set, no periodic refresh is made. |
| TX | TransactionIdentifier | string | true | 1 | 87 |
Only 80 characters used by integrators. 7 characters reserved for internal
use.
Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests. |