| Layer | Management |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | MA |
| Message Purpose | Enumerate Sessions Events [EV] can be used to register to be notified via the SessionEventData [VZ] message every time a media session changes state. |
| Example | EV\TXABC001\TDtenant1 |
| Explanation | The control application is requesting (with transaction identifier ABC001) notification via the Session Event Data [VZ] message of call details for all state changes on all sessions on all campaigns on tenant 'tenant1'. |
| 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. |
| Introduced | 10.7.74 |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| CN | CampaignName | string | false | 1 | 80 | If specified, will only advise activity on sessions associated with 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. |
| GA | GroupAddress | string | false | 1 | 80 | If specified, will only advise activity on a specific queue. |
| IC | IdentifyCTI | string | false | 1 | 80 | It indicates to which telephony layer (switch) the results relate. |
| 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 | This parameter follows the Windows OLE Automation date format. When sent in the EV message it indicates the earliest time for which the application wants to register for events. The value should be in local time, not UTC. CallGem keeps a history of call cycle events in memory for one hour to facilitate failover recovery. |
| TW | TimeWindow | int | false | 1 | 1440 | From V10.7.454 - Indicates the Time interval between 'refresh' Session Event Data [VZ] messages being sent. If not set, no periodic refresh is made. If a TW parameter is sent with argument 'nn', VZ messages are emitted every nn seconds. |
| TX | TransactionIdentifier | string | true | 1 | 87 | Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests. |