API Message Reference

RL - Reload Campaign

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose Reload Campaign
Example CM:DE:RL\TDdefault\CY1\OIxyz\PC
Explanation A client requests to reload campaign 1 in the default tenant.
Notes

See Reloading a Campaign

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.
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.

P0 PurgePrimaryCache boolean false 0 0 From V10.6.297 - Purge Primary Cache. Flag that invokes purging of the primary cache.
PC PurgeRetryCache boolean false 0 0 From V10.6.148 - Purge Cache. Flag that invokes purging of the retry cache.
SB SendNumbersBack boolean false 0 0 This parameter is included if an immediate shutdown is wanted.

As of Version 8.0.63.0, CallGem assumes this parameter to be present, whether or not it has been included in this 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 From V10.7.74 - Transaction identifier uniquely identifying this request.

 

Copyright © 2004 - 2019  Sytel Limited