.png?sv=2022-11-02&spr=https&st=2025-06-08T22%3A24%3A53Z&se=2025-06-08T22%3A34%3A53Z&sr=c&sp=r&sig=y%2FYctkL2289isDjmWAyFJj46M94888GRsaTqTdJJJP0%3D){kind=logo}
Get Download Contacts For Dialing
- DarkLight
Get Download Contacts For Dialing
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetDownloadContactsForDialing API retrieves a single contact for manual dialing.
Pre-requisite
The Agent must be logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetDownloadContactsForDialing |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignGroup | Yes | String | The Campaign Group that you select from the dropdown list. |
NumberOfContactsRequired | Yes | String | The number of contacts that the API request must fetch.
|
Consent | Yes | String | If you require contacts with customer consent, set this to true. Else, set to false for contacts without customer consent. |
AgentID | Yes | String | The agent ID. |
ReservedContacts | Yes | String | If you require contacts that are reserved, set this to true. Else, set to false to download fresh contacts. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | DownloadContactsForDialing |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | Response data. |
Response Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
PhoneNumber | Yes | String | The contact number to be dialed. |
AccountNumber | Yes | String | The LCM Key. |
CampaignId | The campaign ID for the contact. | ||
Mode | The contact mode. | ||
ContactId | The contact ID. | ||
ExpiryTime | The contact expiry time. | ||
CallbackTime | The time the Callback is scheduled for this contact. | ||
CallType | The call type - regular, regular callback, or personal callback. | ||
Consent | Yes | String | If you require contacts with customer consent, set this to true. Else, set to false for contacts without customer consent. |
Sample Request
Request:
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetDownloadContactsForDialing",
"data": {
"CampaignGroup": "AD Dev Manual Group",
"NumberofContactsRequired": 1,
"Consent": "Both",
"AgentID": "[email protected]",
"ReservedContacts": "false"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "DownloadContactsForDialing",
"message": {
"response": {
"PhoneNumber": "1234567890",
"AccountNumber": "0|0|000|0|0|00|1234",
"CampaignId": "AD Manual Dial Campaign",
"Mode": "Mobile",
"ContactId": 3,
"ExpiryTime": "01/30/2024 23:59:00",
"CallbackTime": "01/30/2024 11:46:09",
"CallType": 0,
"Consent": "Yes"
}
}
}Was this article helpful?