Layer | Campaign Manager |
Direction | To CallGem |
Type of Service | CM |
Interface ID | DE |
Message Purpose | Add Do Not Call Data |
Example | CM:DE:DD\TDdefault\CNCustCare\TN01234567890\OIxyz |
Explanation | A client requests the addition of a telephone number to a tenant or campaign Do Not Call List |
Notes | See also SDMP Message Protocol |
Parameters | ||||||
---|---|---|---|---|---|---|
Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
CN | CampaignName | string | true |
1 | 80 | Identifies the campaign (or linked campaign) by name. |
CY | CampaignIdentifier | int | true (See Description) | 0 | 9999 | From - V10.7.830 - A unique integer ID for the campaign, which can be extracted from the Status Broadcast message. Either the CN or CY parameter must be passed. |
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 | false | 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. |
TN | TelephoneNumber | string | false | 0 | 80 | Telephone Number parameter |