Check Contacts
- DarkLight
Check Contacts
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetCheckContacts API checks contact records for compliance against Do Not Call, National Do Not Call, and litigation risk lists.
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
.png?sv=2022-11-02&spr=https&st=2026-04-24T09%3A35%3A20Z&se=2026-04-24T09%3A45%3A20Z&sr=c&sp=r&sig=HXuVsJmVw7ZL6zt7FkYb6p2ihy%2FVRKRZbwpd1kvQzsU%3D)
Message Structure
Request Parameter | Value | |
|---|---|---|
Channel | LCM | |
topic | Webservice | |
subtopic | GetCheckContacts | |
data | JSON object | |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
campaignname | Yes | Array of strings | List of campaign names associated with the request. |
categoryname | No | Array of strings | List of category names associated with the request. |
dncStartDate | No | datetime | Optional. Start date for DNC validation. If omitted, current UTC datetime is used. |
dncEndDate | No | datetime | Optional. End date for DNC validation. If omitted, current UTC datetime is used. |
includeGlobal | Yes | boolean | If true, the API will also check against Global DNC and NDNC registries. |
checkForComplianceTypes | Yes | Array of strings | Compliance types to validate. If not provided, all are checked. Valid values: DNC, NDNC, Litigator. |
contacts | Yes | JSON object | This is the array of contact records. The system performs compliance checks on each contact in the array. |
Response Parameters | Value |
|---|---|
Channel | LCM |
topic | Webservice |
subtopic | CheckContacts |
data | JSON object |
Contacts Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
id | Yes | string | Unique identifier for the request. This is a mandatory field and must be unique within each API call. |
channel | Yes | String | Communication channels to check compliance for. Supported values: Voice, SMS, Email, VoiceMail. |
modeValue | Yes | string | Contact mode value. Can be a phone number or an email address. |
modeId | Yes | string | Identifier for the mode (for example, a unique ID assigned to the phone or email). |
businessFields | No | An array of JSON objects | Business-specific metadata. Each object must include:
|
attributes | No | Array of objects | Region-specific filters:
|
Response Parameters
Parameter | Data Type | Description |
|---|---|---|
complianceResults | Array of objects | Displays the list of compliance results. |
ComplianceResults Parameters
Parameter | Data Type | Description |
|---|---|---|
id | string | Request ID returned in the response. |
blocked | Array of objects | List of channels that are blocked by compliance checks. Each object includes the following fields:
|
Blocked Parameters
Parameter | Data Type | Description |
|---|---|---|
channel | string | The communication channel blocked. Possible values: Voice, SMS, Email, VoiceMail. |
compliance | Array of strings | List of compliance types that caused the block. Possible values: DNC, NDNC, Litigator. |
Sample Request
{
"contacts": [
{
"id": "string",
"channel": [
"voice"
],
"modeValue": "string",
"modeId": "string",
"businessFields": [
{
"fieldName": "string",
"value": "string"
}
],
"attributes": {
"areaCode": [
"string"
],
"zipCode": [
"string"
],
"state": [
"string"
]
}
}
],
"campaignName": [
"string"
],
"categoryName": [
"string"
],
"dncStartDate": null,
"dncEndDate": null,
"includeGlobal": true,
"checkForComplianceTypes": [
"DNC"
]
"campaignNameForComplianceTypes": ""
}Sample Response
{
"complianceResults": [
{
"id": "string",
"blocked": [
{
"channel": "voice",
"compliance": [
"DNC"
]
}
]
}
]
}Was this article helpful?