.png?sv=2022-11-02&spr=https&st=2025-06-08T18%3A06%3A11Z&se=2025-06-08T18%3A16%3A11Z&sr=c&sp=r&sig=Gmg1NmOFux1U7UtnTP5d7Ksfm6TKELbV5prhJdMcdXM%3D){kind=logo}
Get Download All Contacts
- DarkLight
Get Download All Contacts
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetDownloadAllContactsForDialing API provides a list of contacts 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 | GetDownloadAllContactsForDialing |
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 | DownloadAllContactsForDialing |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | Response data. |
Response Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
Contacts | No | JSON Array | List of manual dial contacts. |
RequestFailureReason | No | String | The message that describes the reason for failure. |
Contacts Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignGroup | Yes | String | The campaign group of the contact. |
CampaignGroupID | Yes | Number | The campaign group ID generated by the application. |
CampaignID | Yes | String | The campaign ID generated by the application. |
CampaignKey | Yes | String | The campaign key for the campaign. |
ContactStrategyName | No | String | The name of the contact strategy mapped to the campaign. |
CSSGroupName | No | String | The CSS group name that delivers the contact for dialing. |
CSSConditionID | No | String | The CSS condition ID with which the contact is delivered. |
CSSConditionName | No | String | The CSS condition name with which the contact is delivered. |
LCMKey | Yes | String | LCM Key. |
ContactID | Yes | Number | The contact ID generated by the application. |
ListD | Yes | Number | The list ID generated by the application. |
ModeID | Yes | Number | The mode ID generated by the application. |
ModeName | Yes | String | The mode name. |
ModeValue | Yes | String | The value of the contact for this mode. |
ContactExpiryTime | Yes | String | The expiry time for the contact. |
ContactDeliveredTime | Yes | String | The time the contact was delivered. |
Consent | No | String | Set Yes if customer consent is available. Set No if customer has no consented. |
CallType | Yes | Number | The call type from regular, regular Callback, or personal callback. |
PrimaryZipCode | No | String | The zip code of the primary contact number. |
AddlZipCode | No | String | The zip code of the additional contact number. |
ModeAreaCode | No | String | The area code of the contact mode. |
ModeZipCode | No | String | The zip code of the contact mode. |
BussinessFields | No | String | Business fields for the given account number. |
OptionalBusinessFields | No | String | Optional business fields for the given account number. |
AgentID | No | String | The agent ID. |
ChannelID | Yes | Number | The channel ID generated by the application. |
CallbackTime | No | String | The time when the callback is scheduled for. |
DialerID | No | String | The dialer ID generated by the application. |
Prefix | No | String | The prefix applied to the contact number. |
Suffix | No | String | The suffix applied to the contact number. |
ReservedByAgent | No | String | The name of the agent who retrieved the contact. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetDownloadAllContactsForDialing",
"data": {
"CampaignGroup": "AD Dev Manual Group",
"NumberofContactsRequired": 1,
"Consent": "Both",
"AgentID": "[email protected]",
"ReservedContacts": "false"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "DownloadAllContactsForDialing",
"message": {
"response": {
"Contacts": [
{
"CampaignGroup": "AD Dev Manual Group",
"CampaignGroupID": 486,
"CampaignID": "AD Manual Dial Campaign",
"CampaignKey": 279,
"ContactStrategyName": "Default_Simple_Strategy",
"CSSGroupName": "Default",
"CSSConditionID": 1543,
"CSSConditionName": "[Contact Priority Calls - Old Contacts]",
"LCMKey": "4|3|279|0|0|44|1253",
"ContactID": 4,
"ListID": 1,
"ModeID": 1,
"ModeName": "Mobile",
"ModeValue": "2082097345",
"ContactExpiryTime": "01/30/2024 23:59:00",
"ContactDeliveredTime": "01/30/2024 14:19:14",
"Consent": "Yes",
"CallType": 0,
"PrimaryZipCode": "",
"AddlZipCode": "",
"ModeAreaCode": "",
"ModeZipCode": "",
"BussinessFields": "[{\"BusinessFieldName\":\"CustomerID\",\"BusinessFieldValue\":\"\"},{\"BusinessFieldName\":\"First salary\",\"BusinessFieldValue\":\"\"}]",
"OptionalBusinessFields": "<Data><FName><![CDATA[S4asiCs1]]></FName><LName><![CDATA[User]]></LName><Address><![CDATA[NewYork]]></Address><Country><![CDATA[USA]]></Country><Home><![CDATA[2082097345]]></Home><Office><![CDATA[2082097345]]></Office><Mobile><![CDATA[2082097345]]></Mobile></Data>",
"AgentID": "",
"ChannelID": 2,
"CallbackTime": "01/30/2024 11:46:09",
"DialerID": 0,
"Prefix": "",
"Suffix": "",
"ReservedByAgent": "[email protected]"
}
],
"RequestFailureReason": null
}
}
}
Was this article helpful?