Set Telephony Outcome With Business Outcome
    • Dark
      Light

    Set Telephony Outcome With Business Outcome

    • Dark
      Light

    Article summary

    Overview

    This API provides an option to set dual Outcomes, that is, both business disposition (outcome) and a specific telephony outcome (DNC and Reject) for a call. The Agent can also add comments and update 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

    SetBusinessOutcomeWithCallOutcome

    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.

    BusinessOutcome

    Yes

    Number

    The business outcome (ID) to be set.

    CallOutcome

    Yes

    String

    The telephony outcome (ID) 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

    SetBusinessOutcomeWithCallOutcomeResult

    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 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": "SetBusinessOutcomeWithCallOutcome",
        "data": 
        {
            "callid": "12345",
            "AccountNumber": "5|3|1|0|0|44|1",
            "BusinessOutcome": 101,
            "CallOutcome": 0,
            "LeadScore": 0,
            "UserID": "1234",
            "AgentComments": "Test comment",
            "TargetAmount": 0
        }
    } 

    Sample Response

    {
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "SetBusinessOutcomeWithCallOutcomeResult",
        "message": 
        {
            "callid": "12345",
            "response": 
            {
                "success": true
            }
        }
    }


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.