Campaigns
Query outbound campaigns in the Talkdesk account.
Select
The driver uses the Talkdesk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the driver.
| Column | Supported Operators |
| Name | = |
| DialingMode | = |
| Priority | = |
| ActionRequired | = |
| Status | = |
For example, the following query is processed server-side:
SELECT * FROM Campaigns WHERE Name = 'value'
The driver pushes the ORDER BY clause to the Talkdesk API for the following columns. Sorting on any other column is performed client-side within the driver.
- Name supports the following sort directions: ASC, DESC.
- DialingMode supports the following sort directions: ASC, DESC.
- Priority supports the following sort directions: ASC, DESC.
- CreatedAt supports the following sort directions: ASC, DESC.
For example, the following query is sorted server-side:
SELECT * FROM Campaigns ORDER BY Name ASC
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the campaign. | |
| Name | String | The campaign name. | |
| DialingMode | String | The dialing mode. Allowed values: PREDICTIVE, PREVIEW. | |
| Priority | Integer | The campaign priority (1-10). | |
| RunOnce | Boolean | Whether the campaign runs only once. | |
| ActionRequired | Boolean | Whether the campaign requires action. | |
| Status | String | The campaign status. Allowed values: INCOMPLETE, READY, RUNNING, PAUSED. | |
| CreatedAt | Datetime | The campaign creation timestamp. | |
| DialingStrategyType | String | The strategy on how the records will be dialed. Allowed values: AUTOMATIC, MANUAL. | |
| DialingStrategyMaxSkipAttempts | Integer | The maximum number of times that an agent can skip a call (0-20). | |
| DialingStrategyPreviewTimeout | Integer | The time in seconds that the preview context will be available to the agent (6-300). | |
| DialingStrategyMaxAttempts | Integer | The maximum number of non-final call attempts each record may receive (1-100). | |
| DialingStrategyRetryPeriod | Integer | Time between non-final call attempts (1-2592000). | |
| DialingStrategyRetryTimeUnit | String | The time unit for the retry period. Allowed values: SECONDS, MINUTES, HOURS, DAYS. | |
| DialingStrategyListsSortingCriteria | String | The config on how the records will be sorted. Allowed values: FIFO, LIFO. | |
| DialingStrategyCallingHours | String | Set of rules to be applied based on location of the records lists. JSON array containing from, to, and week_days fields. | |
| DispositionsBusyStatusAfterCall | String | Status after a busy call. Allowed values: FINAL, RETRY. | |
| DispositionsBusyCustom | Boolean | Whether the busy disposition is custom. | |
| DispositionsBusyMaxAttempts | Integer | Maximum attempts for busy disposition (1-100). | |
| DispositionsBusyRetryPeriod | Integer | Retry period for busy disposition (1-2592000). | |
| DispositionsBusyRetryPeriodTimeUnit | String | Time unit for busy retry period. Allowed values: SECONDS, MINUTES, HOURS, DAYS. | |
| DispositionsNoAnswerStatusAfterCall | String | Status after no answer. Allowed values: FINAL, RETRY. | |
| DispositionsNoAnswerCustom | Boolean | Whether the no answer disposition is custom. | |
| DispositionsNoAnswerMaxAttempts | Integer | Maximum attempts for no answer disposition (1-100). | |
| DispositionsNoAnswerRetryPeriod | Integer | Retry period for no answer disposition (1-2592000). | |
| DispositionsNoAnswerRetryPeriodTimeUnit | String | Time unit for no answer retry period. Allowed values: SECONDS, MINUTES, HOURS, DAYS. | |
| DispositionsAbandonedStatusAfterCall | String | Status after abandoned call. Allowed values: FINAL, RETRY. | |
| DispositionsAbandonedCustom | Boolean | Whether the abandoned disposition is custom. | |
| DispositionsAbandonedMaxAttempts | Integer | Maximum attempts for abandoned disposition (1-100). | |
| DispositionsAbandonedRetryPeriod | Integer | Retry period for abandoned disposition (1-2592000). | |
| DispositionsAbandonedRetryPeriodTimeUnit | String | Time unit for abandoned retry period. Allowed values: SECONDS, MINUTES, HOURS, DAYS. | |
| DispositionsAMDStatusAfterCall | String | Status after answering machine detection. Allowed values: FINAL, RETRY. | |
| DispositionsAMDCustom | Boolean | Whether the answering machine detection disposition is custom. | |
| DispositionsAMDMaxAttempts | Integer | Maximum attempts for answering machine detection disposition (1-100). | |
| DispositionsAMDRetryPeriod | Integer | Retry period for answering machine detection disposition (1-2592000). | |
| DispositionsAMDRetryPeriodTimeUnit | String | Time unit for answering machine detection retry period. Allowed values: SECONDS, MINUTES, HOURS, DAYS. | |
| DispositionsInvalidNumberStatusAfterCall | String | Status after invalid number. Allowed values: FINAL, RETRY. | |
| DialingStrategyRecordChain | String | Set of rules to be applied based on the phone type. JSON array containing type, max_attempts, retry_period, and retry_time_unit for each phone type (HOME, OFFICE, MOBILE, EXTRA_1, EXTRA_2, EXTRA_3). |