.png?sv=2022-11-02&spr=https&st=2025-06-16T12%3A37%3A55Z&se=2025-06-16T12%3A47%3A55Z&sr=c&sp=r&sig=9emgejQjmwgMijQbpUV5DXGQ0dRfDbkemsgasB8Y%2Fvo%3D){kind=logo}
Add Compliance
- DarkLight
Add Compliance
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The API is used to import new set of DNC contact number. This imported set updates the DNC table.
Pre-requisite
The agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
Channel | LCM |
Topic | WebService |
subtopic | AddCompliance |
Source | <<app-name-broadcasting-this-message>> |
Data | N/A |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CValue | Yes | String | Value to be marked as DNC |
ChannelType | Yes | String | Channel Description. The hardcoded value is VOICE. |
UploadType | Yes | String | Type of upload. The hardcoded value is DNC. |
Operation | Yes | String | Type of Operation. The hardcoded value is Append. |
Campaign | No | String | Name of the campaign to insert the DNC contact number. |
CampaignCategory | No | String | Name of the campaign category to insert the DNC contact number. |
CallbackModeID | No | Number | Mode ID (in numeric). |
StartDate | No | String | DNC Start date in the dd/mm/yyyy HH:MM format. |
EndDate | No | String | DNC End date in the dd/mm/yyyy HH:MM format. |
IsBusinessFieldDNC | No | Boolean | This determines if the contact is marked as DNC based on a business field. |
Response Parameters | Value |
|---|---|
Channel | LCM |
Topic | WebService |
subtopic | AddComplianceResponse |
Message | <<JSON Object>> |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Response | Yes | JSON Object | Response Data |
Response Parameters | |||
Response | Yes | String | Update status |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": " AddCompliance ",
"data":
{
"Cvalue" : "2020”,
"Campaign" : "",
"CampaignCategory" : "",
"Startdate" : "07/09/2020 07:33",
"EndDate" : "08/09/2021 07:33",
"ChannelType" : "VOICE",
"UploadType" : "DNC",
"Operation" : "Append”,
"IsBusinessFieldDNC" : false
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": " AddComplianceResponse",
"message":
{
"response": “true”/”false”
}
}Was this article helpful?