API Message Reference

CC - Close Campaign

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose This message is sent to the CampaignManager layer requesting it to close a campaign.
Example CM:DE:CC\TDdefault\CY1\OIxyz
Explanation The client is requesting to close campaign ID 1 on tenant default
Notes See also SDMP Message Protocol
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string true (See Description) 1 80 From - V10.7.830 - Identifies the campaign (or linked campaign) by name. Either the CN or CY parameter must be passed.
CY CampaignIdentifier int true (See Description) 0 9999 A unique integer ID for the campaign, which can be extracted from the Status Broadcast message. Either the CN or CY parameter must be passed .
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

 

Copyright © 2004 - 2019  Sytel Limited