- DarkLight
Get Parent Outcomes
- DarkLight
Overview
The GetParentOutcomes API provides the list of parent Outcomes of a Business Outcome Group assigned to a Campaign.
Note
The application lists the values based on the parameter selected in Call Outcome.

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 | GetBOGroupParent |
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 | BOGroupParent |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Parent outcome data. |
Response Parameters | |||
ParentId | Yes | String | The Parent Business Outcome ID. |
ParentName | Yes | String | The Parent Business Outcome name. |
CampaignKey | NA | NA | NA |
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": "GetBOGroupParent",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "BOGroupParent",
"message":
{
"callid": "12345",
"response":
[
{
"ParentId": "1",
"ParentName": "Success",
"CampaignKey": null
},
{
"ParentId": "2",
"ParentName": "Failure",
"CampaignKey": null
}
]
}
}