- DarkLight
Get Non-PEWC Contact
- DarkLight
Overview
The GetNonPEWCContact API provides a non-PEWC contact for manual dialing.
Pre-requisite
The Agent must be logged in to the application.
Note
The Manual Dial Widget replaces the Non-PEWC widget eventually. Non-PEWC is compatible up to the Campaign Manager version 2308.
Sequence Diagram
Message Structure
Request Parameters | Value |
---|---|
channel | LCM |
topic | Webservice |
subtopic | GetContactOD |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
---|---|---|---|
UserId | Yes | String | The agent ID. |
isReservedBy | No | String |
Response Parameters | Value |
---|---|
channel | LCM |
topic | Webservice |
subtopic | ContactOD |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
---|---|---|---|
response | Yes | JSON Array | Response object. |
Response Parameters | |||
PhoneNumber | Yes | String | The customer phone number. |
AccountNumber | Yes | String | The LCM Key. |
CampaignId | Yes | String | The campaign ID. |
Mode | Yes | String | The contact mode. |
ContactId | Yes | String | The contact ID generated by the application. |
ExpiryTime | Yes | String | The contact expiry time. |
CallbackTime | Yes | String | The Callback time set for this contact. |
CallType | Yes | String | The call type - regular, regular callback, or personal callback. |
Prefix | Yes | String | The prefix added to the contact number. |
Suffix | Yes | String | The suffix added to the contact number. |
Queue | Yes | String | The queue name from where the contact originated. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetContactOD",
"data":
{
"UserID": "testagent”
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "ContactOD",
"message":
{
"response":
{
"PhoneNumber": "9873635",
"AccountNumber": "137|1|3|0|0|84|1",
"CampaignId": "SamplePreviewCampaign-ACQ",
"Mode": "Home",
"ContactId": "137",
"ExpiryTime": "Oct 7 2020 11:59PM",
"CallbackTime": "Oct 7 2020 11:59PM",
"CallType": "Regular Call",
"Prefix": "",
"Suffix": "",
"Queue": "Queue1"
}
}
}