.png?sv=2022-11-02&spr=https&st=2025-06-07T23%3A31%3A24Z&se=2025-06-07T23%3A41%3A24Z&sr=c&sp=r&sig=gGMEGTHfO08KdBBANEJx4H7%2FhJEtTLc3Kki9y18KGUQ%3D){kind=logo}
Get Campaigns for MCD Request
- DarkLight
Get Campaigns for MCD Request
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCampaignsForMCDRequest API helps an Agent search for Open Contacts across campaigns based on a phone number and/or a business field. Using this, an agent can set the business / telephony disposition without dialling the same contact in other campaigns.
Pre-requisite
The agent must be logged in to the application.
Sequence Diagram
.jpg?sv=2022-11-02&spr=https&st=2025-06-07T23%3A31%3A24Z&se=2025-06-07T23%3A41%3A24Z&sr=c&sp=r&sig=PhzvF0NOsGQOcCnEu0hIi7xTmsaZhlP7zuCYF7A9N0g%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCampaignsForMCDRequest |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
ANI | Yes | Number | ANI or Dialed Number. |
DNIS | No | String | Call variable DNIS. |
LCMKey | No | String | LCMKey - a unique ID created during call attempt / delivery to the dialer. |
CallType | Yes | String | The call type - possible values are INBOUND or OUTBOUND. |
BusinessFieldQueryToSearch | No | String | The API searches the unique business field in different campaigns to show the other campaigns where this contact is available. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCampaignsForMCDResponse |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignId | Yes | String | The campaign ID. |
CampaignName | No | String | The campaign name. |
ContactID | No | Number | The contact ID for this contact. |
CallType | No | String | The call type - regular call, normal Callback, or personal callback. |
AgentID | No | String | The agent ID of the agent handling this call. |
Mode | No | String | The mode on which the call is dialed. |
PhoneNo | No | String | The phone number of the contact. |
AccountNumber | No | String | LCMKey is a unique ID created during call attempt/delivery to the Acqueon Dialer. This unique ID is traversed as a reference ID to the agent desktop or IVR applications. |
LastOutcome | No | String | |
LeadScore | No | String | The Lead Score for this contact. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetCampaignsForMCDRequest",
"data":
{
"ANI": "919500610256",
"DNIS": "",
"LCMKey": "",
"CallType": "INBOUND",
"BusinessFieldQueryToSearch": "",
"callid": ""
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetCampaignsForMCDResponse",
"message":
{
"response":
[
{
"CampaignId": 550,
"CampaignName": "mcdPrVwCgn",
"ContactID": 34,
"CallType": "Regular",
"AgentID": "",
"Mode": "Mobile",
"PhoneNo": "919500610256",
"AccountNumber": "34|3|550|0|0|44|59",
"LastOutcome": "",
"LeadScore": "0"
},
{
"CampaignId": 550,
"CampaignName": "mcdPrVwCgn",
"ContactID": 36,
"CallType": "Regular",
"AgentID": "",
"Mode": "Mobile",
"PhoneNo": "919500610256",
"AccountNumber": "36|3|550|0|0|44|59",
"LastOutcome": "",
"LeadScore": "0"
}
]
}
}Was this article helpful?