| Layer | Campaign Manager |
| Direction | To CallGem |
| Type of Service | CM |
| Interface ID | DE |
| Message Purpose | This message attempts to block a campaign record to prevent it being processed. |
| Example | CM:DE:BC\TDdefault\CY1\AS1234\TKfoo\OIxyz |
| Explanation | A client requests to block the campaign record key 1234 on campaign 1 in the default tenant to try to prevent this contact from from being called. |
| Notes | See also Campaign Manager FAQ and SDMP Message Protocol |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| AS | ApplicationSpecificData | string | true | 1 | 4000 | Application Specific parameter |
| CY | CampaignIdentifier | int | true | 0 | 9999 | Campaign Identifier parameter. The identifier can be extracted from the status broadcast message. |
| EL | ExcludeFromDncList | boolean | false | 0 | 0 | From V10.6.176 - Do not add internal DNC entry |
| OI | OriginatorID | string | true | 1 | 255 |
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 |