.png?sv=2022-11-02&spr=https&st=2025-12-23T12%3A12%3A25Z&se=2025-12-23T12%3A22%3A25Z&sr=c&sp=r&sig=BcsrYaUzV3m8%2FTPyGFIufGajXdZQnqwhN9F4wb6EMjo%3D){kind=logo}
Set Business Outcomes
- DarkLight
Set Business Outcomes
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The SetBusinessOutcome API helps an Agent set a business disposition (outcome) for a call along with call comments and the target value achieved during the call.
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 | SetBusinessOutcomeWithComments |
source | «app-name-broadcasting-this-message» |
data | N/A |
Data Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The Call ID generated by the application. |
AccountNumber | Yes | String | The LCM Key. |
OutcomeId | Yes | Number | The outcome ID for the Callback outcome. |
UserID | Yes | String | The agent ID. |
AgentComments | Yes | String | The comments entered by the agent. |
LeadScore | Yes | Number | The lead score for the contact. |
TargetAmount | Yes | Number | The target achieved. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetBusinessOutcomeWithCommentsResult |
message | «JSON Object» |
Message Parameters
Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
callid | Yes | String | The call ID generated by the application. |
response | Yes | JSON Object | The response data. |
Response Parameters | |||
success | Yes | Boolean | The business outcome update status. |
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": "SetBusinessOutcomeWithComments",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1",
"OutcomeId": 101,
"LeadScore": 0,
"UserID": "testagent",
"AgentComments": "Test comment",
"TargetAmount": 0
}
}Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetBusinessOutcomeWithCommentsResult",
"message":
{
"callid": "12345",
"response":
{
"success": true
}
}
}Was this article helpful?