API Message Guide

OC - Open Campaign

Layer Campaign Manager
Direction To CallGem
Type of Service CM
Interface ID DE
Message Purpose This message is sent by the host application requesting CallGem to start a campaign
Example CM:DE:OC\TDdefault\CY1\TKfoo\OIxyz
Explanation A client requests to open campaign 1 in the default tenant.
Notes

If using a version of SCC prior to V10.6.600, see Starting and Resuming a Campaign for advice on opening multiple campaigns in the same minute.

See also SDMP (Softdial Message Protocol) and notes on the non-routed Open Campaign message.

Last Changed 10.6.366
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.
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