.png?sv=2022-11-02&spr=https&st=2025-06-07T13%3A53%3A53Z&se=2025-06-07T14%3A03%3A53Z&sr=c&sp=r&sig=4MWMGVmMflIXemXKtQaCXq%2FMMtSeLGLPwkmROpiYG%2FU%3D){kind=logo}
Get Campaign Modes
- DarkLight
Get Campaign Modes
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCampaignModes API provides the list of mode IDs (for example, Home, Office, or Mobile) and the descriptions for a specific Campaign.
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCampaignModes |
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 | CampaignModes |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Campaign modes data. |
Response Parameters | |||
ModeID | Yes | String | Mode ID. |
Description | Yes | String | Mode name. |
ChannelType | NA | NA | NA |
MinLength | NA | NA | NA |
MaxLength | NA | NA | NA |
Cvalue | Yes | String | The current mode value - phone number. |
PEWC | NA | NA | NA |
CampaignPEWC | NA | NA | NA |
Possible Error Cases
Error Type | Actual Error | Message |
|---|---|---|
WS_Error | Callid is empty | Invalid Call ID. |
WS_Error | Invalid Call ID:<call_id> | Invalid Call ID. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetCampaignModes",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "CampaignModes",
"message": {
"callid": "12345",
"response": [
{
"ModeID": "1",
"Description": "Home",
"ChannelType": "2",
"MinLength": "8",
"MaxLength": "12",
"Cvalue": null,
"PEWC": false,
"CampaignPEWC": false
},
{
"ModeID": "2",
"Description": "Office",
"ChannelType": "2",
"MinLength": "8",
"MaxLength": "12",
"Cvalue": null,
"PEWC": false,
"CampaignPEWC": false
},
{
"ModeID": "3",
"Description": "Mobile",
"ChannelType": "2",
"MinLength": "8",
"MaxLength": "12",
"Cvalue": null,
"PEWC": false,
"CampaignPEWC": false
}
]
}
}Was this article helpful?