Get Available Outcomes
    • Dark
      Light

    Get Available Outcomes

    • Dark
      Light

    Article summary

    Overview

    The GetAvailableOucomes API provides a list of telephony Outcomes available in the system. Callback is applicable only if outcome is selected as Callback.

    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

    GetCallOutCome

    source

    «app-name-broadcasting-this-message»

    data

    «JSON Object»

    Data Parameters

    Parameter

    Mandatory

    Data Type

    Description

    callid

    Yes

    String

    Call ID.

    Response Parameters

    Value

    channel

    LCM

    topic

    Webservice

    subtopic

    CallOutcome

    message

    «JSON Object»

    Message Parameters

    Parameter

    Mandatory

    Data Type

    Description

    callid

    Yes

    String

    Call ID.

    response

    Yes

    JSON Array

    Call outcome data.

    Response Parameters

    OutcomeID

    Yes

    String

    The outcome ID.

    Description

    Yes

    String

    The outcome name.

    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": "GetCallOutCome",
        "data": 
        {
            "callid": "12345"
        }
    }

    Sample Response

    {
        "channel": "LCM",
        "topic": "WebService",
        "subtopic": "CallOutCome",
        "message": 
        {
            "callid": "12345",
            "response": 
            [
                {
                    "OutComeID": "0",
                    "Description": "Success"
                },
                {
                    "OutComeID": "1",
                    "Description": "Abandoned"
                },
                {
                    "OutComeID": "2",
                    "Description": "Invalid"
                }
            ]
        }
    }


    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.
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence