API Message Reference

ES - Enumerate Status

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose The Enumerate Status request allows a client to subscribe for status on all campaigns, and receive deltas on change.
Example CM:DE:ES\TDdefault\TXhello\OIxyz
Explanation A client requests a subscription to campaign status, with transaction tag 'Hello'. The campaign status information is returned in a series of Status Data [SD] messages.
Notes See also SDMP Message Protocol
Parameters
Code Name Type Mandatory? Min Val Max Val Description
OI OriginatorID string true 1 255 Originator ID. A token identifying the originator of the message.
TD TenantDescriptor string true 1 80 Mandatory when operating in Multi-Tenancy. Otherwise it must not be used.

This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name.

TK Token string false 1 80 Token parameter
TV TimeoutValue int true 1 3600 From V10.6.849 - The frequency with which status changes are broadcast, in seconds. A running campaign may change status and call counts several times per second. This value sets the minimum time between updates when status is changing frequently. This defaults to 5 seconds if not passed.
TX TransactionIdentifier string true 1 87 Transaction identifier.

 

Copyright © 2004 - 2019  Sytel Limited