.png?sv=2022-11-02&spr=https&st=2025-12-23T01%3A20%3A32Z&se=2025-12-23T01%3A30%3A32Z&sr=c&sp=r&sig=Lpdtfp4C4ido%2FIMka1c3Mbv%2BjUSIxL9CeFfwM%2FxZlh8%3D){kind=logo}
State Synchronization
- DarkLight
State Synchronization
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API provides the current state values.
Pre-requisite
The application registration process must be completed.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | StateSync |
source | «app-name-broadcasting-this-message» |
data | Not applicable |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | StateSync |
message | «call details JSON Object» |
Message Parameters
Response Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The Call ID generated by the application. |
businessfields | Yes | JSON Array | The values for the business fields. |
optionalbusinessfields | Yes | JSON Object | The values for the optional business fields. |
campaignmodes | No | JSON Object | The Campaign modes for the call. |
modeid | Yes | String | The mode ID. |
Description | Yes | String | The mode description. |
MinLength | Yes | Number | The minimum mode value length. |
MaxLength | Yes | Number | The maximum mode value length. |
Cvalue | Yes | String | The customer phone number - that is, the contact value. |
PEWC | Yes | Boolean | Whether the contact is a global PEWC contact or not. |
CampaignPEWC | Yes | Boolean | Whether the contact is a campaign PEWC contact or not. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "StateSync",
"source": "myapp"
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "StateSync",
"message": [
{
"callid": "12345",
"campaignmodes": [
{
"ModeID": "1",
"Description": "Home",
"ChannelType": "2",
"MinLength": "8",
"MaxLength": "12",
"Cvalue": null,
"PEWC": false,
"CampaignPEWC": false
}
],
"optionalbussinessfields": {
"FName": "David1",
"LName": "Berry",
"Address": "Virginia",
"Country": "USA",
"Home": "6491462346",
"Office": "6591462346",
"Mobile": "6591462346"
}
},
{
"callid": "67890",
"campaignmodes": [
{
"ModeID": "1",
"Description": "Home",
"ChannelType": "2",
"MinLength": "8",
"MaxLength": "12",
"Cvalue": null,
"PEWC": false,
"CampaignPEWC": false
}
]
}
]
}Was this article helpful?