Get Campaign Categories
- DarkLight
Get Campaign Categories
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCampaignCategories API fetches campaign categories that can be associated to a DNC request.
Pre-requisite
The Agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCampaignCategory |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | LCM Key. |
Response Parameters | Value |
---|---|
channel | LCM |
topic | Webservice |
subtopic | CampaignCategory |
message | «JSON Object» |
Message 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": "GetCampaignCategory"
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "CampaignCategory",
"message":
[
{
"CampaignCategoryID": 1,
"CampaignCategoryName": "Collection"
},
{
"CampaignCategoryID": 2,
"CampaignCategoryName": "Sales"
}
]
}
Was this article helpful?