API Message Reference

EX - Enumerate Transfer Activity

Layer Management
Direction To CallGem
Type of Service CG
Interface ID MA
Message Purpose Enumerate Transfer Activity.
Example EX\TDdefault\TXABC001\CNCustCare
Explanation The control application is requesting (with transaction identifier ABC001) the set of call activity events associated with a queue.
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.

Last Changed V10.2.0.50
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.
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
TX TransactionIdentifier string true 1 87 Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests.

 

Copyright © 2004 - 2019  Sytel Limited