.png?sv=2022-11-02&spr=https&st=2025-06-16T18%3A33%3A09Z&se=2025-06-16T18%3A43%3A09Z&sr=c&sp=r&sig=UoY104BgDc1Gs4c7daIRy%2F2EDkH4rFOuCRmJ8oaMDnA%3D){kind=logo}
Create Contact
- DarkLight
Create Contact
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The API is used to add new contacts to a campaign. While adding the contact, you can specify the default status of the contact like 0 – Open, 4 – Delivered, etc. For example, to prevent the newly added contact from delivering to the dialer, specify the status as “4”.
Pre-requisite
The agent must be on an active call or logged in to the application.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
Channel | LCM |
Topic | WebService |
subtopic | CreateContact |
Source | <<app-name-broadcasting-this-message>> |
Data | N/A |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignID | Yes | String | Contact is created under the specified Campaign ID |
Calltype | Yes | String | 0 - Fresh Contacts |
callStartDateTime | Yes | String | Callback Start date in the dd/mm/yyyy HH:MM format. |
callEndDateTime | Yes | String | Callback End date in the dd/mm/yyyy HH:MM format. |
BussinessFields | Yes | String | The list of business fields to upload for the contact. This should be in XML format. The hardcoded value is <Data<first_name>test</first_name <last_name>test</last_name></Data> |
priority | No | Number | Priority of the contact used to prioritize at dial out. |
Modes | Yes | String | Contact modes for the contact to be uploaded, in xml format. Sample<Data> <Home <Cvalue>609309034</Cvalue><TZ>(UTC-05:00) Eastern Time (US and Canada)</TZ></Home></Data> |
AgentID | No | String | AgentID. The hardcoded value is “” |
SMSData | No | String | Predefined SMS text, applicable only to SMS Channel |
MailSubject | No | String | Email Subject, applicable only to Email Channel |
MailMsg | No | String | Email Body, applicable only to Email Channel |
MailAttachment | No | String | Path of Email Attachment if any. This is applicable only for Email Channel. |
ZipCode | No | String | Zip Code of the contact |
ContactDetail | No | String | Option Business fields, used as a Screen Pop data in XML format. |
ListID | No | Number | |
IsAccountNumber | Yes | Boolean | Whether to generate the LCMKey as stored in the contact table or not. |
Status | Yes | Number | Status of the Contact. The default value is 4. |
Response Parameters | Value |
|---|---|
Channel | LCM |
Topic | WebService |
subtopic | CreateContactResponse |
Message | <<JSON Object>> |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | Response data |
Response Parameters | |||
Response | Yes | String | Update status |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": " AddCompliance ",
"data":
{
"CampaignID": campaignName,
"Calltype": "0",
"callStartDateTime": ""24/10/2024 07:33,
"callEndDateTime": "24/10/2024 07:33",
"BussinessFields": "<Data><first_name>test</first_name><last_name>test</last_name></Data>",
"priority": 0,
"Modes": "<Data><Home><Cvalue>" + this.dncNumber + "</Cvalue><TZ>" + campaignTimeZone + "</TZ></Home></Data>",
"AgentID": "",
"SMSData": "",
"MailSubject": "",
"MailMsg": "",
"MailAttachment": "",
"ZipCode": "",
"ContactDetail": "",
"ListID": 0,
"IsAccountNumber": true,
"Status": 4
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": " AddComplianceResponse",
"message":
{
"response": “77|1|18|0|0|84|0”
}
}Was this article helpful?