API Message Reference

RS - Reset Campaign Statistics

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose Reset Campaign Statistics
Example CM:DE:RS\TDdefault\CY1\OIxyz
Explanation A client requests to reset statistics on campaign 1 in the default tenant.
Notes See also SDMP Message Protocol
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string false 1 80

Campaign Name parameter. The name, unique within a tenant, given to the campaign.

Either the Campaign Name (CN) parameter or the Campaign Identifier (CY) parameter must be specified to identify the campaign.

CY CampaignIdentifier int false 0 9999 Campaign Identifier parameter. The identifier can be extracted from the status broadcast message.
LD LevelOfDetail int false 1 2 From V10.6.860 - If passed:
  • 1 - reset all linked campaigns
  • 2 - reset statistics for all campaigns
OI OriginatorID string true 1 255 Originator ID. A token identifying the originator of the message.

The Originator ID (OI) parameter does not need to be specified if using the RouterNet method and event API. RouterNet appends the Originator ID by default.

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
LD LevelOfDetail int false 1 2 If passed:

1 - Reset tables for the campaign specified by the CY parameter, and all campaigns linked to it

2 - Reset tables for all campaigns for this tenant (ignoring the CY parameter)

 

Copyright © 2004 - 2019  Sytel Limited