Table Type: Metadata
This table stores the outbound campaigns. Each campaign is for a specific contact list and queue.
Columns
| Column | Type | Modifiers | Notes |
|---|---|---|---|
| id | string | Primary Key | The unique campaign id. |
| db_last_updated | datetime | When this record was last updated in UTC. | |
| db_when_created | datetime | When this record was created in UTC. | |
| db_when_deleted | datetime | When this record was deleted in UTC. NULL if not deleted. | |
| dialing_mode | string | One of: agentless, preview, power, predictive, progressive or external | |
| campaign_status | string | One of: on, stopping, off, complete, invalid, forced_off or forced_stopping | |
| name | string | The name of the campaign | |
| date_created | datetime | When this record was created in UTC. | |
| date_modified | datetime | When this record was last updated in UTC. | |
| contact_list_id | string | Primary Key | The contact list id associated with this campaign |
| contact_list_name | string | The contact list name associated with this campaign | |
| queue_id | string | The queue id associated with this campaign | |
| queue_name | string | The queue name associated with this campaign | |
| script_id | string | The script id associated with this campaign | |
| script_name | string | The script name associated with this campaign | |
| edge_group_id | string | The edge group id associated with this campaign | |
| edge_group_name | string | The edge group name associated with this campaign | |
| site_id | string | The site id associated with this campaign | |
| site_name | string | The site name associated with this campaign | |
| abandon_rate | double | The targeted compliance abandon rate percentage. Required for power and predictive campaigns. | |
| callable_time_set_id | string | The callable time set id for this campaign to check before placing a call. | |
| callable_time_set_name | string | The callable time set name for this campaign to check before placing a call. | |
| call_analysis_response_set_id | string | The call analysis response set id associated with this campaign | |
| call_analysis_response_set_name | string | The call analysis response set name associated with this campaign | |
| caller_name | string | The name of the caller to present | |
| caller_address | string | The caller id to present | |
| outbound_line_count | int32 | The number of outbound lines to be concurrently dialed. Only applicable to non-preview campaigns; only required for agentless. | |
| skip_preview_disabled | boolean | Whether or not agents can skip previews without placing a call. Only applicable for preview campaigns. | |
| preview_timeout_seconds | int64 | 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. | |
| 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. | |
| no_answer_timeout | int32 | How long to wait before dispositioning a call as 'no-answer'. Default 30 seconds. Only applicable to non-preview campaigns. | |
| call_analysis_language | string | The language the edge will use to analyze the call. | |
| priority | int32 | The priority of this campaign relative to other campaigns that are running on the same queue. 5 is the highest priority, 1 the lowest. | |
| division_id | string | The division id associated with this campaign | |
| division_name | string | The division name associated with this campaign | |
| max_calls_per_agent | int32 | The maximum number of calls that can be placed per agent on this campaign. | |
| callback_auto_answer | boolean |