post https://api.talkdeskapp.com/campaigns
Scopes
campaigns:read
campaigns:write
Request Body - Example
{
"name": "50% discount on culinary courses",
"dialing_mode": "PREDICTIVE",
"priority": 5,
"dialing_mode_configuration": {
"answering_machine_detection": false,
"amd_metadata": false,
"max_abandonment_rate": 2,
"max_dialing_ratio": 3,
"max_ring_time_in_secs": 6,
"abandonment_timeout": {
"amount": 14
}
},
"dialing_strategy": {
"max_skip_attempts": 4,
"strategy_type": "AUTOMATIC",
"preview_timeout": 100,
"max_attempts": 99,
"retry_period": 100,
"retry_time_unit": "SECONDS",
"calling_hours": [
{
"from": "01:00:00",
"to": "02:00:00",
"week_days": [
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
}
],
"dispositions": {
"busy": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"no_answer": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"abandoned": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"hangup_before_connection": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"agent_hangup_before_connection": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"answering_machine_detection": {
"status_after_call": "RETRY",
"custom": false,
"max_attempts": 45,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
"invalid_number": {
"status_after_call": "FINAL"
}
},
"record_chain": [
{
"type": "HOME",
"max_attempts": 5,
"retry_period": 300,
"retry_period_time_unit": "MINUTES"
},
{
"type": "OFFICE",
"max_attempts": 3,
"retry_period": 123,
"retry_period_time_unit": "SECONDS"
},
{
"type": "MOBILE",
"max_attempts": 2,
"retry_period": 213,
"retry_period_time_unit": "SECONDS"
},
{
"type": "EXTRA_1",
"max_attempts": 2,
"retry_period": 213,
"retry_period_time_unit": "SECONDS"
},
{
"type": "EXTRA_2",
"max_attempts": 2,
"retry_period": 213,
"retry_period_time_unit": "SECONDS"
},
{
"type": "EXTRA_3",
"max_attempts": 2,
"retry_period": 213,
"retry_period_time_unit": "SECONDS"
}
],
"ivr_enabled": true,
"lists_sorting_criteria": "FIFO"
}
}
Body Response - Schema
201 (campaign created successfully)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _links | object | HAL API related links. "_links" subdivides into: 1 - "self" (object) - link to fetch the detail of the campaign. 1.1 - "href" (string) - address of the resource. <= 2083 characters. Required. 2 - "campaigns" (object) - link to fetch a list of all the campaigns. 2.1 - "href" (string) - address of the resources. <= 2083 characters. Required. | yes |
| id | string | <= 36 characters | yes |
| name | string | >= 3 characters <= 35 characters | yes |
| dialing_mode | string | <= 35 characters. Allowed values: "PREDICTIVE", "PREVIEW" | no |
| priority | integer | >= 1 <= 10 | no |
| run_once | boolean | n/a | no |
| action_required | boolean | n/a | no |
| status | string | <= 35 characters. Allowed values: "INCOMPLETE", "READY", "RUNNING", "PAUSED" | no |
| dialing_mode_configuration | object | "dialing_mode_configuration" subdivides into: 1 - "answering_machine_detection" (boolean) - the flag to decide if disconnects calls that reach answering machines or voicemails. Only to be used in Predictive mode. 2 - "amd_metadata" (boolean) - the flag to decide if an additional in-house AMD layer based on Metadata will improve the initial AMD decision in Dialer. Only to be used in Predictive mode. 3 - "max_abandonment_rate" (integer) - maximum rate of abandoned calls. Only to be used in Predictive mode. >= 1 <= 100 4 - "max_dialing_ratio " (integer) - maximum number of calls launched per agent. Only to be used in Predictive mode. >= 1 <= 3 5 - "max_ring_time_in_secs " (integer) - the time in which calls are disconnected if they are not answered. >= 6 <= 120. Required. 6 - "abandonment_timeout" (object) 6.1 - "amount" (integer) - the time in which automatically hangs up answered calls that haven't been connected to an agent. Unit in seconds. Only to be used in Predictive mode. >= 2 <= 30 Required. | no |
| dialing_strategy | object | "dialing_strategy" subdivides into: 1 - "max_skip_attempts" (integer) - the maximum number of times that an agent can skip a call. >= 0 <= 20 2 - "strategy_type" (string) - the strategy on how the records will be dialed. <= 35 characters Allowed values: "AUTOMATIC", "MANUAL" 3 - "preview_timeout" (integer) - the time in seconds that the preview context will be available to the agent. >= 6 <= 300 4 - "max_attempts" (integer) - the maximum number of non-final call attempts each record may receive. >= 1 <= 100. Required. 5 - "retry_period" (integer) - time between non-final call attempts. >= 1 <= 2592000. Required. 6 - "retry_time_unit" (string) - the time unit for the retry_period. <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". Required. 7 - "calling_hours" (array[object]) - set of rules to be applied based on location of the records lists. Required. 7.1 - "from" (string - start time format hh:MM:ss <= 8 characters. Required. 7.2 - "to" (string - end time format hh:MM:ss <= 8 characters. Required. 7.3 - "week_days" (array[string]) - Allowed values: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY". Required. 8 - "dispositions (object) - system dispositions to be available for defined campaign. Required. 8.1 - "busy (object) - busy disposition settings. Required. 8.1.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.1.2 - "custom (boolean) - required. 8.1.3 - "max_attempts (integer) - >= 1; <= 100. 8.1.4 - "retry_period (integer) - >= 1; <= 2592000. 8.1.5 - "retry_period_time_unit (integer) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.2 - "no_answer (object) - no_answer disposition settings. Required. 8.2.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.2.2 - "custom (boolean) - required. 8.2.3 - "max_attempts (integer) - >= 1; <= 100. 8.2.4 - "retry_period (integer) - >= 1; <= 2592000. 8.2.5 - "retry_period_time_unit (integer) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.3 - "abandoned (object) - abandonment disposition settings. 8.3.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.3.2 - "custom (boolean) - required. 8.3.3 - "max_attempts (integer) - >= 1; <= 100. 8.3.4 - "retry_period (integer) - >= 1; <= 2592000. 8.3.5 - "retry_period_time_unit (integer) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.4 - "hangup_before_connection (object) - hangup_before_connection disposition settings. 8.4.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.4.2 - "custom (boolean) - required. 8.4.3 - "max_attempts (integer) - >= 1; <= 100. 8.4.4 - "retry_period (integer) - >= 1; <= 2592000. 8.4.5 - "retry_period_time_unit (string) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.5 - "agent_hangup_before_connection (object) - agent_hangup_before_connection disposition settings. 8.5.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.5.2 - "custom (boolean) - required. 8.5.3 - "max_attempts (integer) - >= 1; <= 100. 8.5.4 - "retry_period (integer) - >= 1; <= 2592000. 8.5.5 - "retry_period_time_unit (string) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.6 - "answering_machine_detection (object) - answering_machine_detection disposition settings. 8.6.1 - "status_after_call (string) - <= 35 characters. Allowed values: "FINAL", "RETRY". Required. 8.6.2 - "custom (boolean) - required. 8.6.3 - "max_attempts (integer) - >= 1; <= 100. 8.6.4 - "retry_period (integer) - >= 1; <= 2592000. 8.6.5 - "retry_period_time_unit (string) - <= 35 characters. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 8.7 - "invalid_number (object) - invalid_number disposition setting. Required. 8.7.1 - "status_after_call (string) - <= 35 characters. Allowed value: "FINAL". Required. 9 - "record_chain (array[object]) -set of rules to be applied based on the phone type. Must have exactly one of each phone type. 9.1 - "type (string) - phone type. Allowed values: "HOME", "OFFICE", "MOBILE", "EXTRA_1", "EXTRA_2" "EXTRA_3". Required. 9.2 - "max_attempts (integer) - >= 1; <= 100. Required. 9.3 - "retry_period (integer) - >= 1; <= 2592000. 9.4 - "retry_period_time_unit (string) - the time unit for the retry_period. Allowed values: "SECONDS", "MINUTES", "HOURS", "DAYS". 10 - "lists_sorting_criteria (string) - the configuration of how the records will be sorted. <= 10 characters. Allowed values: "FIFO", "LIFO". | no |
| created_at | string | n/a | no |
400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Campaign Management API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.The Campaign Management APII has been in EA since November 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.