API Message Reference

NC - Rename Campaign

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose This message is sent by the CampaignManager layer to CallGem advising it to rename an existing campaign
Example CM:DE:NC\TDdefault\CY1\CNNewName\OIxyz
Explanation A client requests to rename campaign ID 1 to be called NewCampaign.
Notes See RouterNET Integration. See also SDMP Message Protocol
Last Changed 10.1.0.42
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CY CampaignIdentifier int true 0 9999 Campaign Identifier parameter. The identifier can be extracted from the status broadcast message.
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