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 (Softdial Message Protocol) |
Parameters | ||||||
---|---|---|---|---|---|---|
Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
CN | CampaignName | string | true | 1 | 80 | Campaign Name parameter. The name, unique within a tenant, given to 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 |
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 |