- DarkLight
Set Telephony Outcome
- DarkLight
Overview
The SetTelephonyOutcome API provides an option to set the telephony outcome for a dialed contact with Agent comments and, if applicable, the target value achieved during Interaction.
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-24T00%3A33%3A38Z&se=2025-12-24T00%3A43%3A38Z&sr=c&sp=r&sig=YtRissYE%2Bl3UamnP%2F5WgjGdBi0YcxaGig7yFRGxOej0%3D)

Message Structure
Request Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCallOutcomeWithComments |
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 | String | The telephony outcome to be set. |
LeadScore | Yes | Number | The lead score for the contact. |
UserID | Yes | String | The agent ID. |
AgentComments | Yes | String | The comments entered by the agent. |
TargetAmount | Yes | Number | The target achieved. |
Response Parameters | Value |
|---|---|
channel | LCM |
topic | Webservice |
subtopic | SetCallOutcomeWithCommentsResult |
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 telephony outcome 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": "SetCallOutcomeWithComments",
"data":
{
"callid": "12345",
"AccountNumber": "5|3|1|0|0|44|1",
"OutcomeId": 1,
"LeadScore": 0,
"UserID": "testagent",
"AgentComments": "Test comment",
"TargetAmount": 0
}
} Sample Response
{
"channel": "LCM",
"topic": "WebService",
"subtopic": "SetCallOutcomeWithCommentsResult",
"message":
{
"callid": "12345",
"response": {
"success": true
}
}
}