Contents
CfgCampaign
Description
Campaigns are structures for organizing and managing an automated process of making outbound calls to the destinations specified in Calling Lists.
Filter Keys
Filter Name | Type | Description |
---|---|---|
dbid | int | A unique identifier of the campaign. If specified, configuration server will return information only about this campaign. |
tenant_dbid | int | A unique identifier of the tenant. If specified, Configuration server will return information only about the campaign(s) that belong to this tenant. |
name | string | Name of a campaign. Shall be specified as a character string. If specified, Configuration Server will return information only about the campaign(s) with that name. |
group_dbid | int | A unique identifier of group. If specified, Configuration Server will return information only about the campaign(s) with that group. |
calling_list_dbid | int | A unique identifier of calling list. If specified, Configuration Server will return information only about the campaign(s) with that calling list. |
script_dbid | int | A unique identifier of the campaign script. If specified, Configuration Server will return information only about the campaign(s) with that script. |
state | int | Current state of the campaign (See CfgObjectState). If specified, Configuration Server will return information only about the campaign(s) that are currently in this state. |
Attributes
- DBID — An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.
- tenantDBID — A unique identifier of the CfgTenant to which this campaign is allocated. Mandatory. Once specified, cannot be changed.
- name — A pointer to the campaign name. Mandatory.
- description — A pointer to the campaign description.
- callingLists — A pointer to list of calling lists info dedicated to campaign(every item of this list is structured as CfgCallingListInfo).
- campaignGroups — Not in use starting from 7.5 release. Campaign Groups are represented as CfgCampaignGroup objects under the Campaigns.
- scriptDBID — A unique identifier of the campaign CfgScript. Optional.
- state — Current object state. Mandatory. Refer to CfgObjectState.
- userProperties — A pointer to the list of user-defined properties. Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
XML Representation
Tip
This XML was created using the Configuration Server 7.5 schema.<CfgCampaign> <DBID value="101" /> <tenantDBID value="101" /> <name value="ACampaign" /> <scriptDBID value="0" /> <state value="1" /> </CfgCampaign>
See Also
This page was last edited on June 27, 2017, at 20:20.
Comments or questions about this documentation? Contact us for support!