- DarkLight
Get Local Stored Data
- DarkLight
Overview
The GetLocalStoredData API retrieves values of the last set request sent for a call. This is useful in scenarioswhere the UI is refreshed but has to pre-populate the last set data.
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 | GetStoredData |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
---|---|---|---|
callid | Yes | String | Call ID. |
Response Parameters | Value |
---|---|
channel | LCM |
topic | Webservice |
subtopic | StoredData |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Campaign time zone data. |
Response Parameters | |||
callid | Yes | String | Call ID. |
api | Yes | String | Last called set API name. |
Possible Error Cases
Error Type | Actual Error | Message |
---|---|---|
WS_Error | Callid is empty. | Invalid Call ID. |
WS_Error | Invalid Call ID:<call_id> | Invalid Call ID. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetStoredData",
"data": {
"callid": "12345"
}
}
Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "StoredData",
"message":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1",
"BusinessOutcome": "101",
"StartDate": "03/07/2020",
"EndDate": "03/07/2020",
"StartTime": "13:45",
"EndTime": "13:45",
"ModeID": "1",
"UserID": "prakashr",
"AgentComment": "Test comment",
"TargetAmount": 0,
"TargetAmountSpecified": false,
"api": "SetBusinessOutcomeWithCallback"
}
}