.png?sv=2022-11-02&spr=https&st=2025-12-22T08%3A55%3A11Z&se=2025-12-22T09%3A05%3A11Z&sr=c&sp=r&sig=Ohi0eRLzGHPcOXexrofM4dVgAw2aJFl07wxa85KfI2s%3D){kind=logo}
Get Reserved Manual Dial Contact
- DarkLight
Get Reserved Manual Dial Contact
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetReservedManualDialContact API allows an Agent to download a manual dial contact.
Pre-requisite
The agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetReservedManualDialContact |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
AgentID | Yes | String | The agent ID. |
NumberOfContactsRequired | Yes | String | The number of contacts to be downloaded for the agent. |
Consent | Yes | Boolean | The type of contacts (consent or non-consent) to be downloaded. Set to true for consent contacts and false for non-consent contacts. |
ReservedContacts | Yes | Boolean | Indicates if the downloaded contacts are reserved contacts. Set to true to download reserved contacts and false to download new contacts. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | DownloadContactsForDialing |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Array | Parent outcome data. |
Response Parameters | |||
PhoneNumber | Yes | String | The contact phone number. |
AccountNumber | Yes | String | The LCM Key. |
CampaignId | Yes | String | The campaign ID. |
Mode | Yes | String | The contact mode. |
ContactID | Yes | Number | The contact ID as generated by the application. |
ExpiryTime | Yes | String | The contact expiry date and time. |
CallbackTime | Yes | String | The Callback time. |
CallType | Yes | Number | The call type - regular, regular callback, or personal callback. |
Consent | Yes | String | The type of contacts (consent or non-consent) to be downloaded. Set to true for consent contacts and false for non-consent contacts. |
Sample Request
Request:
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetReservedManualDialContact",
"data": {
"AgentID": "testagent@domain.com",
"NumberofContactsRequired": 1,
"Consent": "Yes",
"ReservedContacts": "true"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "DownloadContactsForDialing",
"message": {
"response": {
"PhoneNumber": "2082097345",
"AccountNumber": "0|1|234|0|0|00|1234",
"CampaignId": "AD Manual Dial Campaign",
"Mode": "Mobile",
"ContactId": 9,
"ExpiryTime": "01/31/2024 23:59:00",
"CallbackTime": "01/31/2024 05:09:25",
"CallType": 0,
"Consent": "Yes"
}
}
}Was this article helpful?