.png?sv=2022-11-02&spr=https&st=2025-06-08T07%3A40%3A46Z&se=2025-06-08T07%3A50%3A46Z&sr=c&sp=r&sig=myii%2FjXudIMEHryxe0pJmTD5VLWgcj7bS66aTIsAklU%3D){kind=logo}
Get CCB Validate
- DarkLight
Get CCB Validate
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The Get CCB Validate API verifies compliance for a specific contact mode and returns the compliance status.
Pre-requisite
The agent must be logged in to the application.
Sequence Diagram
.png?sv=2022-11-02&spr=https&st=2025-06-08T07%3A40%3A46Z&se=2025-06-08T07%3A50%3A46Z&sr=c&sp=r&sig=sU7QS9x98wJSwmrR39Nu69hkuIIHivVP8%2BP6SWMylwk%3D "image(365).png")
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetCCBValidate |
data | <<JSON Object>> |
Data Structure
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
TenantId | Yes | String | Tenant ID of the AEC |
SubTenantId | Yes | String | Sub Tenant Id of the AEC |
DialerID | No | String | Dialer ID |
CampignGroupID | Yes | Number | Campaign Group ID |
CampaignID | Yes | String | Campaign Name |
CampaignCategoryID | No | String | Campaign Category ID |
ComplianceCheck | Yes | Boolean | If this parameter is true, it validates the Compliance Condition Builder rules |
GreenZoneCheck | Yes | Boolean | If this parameter is true, it validates the start and end guard time |
VoiceMailCheck | Yes | Boolean | If this parameter is true, it validates the type of voicemail request - whether limited or non-limited. This is applicable only when the Leave the Voicemail option is chosen by the user |
StateLawGroupName | No | String | StateLaw Group Name |
ContactInfo | Yes | Array of Object | Contact Details |
ContactInfo Structure
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
ContactID | Yes | Number | Contact ID |
BussFld26 | No | String | Business Fields |
BussFld27 | No | String | Business Fields |
BussFld28 | No | String | Business Fields |
BussFld29 | No | String | Business Fields |
BussFld30 | No | String | Business Fields |
LCMKey | Yes | String | LCMKey is a unique identification created by the application at the time of call attempt / delivery to the dialer |
GreenState | No | String | Selected States |
SelectedMode | Yes | String | Selected Mode |
ComplianceGroup | No | String | Compliance GroupName |
PrimaryZipCode | Yes | String | Primary Zipcode |
AddlZipCode | No | String | Addtional ZipCode |
ModeInfo | Yes | Array of Object | |
ValidModes | No | String | Valid Modes |
ModeInfo Structure
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
ModeID | Yes | String | Mode ID |
ModeValue | Yes | String | Phone number associated with the mode |
ModeAreaCode | Yes | String | Mode AreaCode |
ModeZipCode | Yes | String | Mode level ZipCode |
Response Parameter | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | CCBValidate |
message | <<JSON Object>> |
Message Parameter
Parameter | Data Type | Description |
|---|---|---|
response | JSON Object | Response Data |
Response Parameters
Parameter | Data Type | Description |
|---|---|---|
ComplianceStatus | JSON Object | Compliance Status data |
Compliance Status Parameters
Parameter | Data Type | Description |
|---|---|---|
TenantId | Number | Tenant ID of the AEC |
SubTenantId | Number | Sub Tenant ID of the AEC |
CampignGroupID | String | Campaign Group ID |
CampaignID | String | Campaign Name |
CampaignCategoryID | String | Campaign Category ID |
ContactResponseInfo | Array of Object | Contact Response Objects Array |
Contact Response Info Parameters
Parameter | Data Type | Description |
|---|---|---|
ContactID | Number | Contact ID |
BussFld26 | String | BusinessFields |
BussFld27 | String | BusinessFields |
BussFld28 | String | BusinessFields |
BussFld29 | String | BusinessFields |
BussFld30 | String | BusinessFields |
LCMKey | String | LCM key for the contact mode |
Result | Boolean | Compliance Check result |
InterimStatus | Number | Interim status |
RuleID | String | Rule mapping for the contact |
Message | String | Message received after compliance check |
EndTime | String | Compliance end time |
GreenZoneCheck | Boolean | Is greenzone check set to true? |
VoiceMailCheck | Boolean | Is voicemail check set to true? |
GreenZone | Array of Object | GreenZone details |
VoiceMail | Array of Object | VoiceMail details |
Greenzone Parameter
Parameter | Data Type | Description |
|---|---|---|
UTCStartTime | String | Timezone start time |
UTCEndTime | String | Timezone end time |
Description | String | Response message |
VoiceMail Parameter
Parameter | Data Type | Description |
|---|---|---|
Limited | Boolean | Type of voicemail request |
Non-Limited | Boolean | Type of voicemail request |
LeaveVoiceMail | Boolean | Can leave voicemail – true/false |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetCCBValidate",
"data": {
"TenantId": "25",
"SubTenantId": "59",
"DialerID": "",
"CampignGroupID": 88,
"CampaignID": "ManualDial",
"CampaignCategoryID": "",
"ComplianceCheck": true,
"GreenZoneCheck": false,
"VoiceMailCheck": true,
"StateLawGroupName": "",
"ContactInfo": [
{
"ContactID": 595,
"BussFld26": "",
"BussFld27": "",
"BussFld28": "",
"BussFld29": "",
"BussFld30": "",
"LCMKey": "595|485|587|0|0|44|59",
"GreenState": "",
"SelectedMode": "",
"ComplianceGroup": "",
"PrimaryZipCode": "",
"AddlZipCode": "",
"ModeInfo": [
{
"ModeID": "485",
"ModeValue": "6370145470",
"ModeAreaCode": "",
"ModeZipCode": ""
}
],
"ValidModes": ""
}
]
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "CCBValidate",
"message": {
"response": {
"ComplianceStatus": {
"TenantId": 25,
"SubTenantId": 59,
"CampignGroupID": "88",
"CampaignID": "ManualDial",
"CampaignCategoryID": "",
"ContactResponseInfo": [
{
"ContactID": 595,
"BussFld26": "",
"BussFld27": "",
"BussFld28": "",
"BussFld29": "",
"BussFld30": "",
"LCMKey": "595|485|587|0|0|44|59",
"Result": true,
"InterimStatus": 0,
"RuleID": "",
"Message": "Doesn't have Compliance Mapping",
"EndTime": "9999-12-31T23:59:59.9999999",
"GreenZoneCheck": true,
"VoiceMailCheck": true,
"GreenZone": [
{
"UTCStartTime": "2024-09-16T00:00:00Z",
"UTCEndTime": "2024-09-16T23:59:00Z",
"Description": "Successfully retrived"
}
],
"VoiceMail": [
{
"Limited": true,
"Non_Limited": true,
"LeaveVoiceMail": true
}
]
}
]
}
}
}
}
Was this article helpful?