| Method | GET |
|---|---|
| Endpoint | https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}} |
| Content-Type | application/json |
| Authorization | auth: {{JWT}} See How to generate the JWT Token. |
| API Scope | Campaign Management |
Path Parameters
| Parameter | Description | Type |
|---|---|---|
host | Environment URL, for example, https://platform.kore.ai | string, required |
streamId | Bot ID or Stream ID. You can get it from the general settings page. | string, required |
campaignId | Unique ID of the campaign to be updated. For example: cd-ed19e3c7-3682-5e72-a839-af9e0711xxxx | string, required |
Sample Request
curl --location 'https://{{host}}/campaign/api/v2/public/{{streamId}}/campaign/{{campaignId}}?accountId={{accountId}}' \
--header 'iid: st-0603182c-7ffb-53c3-b307-47ca14bxxxxx' \
--header 'accountId: 67777ce93e25326494exxxxx' \
--header 'auth: <token>'
Headers
| Header | Description | Required/Optional |
|---|---|---|
auth | JWT token for authentication. | required |
iid | The Application Id. | required |
accountId | The Account Id. | required |
Sample Response
{
"status": "success",
"message": "Campaign Product Feedback Voice Campaign-3.41 retrieved successfully",
"data": {
"_id": "cd-9e14b72-88cc-4544-9a98-7aee9b7xxxxx",
"name": "Product Feedback Voice Campaign-3.41",
"lname": "product feedback voice campaign-3.41",
"description": "This voice campaign collects quick feedback on recent purchases.",
"dncLists": {
"id": "cl-68b802a-2b99-4245-8eea-6d322a8xxxxx",
"name": "DNC CL Dec 4"
},
"priority": "5",
"dialingMode": "Agentless",
"dialingStrategy": {
"callerId": { "phoneNumber": "+148465xxxxx" },
"callingHours": {
"frequency": "WEEKLY",
"timezone": "Asia/Kolkata",
"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" }
]
},
"dialingOrder": "FIFO",
"maxAttemptsPerRecord": 3,
"defaultRetryPeriod": 10,
"maxRingTime": 30,
"useSystemMappings": false
},
"experienceFlow": "cf-ecfa3927-eabc-52c4-8373-8a0b75dxxxxx",
"status": "Ready",
"createdAt": "2025-12-08T05:29:38.298Z",
"updatedAt": "2025-12-08T05:32:10.977Z",
"schedule": {
"isSchedulingEnabled": false,
"isRecurrenceEnabled": false
},
"contactLists": ["CL Only 2020 Dec 4"]
}
}
Response Parameters
| Parameter | Description | Type |
|---|---|---|
status | Overall status of the API response. Example: "success" | string |
message | Response message indicating the result of the request. | string |
data | Contains the campaign details. | object |
data._id | Unique identifier of the campaign. | string |
data.name | Campaign name (title-cased). | string |
data.lname | Lowercased campaign name. | string |
data.description | Detailed description of the campaign purpose and behavior. | string |
data.dncLists | Contains the contact lists added under the Do Not Call (DNC) list. | object |
data.dncLists.id | Unique identifier of the contact list in the DNC list. | string (UUID) |
data.dncLists.name | The name of the contact list included in the DNC list. | string |
data.status | Current status of the campaign. Example: "Ready" | string |
data.priority | Priority level assigned to the campaign. | string |
data.dialingStrategy | Configuration for dialing or communication strategy. | object |
data.dialingStrategy.callerId.phoneNumber | Phone number used as the caller ID or sender ID. | string |
data.dialingStrategy.callingHours | Campaign’s operating schedule. | object |
data.dialingStrategy.callingHours.frequency | Frequency for running the campaign. Example: "WEEKLY" | string |
data.dialingStrategy.callingHours.timezone | Time zone for the calling hours. | string |
data.dialingStrategy.callingHours.days | Days and time range when the campaign is active. | array of object |
data.dialingStrategy.callingHours.days[].day | Day of the week when campaign runs. Example: "MO" | string |
data.dialingStrategy.callingHours.days[].start | Campaign start time for the day. (HH:MM AM/PM) | string |
data.dialingStrategy.callingHours.days[].end | Campaign end time for the day. (HH:MM AM/PM) | string |
data.experienceFlow | Associated experience flow ID used by the campaign. | string |
data.createdAt | Timestamp when the campaign was created. (ISO 8601) | string |
data.updatedAt | Timestamp when the campaign was last updated. (ISO 8601) | string |
data.schedule | Scheduling configuration for the campaign. | object |
data.schedule.isSchedulingEnabled | Indicates whether the campaign has a scheduled start. | boolean |
data.schedule.isRecurrenceEnabled | Indicates whether recurrence is enabled. | boolean |
data.contactLists | Names of contact lists associated with the campaign. | array of string |
data.format | Format of the campaign configuration. Example: "advanced" | string |