| Layer | Campaign Manager |
| Direction | To CallGem |
| Type of Service | CM |
| Interface ID | DE |
| Message Purpose | Get Campaign Properties |
| Example | CM:DE:GP\TDdefault\CY1\OIxyz |
| Explanation | The client requests property data for campaign identifier 1 on tenant default. The server will return property data in the Property Data [PD] message. |
| Notes |
For a way to listen for changes to campaign properties, see Enumerate Campaign Properties [EP]. See also: |
| Last Changed | 10.0.0.30 |
| 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 |