API Message Guide

SP - Set Campaign Properties

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose To set the properties of a campaign
Example CM:DE:SP\TDdefault\CY1\OIxyz\DT<xml data...>
Explanation The client requests to update property data for campaign identifier 1 on tenant default. This request should be made synchronously to ensure data integrity.
Notes See RouterNET Integration. See also SDMP (Softdial Message Protocol)
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CY CampaignIdentifier int true 0 9999 Campaign Identifier parameter. The identifier can be extracted from the status broadcast message.
DT Data string false 1 128000 The DT parameter should contain an XML string that describes the properties of the campaign.
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