| Layer | Campaign Manager |
| Direction | To CallGem |
| Type of Service | CM |
| Interface ID | DE |
| Message Purpose | This message is sent to the CampaignManager layer requesting it to add a new campaign. |
| Example | CM:DE:AC\TDdefault\CNCustCare\\OIxyz\DT(...) |
| Explanation | The client is requesting to add a campaign called 'CustCare' on tenant 'default' |
| Notes | See also SDMP Message Protocol |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| AQ | AbandonQueue | string | false | 1 | 80 | From V10.7.871 - The name of the queue to which sessions are requeued on abandon. Customers needing to implement compliance processes such as opt-out will need to set this, and provide an IVR script to handle the opt-out process. |
| CN | CampaignName | string | true |
1 | 80 |
Campaign Name parameter. The name, unique within a tenant, given to the campaign.
|
| CR | CallRecording | boolean | false | 0 | 0 | From V10.7.871 - No value required. When present, indicates that blanket media recording is enabled for the campaign. |
| CY | CampaignIdentifier | int | true (see Description) | 0 | 9999 | From V10.7.830 - Campaign Integer Identifier parameter. This remains constant, allowing campaigns to be renamed. All CM messages relating to a campaign must contain either the CN or CY parameter to identify the campaign. |
| DT | Data |
|
false | 1 | 128000 | The DT parameter, if specified in the AddCampaign method, should contain an XML string, as per the data returned by the Property Data [PD] message |
| NU | NailedUp | boolean | false | 0 | 0 | From V10.7.871 - No value required. When present, indicates that agents on this campaign will be nailed-up regardless of whether the campaign is an off-hook campaign or not. |
| 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. |
| PM | PlayMessage | string | false | 1 | 80 | From V10.7.871 - The symbolic name for the sound fragment to be played at the point where the agent leaves the call. The symbolic name is validated against sound names in the Repository path _config/Sound Resources. |
| SN | AbandonGreeting | string | false | 1 | 80 | From V10.7.871 - The symbolic name for the sound fragment to be played on outbound abandon. The symbolic name is validated against sound names in the Repository path _config/Sound Resources. |
| 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 |