> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.app/llms.txt
> Use this file to discover all available pages before exploring further.
# Create Voice Campaign API - Progressive Mode
[Back to API List](/ai-for-service/apis/contact-center/api-list)
Use this API to create a voice campaign with Progressive dialing mode that routes answered calls to live agents via a queue.
| **Method** | POST |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| **Endpoint** | `https://{{host}}/agentassist/api/v1/public/{{IId}}/campaign?campaignType=voice` |
| **Content-Type** | `application/json` |
| **Authorization** | `auth: {{JWT}}` See [How to generate the JWT Token](/ai-for-service/apis/automation/api-introduction#generating-the-jwt-token) |
| **API Scope** | Campaign Management |
## Path Parameters
| **Parameter** | **Description** | **Type** |
| ------------- | -------------------------------------------------------- | ---------------- |
| `host` | Environment URL, for example, `https://platform.kore.ai` | string, required |
| `IId` | The Application ID. | string, required |
## Query Parameter
| **Parameter** | **Description** | **Type** |
| -------------- | ----------------------------- | ---------------- |
| `campaignType` | Type of campaign. Use `"sms"` | string, required |
## Sample Request
```
curl --location 'https://{{host}}/agentassist/api/v1/public/{{botId}}/campaign?campaignType=voice' \
--header 'auth: ' \
--header 'Content-Type: application/json' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14b9xxxx' \
--header 'accountId: 67777ce93e25326494e9xxxx' \
--data '{
"name": "Service Renewal Outreach Campaign",
"description": "Connects customers with live agents to assist with upcoming service renewals using progressive dialing. Ensures personalized support and improved engagement.",
"contactLists": [
"Recent Buyers - Q2 2025"
],
"priority": "5",
"dialingMode": "Progressive",
"dialingStrategy": {
"callerId": {
"phoneNumber": "+1812345678"
},
"callingHours": {
"frequency": "WEEKLY",
"timezone": "Asia/Kolkata",
"days": [
{
"day": "MO",
"start": "9:00 AM",
"end": "6:00 PM"
},
{
"day": "TU",
"start": "9:00 AM",
"end": "6:00 PM"
},
{
"day": "WE",
"start": "9:00 AM",
"end": "6:00 PM"
},
{
"day": "TH",
"start": "9:00 AM",
"end": "6:00 PM"
},
{
"day": "FR",
"start": "9:00 AM",
"end": "6:00 PM"
}
]
},
"dialingOrder": "FIFO",
"maxAttemptsPerRecord": 3,
"defaultRetryPeriod": 10,
"maxRingTime": 30
},
"schedule": {
"isSchedulingEnabled": false
},
"queue_name": "Default Queue",
"enableMachineDetect": false,
"campaignType": "voice"
}'
```
## Headers
| **Header** | **Description** | **Required/Optional** |
| ----------- | ----------------------------- | --------------------- |
| `auth` | JWT token for authentication. | required |
| `iid` | The Application Id. | required |
| `accountId` | The Account Id. | required |
## Body Parameters
| **Parameter** | **Description** | **Type** |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
| `name` | Name of the campaign. Used to identify it in the Platform. The name must be a maximum of 48 characters. | string, required |
| `description` | Description of the campaign's purpose. Helps teams understand the goal. The description must be a maximum of 256 characters. | string, required |
| `contactLists` | List of contact list names to be dialed. Must exist in the system. At least one contact list name is required. | array\[string], required |
| `priority` | Campaign priority. Higher values indicate higher execution priority. Priority must be one of the following: 1, 2, 3, 4, or 5. | string, required |
| `dialingMode` | Dialing mode defines how calls are handled. Valid values are: Agentless, Progressive, or Preview. | string, required |
| `dialingStrategy.callerId.phoneNumber` | Caller ID number shown to the recipient. Must be a verified number. | string, required |
| `dialingStrategy.callingHours.frequency` | Frequency of calling hours must be one of: WEEKLY, DAILY, or CUSTOM. | string, required |
| `dialingStrategy.callingHours.timezone` | Timezone in which calling hours are defined. | string, required |
| `dialingStrategy.callingHours.days` | List of allowed calling time blocks. Each object should include: day ('MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU'), start ("9:00 AM"), end ("6:00 PM"). You can define multiple entries to cover different days and time slots. | array\[object], required |
| `dialingStrategy.dialingOrder` | Order in which contacts are dialed: First In First Out (FIFO), Last In First Out (LIFO), etc. | string, required |
| `dialingStrategy.maxAttemptsPerRecord` | Maximum number of call attempts per contact. Minimum is 1 and maximum is 100. | number, required |
| `dialingStrategy.defaultRetryPeriod` | Time (in minutes) to wait between retries. Must be between 1 and 1440. | number, required |
| `dialingStrategy.maxRingTime` | Max time (in seconds) the phone should ring before disconnecting. Must be between 5 and 120. | number, required |
| `queue_name` | Name of the agent queue used to route calls when agents are needed. Required for Progressive dialing. | string, required |
| `enableMachineDetect` | Enables detection of answering machines/voicemail. Valid values are true or false. | boolean, required |
| `campaignType` | Type of campaign. Must be either voice or sms. | string, required |
## Sample Response
```
{
"status": "success",
"message": "Campaign Service Renewal Outreach Campaign creation in progress",
"data": {
"name": "Service Renewal Outreach Campaign",
"lname": "service renewal outreach campaign",
"description": "Connects customers with live agents to assist with upcoming service renewals using progressive dialing. Ensures personalized support and improved engagement.",
"priority": "5",
"dialingMode": "Progressive",
"dialingStrategy": {
"callerId": {
"phoneNumber": "+1812345678"
},
"callingHours": {
"frequency": "WEEKLY",
"days": [
{
"start": "9:00 AM",
"end": "6:00 PM",
"day": "MO"
},
{
"start": "9:00 AM",
"end": "6:00 PM",
"day": "TU"
},
{
"start": "9:00 AM",
"end": "6:00 PM",
"day": "WE"
},
{
"start": "9:00 AM",
"end": "6:00 PM",
"day": "TH"
},
{
"start": "9:00 AM",
"end": "6:00 PM",
"day": "FR"
}
],
"timezone": "Asia/Kolkata"
},
"dialingOrder": "FIFO",
"maxAttemptsPerRecord": 3,
"defaultRetryPeriod": 10,
"maxRingTime": 30
},
"status": "Preparing",
"createdAt": "2025-06-26T10:44:10.322Z",
"updatedAt": "2025-06-26T10:44:10.322Z",
"id": "cd-26d3ec6-e1ec-4abd-a21c-3109795exxxx",
"contactLists": [
"Recent Buyers - Q2 2025"
],
"enableMachineDetect": false
}
}
```
## Response Body Parameters
| **Parameter** | **Description** | **Type** |
| ------------------------------------------------ | ----------------------------------------------------------------- | --------------- |
| `status` | Indicates the overall response status. Example: `"success"` | string |
| `message` | Descriptive message about the result. | string |
| `data` | Contains the campaign configuration details. | object |
| `data.name` | Display name of the campaign. | string |
| `data.lname` | Lowercase name of the campaign, used internally. | string |
| `data.description` | Description of the campaign purpose and functionality. | string |
| `data.priority` | Campaign priority level. | string |
| `data.dialingMode` | Dialing mode used for the campaign. Example: `"Progressive"` | string |
| `data.dialingStrategy` | Defines dialing strategy configuration. | object |
| `data.dialingStrategy.callerId.phoneNumber` | Caller ID phone number used for outbound calls. | string |
| `data.dialingStrategy.callingHours` | Defines the allowed calling hours and schedule. | object |
| `data.dialingStrategy.callingHours.frequency` | Calling frequency. Example: `"WEEKLY"` | string |
| `data.dialingStrategy.callingHours.days` | Daily schedules with start/end time and day. | array of object |
| `data.dialingStrategy.callingHours.days[].start` | Start time of calling window. (hh:mm AM/PM) | string |
| `data.dialingStrategy.callingHours.days[].end` | End time of calling window. (hh:mm AM/PM) | string |
| `data.dialingStrategy.callingHours.days[].day` | Day of the week. (2-letter) Example: `"MO"`, `"TU"` | string |
| `data.dialingStrategy.callingHours.timezone` | Timezone used for the calling schedule. Example: `"Asia/Kolkata"` | string |
| `data.dialingStrategy.dialingOrder` | Order in which records are dialed. Example: `"FIFO"` | string |
| `data.dialingStrategy.maxAttemptsPerRecord` | Maximum retry attempts for each record. | integer |
| `data.dialingStrategy.defaultRetryPeriod` | Default wait time between retries. (minutes) | integer |
| `data.dialingStrategy.maxRingTime` | Maximum ring time before hanging up. (seconds) | integer |
| `data.status` | Current state of the campaign. Example: `"Preparing"` | string |
| `data.createdAt` | Campaign creation timestamp. (ISO 8601) | string |
| `data.updatedAt` | Last updated timestamp. (ISO 8601) | string |
| `data.id` | Unique identifier for the campaign. | string |
| `data.contactLists` | Names of associated contact lists. | array of string |
| `data.enableMachineDetect` | Indicates whether machine detection is enabled. | boolean |