API Message Reference

EP - Enumerate Campaign Properties

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose To receive property data for all configured campaigns
Example CM:DE:EP\TDdefault\TXfoo\OIxyz
Explanation

The client has subscribed to receive property data for all campaigns on tenant default. The server will return property data in the Property Data [PD] message for each configured campaign, and will issue Property Data [PD] messages every time a campaign's properties change.

Introduced to eliminate the need for repeated use of Get Campaign Properties [GP] to check for changes.

Introduced V10.6.956 & V10.7.1212
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
TX TransactionIdentifier string true 1 87 Transaction identifier.

 

Copyright © 2004 - 2019  Sytel Limited