.png?sv=2022-11-02&spr=https&st=2025-06-08T03%3A59%3A45Z&se=2025-06-08T04%3A09%3A45Z&sr=c&sp=r&sig=m7abOaZVjbG6zLrQuuTew7podKkwt1EMpxBLqVDfGCg%3D){kind=logo}
Get Contact Modes
- DarkLight
Get Contact Modes
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetContactModes API retrieves a list of modes along with the associated number for the selected contact.
Pre-requisite
The agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetContactModes |
source | <<app-name-broadcasting-this-message>> |
data | <<JSON Object>> |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | No | String | Call ID of the contact |
AccountNumber | Yes | String | LCMKey of the contact |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | SetContactModes |
message | <<JSON Objects>> |
Message Parameters
Parameter | Description |
|---|---|
Contactmodes | Array of modes associated with the contact |
Contact Modes Parameters
Parameter | Data Type | Description |
|---|---|---|
ModeID | String | ID of the mode |
ModeDesc | String | Mode name |
CampaignID | String | Campaign Name |
CValue | String | Phone number associated to the mode |
ModeDialingStartTime | String | Start Time |
ModeDialingEndTime | String | End Time |
TimeZone | String | Primary timezone configured for the mode |
TimeZone1 | String | Secondary timezones |
TimeZone2 | String | |
TimeZone3 | String | |
PEWC | String | Is PEWC contact? |
AreaCode | String | AreaCode associated with the mode |
ZipCode | String | ZipCode associated with the mode |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetContactModes",
"data": {
"callid": "",
"AccountNumber": "596|485|587|0|0|44|59"
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetContactModes",
"message": {
"callid": "",
"contactmodes": [
{
"ModeID": "485",
"ModeDesc": "Reg_Mode319",
"CampaignID": "ManualDial",
"CValue": "8722922467",
"ModeDialingStartTime": "00:00",
"ModeDialingEndTime": "23:59",
"TimeZone": "(UTC) Coordinated Universal Time",
"TimeZone1": "",
"TimeZone2": "",
"TimeZone3": "",
"PEWC": false,
"AreaCode": "",
"ZipCode": ""
},
{
"ModeID": "1",
"ModeDesc": "Home",
"CampaignID": "ManualDial",
"CValue": "",
"ModeDialingStartTime": "00:00",
"ModeDialingEndTime": "23:59",
"TimeZone": "",
"TimeZone1": "",
"TimeZone2": "",
"TimeZone3": "",
"PEWC": false,
"AreaCode": "",
"ZipCode": ""
}
]
}
}
Was this article helpful?