Get All Campaign Details
- DarkLight
Get All Campaign Details
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetAllCampaignDetails API returns all campaign-related details.
Pre-requisite
The agent must be on an active call or logged in to the application.
Sequence Diagram
.png?sv=2022-11-02&spr=https&st=2026-04-24T02%3A57%3A48Z&se=2026-04-24T03%3A07%3A48Z&sr=c&sp=r&sig=yqOirT%2BIu5RwrkC%2BrQ%2Fb7rAY8iFVmkoUQ4sgFmDVYU0%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | GetAllCampaignDetails |
data | <<JSON Object>> |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The Call ID generated by the application. |
AccountNumber | Yes | String | The LCM Key. |
isOfflineTransaction | Yes | Boolean | Indicates whether the transaction is processed in offline mode (true) or online mode (false). |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | AllCampaignDetails |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | Response data. |
Response Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
RuntimeScheduling | No | String | The message specifies the campaign run times for a specific day. |
ContactModeScheduling | No | String | The message specifies the times and days of the week for the Contact Strategy to be used for dialing. |
Holiday | No | String | The message specifies the campaign holidays. |
BusinessOutcomeDetails | No | String | The message specifies the business outcome details of the campaign. |
CampaignKeyFields | No | String | The message specifies the key fields in the campaign. |
CategoryDetails | No | String | The message specifies the campaign categories. |
Contact Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignKey | Yes | String | The campaign key for the campaign. |
CampaignName | Yes | String | Name of the campaign. |
GroupName | Yes | String | Name of the group to which the campaign belongs. |
CampaignDesc | Yes | String | Description of the campaign. |
CampaignStartDate | Yes | String | Date and time when the campaign becomes active. |
CampaignEndDate | Yes | String | Date and time when the campaign ends. |
CampaignStartTime | Yes | String | Start time of the campaign activity. |
CampaignEndTime | Yes | String | End time of the campaign activity. |
CampaignTimeZone | Yes | String | Time zone configured for the campaign. |
CampaignExecuteTimeZone | Yes | String | Time zone in which the campaign executes. |
Runtime Scheduling Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Date | Yes | String | The scheduled date for the campaign runtime. |
StartTime | Yes | String | The start date and time of the campaign for the scheduled date. |
EndTime | Yes | String | The end date and time of the campaign for the scheduled date. |
Contact Mode Scheduling Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Days | Yes | String | The days of the week. |
WorkingDay | Yes | Boolean | Indicates whether the day is a working day (true) or a non-working day (false). |
TimeRange | Yes | String | The working time slots for the day. |
Holiday Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Name | Yes | String | Name/label of the holiday. |
FromDate | Yes | String | The holiday start date in DD/MM/YYYY format. |
EndDate | Yes | String | The holiday start date in DD/MM/YYYY format. |
Business Outcome Details Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
BusinessOutcomeID | Yes | String | The business outcome ID. |
BusinessOutcomeName | Yes | String | Name of the business outcome. |
ParentOutcomeID | Yes | String | The Parent Outcome ID. |
ParentOutcomeName | Yes | String | Name of the parent outcome. |
Leadscore | No | Number | The lead score for the contact at the time of upload or at agent ACW. |
Campaign Key fields Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
FName | Yes | String | First name of the contact associated with the campaign. |
LName | No | String | Last name of the contact associated with the campaign. |
Category Details Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignCategoryID | Yes | String | The campaign category ID. |
CampaignCategoryName | Yes | String | The campaign category name. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetAllCampaignDetails",
"data": {
"callid": "27|1|4|0|0|44|274",
"AccountNumber": "27|1|4|0|0|44|274",
"isOfflineTransaction": false
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "AllCampaignDetails",
"message": {
"response": [
{
"CampaignKey": 4,
"CampaignName": "John",
"GroupName": "Manual",
"CampaignDesc": "Copied from Priya-Teth-camp",
"CampaignStartDate": "9/2/2025, 1:59:00 PM",
"CampaignEndDate": "10/31/2025, 11:59:00 PM",
"CampaignStartTime": "9/2/2025, 1:59:00 PM",
"CampaignEndTime": "10/31/2025, 11:59:00 PM",
"CampaignTimeZone": "(UTC) Coordinated Universal Time",
"CampaignExecuteTimeZone": "(UTC) Coordinated Universal Time",
"RuntimeScheduling": [
{
"Date": "9/16/2025",
"StartTime": "9/16/2025 12:00:00 AM",
"EndTime": "9/16/2025 11:59:00 PM"
}
],
"ContactModeScheduling": [
{
"Days": "Monday",
"WorkingDay": true,
"TimeRange": null
},
{
"Days": "Tuesday",
"WorkingDay": true,
"TimeRange": null
},
{
"Days": "Wednesday",
"WorkingDay": true,
"TimeRange": {
"Slot1": "00:00 - 23:59",
"Slot2": null,
"Slot3": null
}
},
{
"Days": "Thursday",
"WorkingDay": true,
"TimeRange": {
"Slot1": "00:00 - 23:59",
"Slot2": null,
"Slot3": null
}
},
{
"Days": "Friday",
"WorkingDay": true,
"TimeRange": {
"Slot1": "00:00 - 23:59",
"Slot2": null,
"Slot3": null
}
},
{
"Days": "Saturday",
"WorkingDay": false,
"TimeRange": null
},
{
"Days": "Sunday",
"WorkingDay": false,
"TimeRange": null
}
],
"Holiday": [
{
"Name": "OFF",
"FromDate": "9/13/2025 12:00:00 AM",
"EndDate": "9/14/2025 12:00:00 AM"
}
],
"CallGuideName": "John",
"BusinessOutcomeName": "Dev",
"BusinessOutcomeDetails": [
{
"BusinessOutcomeID": 101,
"BusinessOutcomeName": "success",
"ParentOutcomeID": 2,
"ParentOutcomeName": "Bank",
"Leadscore": 0
},
{
"BusinessOutcomeID": 102,
"BusinessOutcomeName": "failure",
"ParentOutcomeID": 2,
"ParentOutcomeName": "Bank",
"Leadscore": 0
},
{
"BusinessOutcomeID": 103,
"BusinessOutcomeName": "Dev-success",
"ParentOutcomeID": 3,
"ParentOutcomeName": "ADDev",
"Leadscore": 0
},
{
"BusinessOutcomeID": 104,
"BusinessOutcomeName": "Dev-failure",
"ParentOutcomeID": 3,
"ParentOutcomeName": "ADDev",
"Leadscore": 0
},
{
"BusinessOutcomeID": 105,
"BusinessOutcomeName": "work-success",
"ParentOutcomeID": 4,
"ParentOutcomeName": "WorkTest",
"Leadscore": 0
},
{
"BusinessOutcomeID": 106,
"BusinessOutcomeName": "work-failure",
"ParentOutcomeID": 4,
"ParentOutcomeName": "WorkTest",
"Leadscore": 0
}
],
"CampaignKeyFields": [
"FName",
"LName"
],
"CategoryDetails": [
{
"CampaignCategoryID": 1,
"CampaignCategoryName": "Collection"
}
]
}
]
}
}
Was this article helpful?