| 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 Message Protocol and notes on the non-routed Open Campaign message. |
| 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. |
| 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 |