.png?sv=2022-11-02&spr=https&st=2025-06-07T03%3A24%3A08Z&se=2025-06-07T03%3A34%3A08Z&sr=c&sp=r&sig=BauM0A%2BUda8culCf6fZG2nC7ZQK4jaU8lzA9i4B5v80%3D){kind=logo}
Get Campaign Groups
- DarkLight
Get Campaign Groups
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCampaignGroups API retrieves a list of campaign groups to get the manual dial contacts.
Pre-requisite
The Agent must be logged in to the application.
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCampaignGroups |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
UserID | No | String | Agent ID. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCampaignGroup |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignGroups | Yes | JSON Array | Campaign group data. |
Campaign Group Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Name | Yes | JSON Array | Campaign group name. |
Type | Yes | String | Campaign group type. |
Status | Yes | String | Campaign group status. |
Campaigns | Yes | JSON Array | The campaigns mapped to this group. |
Agents | No | JSON Array | The agents mapped to this campaign group. |
Campaign Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
ID | Yes | String | Campaign ID. |
PCT | Yes | String | The percentage of contacts dialed out from each campaign in this group. |
Status | Yes | String | Campaign status. |
Agent Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
ID | Yes | String | Agent ID. |
Name | Yes | String | Agent user name. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetCampaignGroups",
"data": {
"userID": "[email protected]"
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetCampaignGroup",
"message": {
"response": {
"CampaignGroups": [
{
"Name": "AESprint_AmzQueue1",
"Type": "VOICE",
"Status": "EXECUTING",
"Campaigns": [
{
"ID": "testcamp",
"Pct": "100",
"Status": "GROUP DISABLED"
}
],
"Agents": null
},
{
"Name": "eMail-Group",
"Type": "DIGITAL",
"Status": "EXECUTING",
"Campaigns": [
{
"ID": "testdigi",
"Pct": "100",
"Status": "ELAPSED"
}
],
"Agents": null
},
{
"Name": "AD Dev Manual Group",
"Type": "MANUAL",
"Status": "EXECUTING",
"Campaigns": [
{
"ID": "AD Manual Dial Campaign",
"Pct": "100",
"Status": "EXECUTING"
}
],
"Agents": [
{
"ID": "[email protected]",
"Name": "[email protected]"
}
]
}
]
}
}
}
Was this article helpful?