.png?sv=2022-11-02&spr=https&st=2025-06-03T15%3A18%3A37Z&se=2025-06-03T15%3A28%3A37Z&sr=c&sp=r&sig=jer%2FfUTndwOJSM3Ci8ZFm%2BhJvA9b7GdaMjRJrKx5pE8%3D){kind=logo}
Get Business Outcomes
- DarkLight
Get Business Outcomes
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetBusinessOutcomes API provides the list of Business Outcomes configured for a Campaign.
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 | GetBusinessOutcome |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
AccountNumber | Yes | String | LCM Key. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | BusinessOutcome |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | Call ID. |
response | Yes | JSON Array | Business Outcome data. |
Response Parameters | |||
OutcomeID | Yes | String | The business outcome ID. |
Description | Yes | String | The business outcome description. |
CampaignID | Yes | String | The campaign ID. |
LeadScore | NA | NA | NA |
ParentID | 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": "GetBusinessOutCome",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "BusinessOutCome",
"message":
{
"callid": "12345",
"response":
[
{
"OutComeID": "101",
"Description": "Payment Done",
"CampaignID": "1",
"LeadScore": "0",
"ParentID": null
},
{
"OutComeID": "102",
"Description": "Payment Failure",
"CampaignID": "1",
"LeadScore": "0",
"ParentID": null
}
]
}
}Was this article helpful?