Get Optional Business Fields
- DarkLight
Get Optional Business Fields
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetOptionalBusniessFields API provides the optional business fields for a given account number.

.jpg?sv=2022-11-02&spr=https&st=2025-12-22T03%3A48%3A34Z&se=2025-12-22T03%3A58%3A34Z&sr=c&sp=r&sig=XQPgbeXH2SrwKNKY5bmfaNLCSxUtqhoCU5rsA4f5S%2FY%3D)
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
.jpg?sv=2022-11-02&spr=https&st=2025-12-22T03%3A48%3A34Z&se=2025-12-22T03%3A58%3A34Z&sr=c&sp=r&sig=XQPgbeXH2SrwKNKY5bmfaNLCSxUtqhoCU5rsA4f5S%2FY%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | GetScreenPopData |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | The LCM Key. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | ScreenPopData |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Optional business field data. |
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": "GetScreenPopData",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "ScreenPopData",
"message":
{
"callid": "12345",
"response":
{
"FName": "David1",
"LName": "Berry",
"Address": "Virginia",
"Home": "6491462346",
"Office": ""
}
}
}Was this article helpful?