Get Business Outcome By Outcome group
- DarkLight
Get Business Outcome By Outcome group
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The GetOutcomeByOutcomegroup API returns the business outcome group based on the outcome group configured in the layout settings for manual and inbound calls.
Pre-requisite
The Agent must be on an active call or logged in to the application.
Sequence Diagram
.png?sv=2022-11-02&spr=https&st=2026-04-24T06%3A06%3A28Z&se=2026-04-24T06%3A16%3A28Z&sr=c&sp=r&sig=x8w7dCTFF%2FxOty6F9cGp9kqUMBXJz4g%2BnnWx4BX37QI%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | GetOutcomeByOutcomegroup |
data | <<JSON Object>> |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The Call ID generated by the application. |
type | Yes | String | The type of the call. For example, inbound, outbound, etc. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | WebService |
subtopic | BusinessOutCome |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
response | Yes | JSON Object | Response data. |
Response Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
CampaignID | Yes | String | Unique identifier of the campaign associated with the outcome. |
OutComeID | Yes | String | The outcome ID for the business outcomes. |
LeadScore | No | Number | The lead score for the contact at the time of upload or at agent ACW. |
ParentID | Yes | String | ID of the parent entity linked to the business outcome. |
Description | Yes | String | The description of the business outcome. |
Sample Request
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "GetOutcomeByOutcomegroup",
"data": {
"callid": "",
"type": "MANUAL"
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "BusinessOutCome",
"message": {
"response": [
{
"CampaignID": "0",
"OutComeID": "107",
"LeadScore": "0",
"ParentID": "5",
"Description": "success"
},
{
"CampaignID": "0",
"OutComeID": "108",
"LeadScore": "0",
"ParentID": "6",
"Description": "Fail"
}
]
}
}Was this article helpful?