.png?sv=2022-11-02&spr=https&st=2025-12-23T17%3A28%3A59Z&se=2025-12-23T17%3A38%3A59Z&sr=c&sp=r&sig=pb5DI3b6rLmb3SacEZowf7Jl0iCtRXmNJNMy9etlLtY%3D){kind=logo}
Set DNC
- DarkLight
Set DNC
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The SetDNC API helps an Agent mark a contact as Do Not Call (DNC).
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 | SetDNC |
source | «app-name-broadcasting-this-message» |
data | N/A |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
AccountNumber | Yes | String | The LCM Key. |
OutcomeID | Yes | Number | The outcome ID for the DNC outcome. |
CampaignSpecificDNC | No | Boolean | If agent sets DNC for a specific Campaign, flag is set to true. |
isPhoneNoDNC | No | Boolean | If the phone number is set as DNC, this value is set to true. |
BussfldDNCValue | No | String | Use this to set a business field value as DNC. |
BussfldDNCValue1 | No | String | When using multiple business field values ot set DNC, use this secondary business field value. |
BlockedBy | No | String | Indicates if the DNC is by phone number or a business field value. |
DNCBlockStartDate | No | String | The start date from which a number is marked as DNC. Format is DD/MM/YYYY and HH:mm. |
DNCBlockEndDate | No | String | The end date when a number ceases to be on the DNC list. Format is DD/MM/YYYY and HH:mm. |
AgentComments | No | String | The comments entered by the agent. |
TargetAmount | No | Number | The target achieved by the agent in the current Interaction. |
BusinessOutcome | Yes | Number | The business outcome ID as set by the agent. |
LeadScore | Yes | Number | The lead score for the contact. |
DNCCampaignCategoryID | No | String | The campaign category ID that the DNC outcome is set for. Multiple campaigns in this category are separated with commas. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetDNCResult |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | The response data. |
Response Parameters | |||
success | Yes | Boolean | The DNC update status. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetDNC",
"data":
{
"AccountNumber": "137|1|3|0|0|84|1",
"OutcomeId": 5,
"CampaignSpecificDNC": true,
"isPhoneNoDNC": true,
"BussfldDNCValue": "",
"BussfldDNCValue1": "",
"Blockedby": "PhoneNumber",
"DNCBlockStartDate": "05/11/2020 18:23",
"DNCBlockEndDate": "06/11/2020 13:45",
"AgentComments": "test",
"TargetAmount": 20,
"BusinessOutcome": 0,
"LeadScore": 0,
"DNCCampaignCategoryID": "1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetDNCResult",
"message":
{
"response":
{
"success": true
}
}
}Was this article helpful?