Campaign.md in purecloudplatformclientv2-19.0.0

- old
+ new
@@ -6,37 +6,38 @@
 ## Properties
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
+| **name** | **String** | The name of the Campaign. | |
 | **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
-| **contact_list** | [**UriReference**](UriReference.html) | identifier of the contact list for the campaign | |
-| **queue** | [**UriReference**](UriReference.html) | identifier of the agent assignment queue, required for all dialing modes other than agentless | |
-| **dialing_mode** | **String** | dialing mode of the campaign | |
-| **script** | [**UriReference**](UriReference.html) | identifier of the campaign script, required for all dialing modes other than agentless | |
-| **edge_group** | [**UriReference**](UriReference.html) | identifier of the edge group, required for all dialing modes other than preview | |
-| **campaign_status** | **String** | status of the campaign; can be set to &#39;on&#39; or &#39;off&#39; | |
-| **phone_columns** | [**Array&lt;PhoneColumn&gt;**](PhoneColumn.html) | the contact list phone columns to be called for the campaign | |
-| **abandon_rate** | **Float** | the targeted abandon rate percentage | [optional] |
-| **dnc_lists** | [**Array&lt;UriReference&gt;**](UriReference.html) | identifiers of the do not call lists | [optional] |
-| **callable_time_set** | [**UriReference**](UriReference.html) | the identifier of the callable time set | [optional] |
-| **call_analysis_response_set** | [**UriReference**](UriReference.html) | the identifier of the call analysis response set, required for all dialing modes other than preview | |
-| **errors** | [**Array&lt;RestErrorDetail&gt;**](RestErrorDetail.html) | a list of current error conditions associated with the campaign | [optional] |
-| **caller_name** | **String** | caller id name to be displayed on the outbound call | [optional] |
-| **caller_address** | **String** | caller id phone number to be displayed on the outbound call | [optional] |
-| **outbound_line_count** | **Integer** | for agentless campaigns, the number of outbound lines to be concurrently dialed | [optional] |
-| **rule_sets** | [**Array&lt;UriReference&gt;**](UriReference.html) | identifiers of the rule sets | [optional] |
-| **skip_preview_disabled** | **BOOLEAN** | for preview campaigns, indicator of whether the agent can skip a preview without placing a call | [optional] |
-| **preview_time_out_seconds** | **Integer** | for preview campaigns, number of seconds before a call will be automatically placed. A value of 0 indicates no automatic placement of calls | [optional] |
-| **contact_sort** | [**ContactSort**](ContactSort.html) | information determining the order in which the contacts will be dialed | [optional] |
-| **contact_sorts** | [**Array&lt;ContactSort&gt;**](ContactSort.html) | column prioritized information determining the order in which the contacts will be dialed | [optional] |
-| **no_answer_timeout** | **Integer** | for non-preview campaigns, how long to wait before dispositioning as &#39;no-answer&#39;, default 30 seconds | [optional] |
-| **call_analysis_language** | **String** | The language the edge will use to analyse the call | [optional] |
-| **priority** | **Integer** | The priority of this campaign relative to other campaigns | [optional] |
-| **contact_list_filters** | [**Array&lt;UriReference&gt;**](UriReference.html) | Filter defining a subset of contacts from the contact list to be dialed | [optional] |
+| **contact_list** | [**UriReference**](UriReference.html) | The ContactList for this Campaign to dial. | |
+| **queue** | [**UriReference**](UriReference.html) | The Queue for this Campaign to route calls to. Required for all dialing modes except agentless. | [optional] |
+| **dialing_mode** | **String** | The strategy this Campaign will use for dialing. | |
+| **script** | [**UriReference**](UriReference.html) | The Script to be displayed to agents that are handling outbound calls. Required for all dialing modes except agentless. | [optional] |
+| **edge_group** | [**UriReference**](UriReference.html) | The EdgeGroup that will place the calls. Required for all dialing modes except preview. | [optional] |
+| **campaign_status** | **String** | The current status of the Campaign. A Campaign may be turned &#39;on&#39; or &#39;off&#39;. Required for updates. | [optional] |
+| **phone_columns** | [**Array&lt;PhoneColumn&gt;**](PhoneColumn.html) | The ContactPhoneNumberColumns on the ContactList that this Campaign should dial. | |
+| **abandon_rate** | **Float** | The targeted abandon rate percentage. Required for progressive, power, and predictive campaigns. | [optional] |
+| **dnc_lists** | [**Array&lt;UriReference&gt;**](UriReference.html) | DncLists for this Campaign to check before placing a call. | [optional] |
+| **callable_time_set** | [**UriReference**](UriReference.html) | The callable time set for this campaign to check before placing a call. | [optional] |
+| **call_analysis_response_set** | [**UriReference**](UriReference.html) | The call analysis response set to handle call analysis results from the edge. Required for all dialing modes except preview. | [optional] |
+| **errors** | [**Array&lt;RestErrorDetail&gt;**](RestErrorDetail.html) | A list of current error conditions associated with the campaign. | [optional] |
+| **caller_name** | **String** | The caller id name to be displayed on the outbound call. | |
+| **caller_address** | **String** | The caller id phone number to be displayed on the outbound call. | |
+| **outbound_line_count** | **Integer** | The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. | [optional] |
+| **rule_sets** | [**Array&lt;UriReference&gt;**](UriReference.html) | Rule sets to be applied while this campaign is dialing. | [optional] |
+| **skip_preview_disabled** | **BOOLEAN** | Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. | [optional] |
+| **preview_time_out_seconds** | **Integer** | The number of seconds before a call will be automatically placed on a preview. A value of 0 indicates no automatic placement of calls. Only applicable to preview campaigns. | [optional] |
+| **always_running** | **BOOLEAN** | Indicates (when true) that the campaign will remain on after contacts are depleted, allowing additional contacts to be appended/added to the contact list and processed by the still-running campaign. The campaign can still be turned off manually. | [optional] |
+| **contact_sort** | [**ContactSort**](ContactSort.html) | The order in which to sort contacts for dialing, based on a column. | [optional] |
+| **contact_sorts** | [**Array&lt;ContactSort&gt;**](ContactSort.html) | The order in which to sort contacts for dialing, based on up to four columns. | [optional] |
+| **no_answer_timeout** | **Integer** | How long to wait before dispositioning a call as &#39;no-answer&#39;. Default 30 seconds. Only applicable to non-preview campaigns. | [optional] |
+| **call_analysis_language** | **String** | The language the edge will use to analyze the call. | [optional] |
+| **priority** | **Integer** | The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. | [optional] |
+| **contact_list_filters** | [**Array&lt;UriReference&gt;**](UriReference.html) | Filter to apply to the contact list before dialing. Currently a campaign can only have one filter applied. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 
 