.png?sv=2022-11-02&spr=https&st=2025-12-21T23%3A01%3A10Z&se=2025-12-21T23%3A11%3A10Z&sr=c&sp=r&sig=bf94zRyOHTodxSdXnk2vgrEwb2vCTczONes65huKZVM%3D){kind=logo}
Get Mode Information
- DarkLight
Get Mode Information
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetModeInformation API provides the details like Campaign, Mode, Contact ID, Time Zone, and Phone Number associated with an LCMKey.
Pre-requisite
The Agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetModeInformation |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | LCM Key. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetModeInformationResult |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Response object. |
Response Parameters | |||
CampaignId | Yes | String | The campaign ID. |
ModeName | Yes | String | The mode name. |
ContactID | No | String | The contact ID generated by the application. |
Timezone | No | String | The campaign time zone. |
ContactNumber | Yes | String | The contact phone number. |
CampaignCategoryName | Yes | String | The campaign category. |
CallId | No | String | The call ID generated by the application. |
GMTDeviation | No | Number | The Greenwich Mean Time offset for the campaign time zone. |
DispositionRequired | Yes | Boolean | Indicates if a disposition is mandatory for the campaign. |
DNCPeriodType | Yes | String | Type of DNC Period - one of Permanent, Specific (number of) Days, or Agent Selection. |
DNCDays | Yes | Number | For DNC Period Type Specific Days, the number of days for DNC for this contact from the DNC start date. |
DNCEOD | Yes | Boolean | For DNC Period Type Specific Days, the number of days for DNC for this contact from the DNC start date. |
CustomerDNCTZEnabled | Yes | Boolean | This indicates if the DNC is based on the customer time zone. |
DNCType | Yes | String | The DNC type - Campaign Specific, Campaign Category, Multiple Categories, or Global. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetModeInformation",
"data": {
"callid": "12345",
"AccountNumber": "137|1|3|0|0|84|"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetModeInformationResult",
"message":
{
"callid": "12345",
"response":
{
"CampaigniD": "SamplePreviewCampaign-ACQ",
"ModeName": "Home",
"ContactID": "137",
"Timezone": "(UTC+05:30) Chennai Kolkata Mumbai New Delhi",
"ContactNumber": "984561288",
"CampaignCategoryName": "",
"CallID": "",
"GMTDeviation": 0,
"DispositionRequired": true,
"DNCPeriodType": "SpecificDay",
"DNCDays": 2,
"DNCEOD": false,
"CustomerDNCTZEnabled": false,
"DNCType": "Global"
}
}
}Was this article helpful?