Get Not Ready Reason Code

Overview

This API is used to get the Reason Code for Not Ready state so that Agent can perform logout action.

Pre-requisite

The agent must be in the LoggedIn state.

Sequence Diagram

Message Structure

Data Parameters

Response Parameters

Sample Request

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "GetNotReadyReasonCode"
}

Sample Response

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "SetNotReadyReasonCodes",
    "message": {
        "packet": "NotReadyReasonCodes",
        "data": [
            {
                "uri": "/finesse/api/ReasonCode/28",
                "category": "NOT_READY",
                "code": "3276",
                "label": "Meeting",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/49",
                "category": "NOT_READY",
                "code": "5136",
                "label": "Tea Break lengthy Not ready reason code",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/41",
                "category": "NOT_READY",
                "code": "6317",
                "label": "Coffee 5",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/46",
                "category": "NOT_READY",
                "code": "14375",
                "label": "Coffee 10",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/34",
                "category": "NOT_READY",
                "code": "18521",
                "label": "Townhall",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/51",
                "category": "NOT_READY",
                "code": "19998",
                "label": "Tea 2",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/26",
                "category": "NOT_READY",
                "code": "25243",
                "label": "Tea break",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/52",
                "category": "NOT_READY",
                "code": "25726",
                "label": "Tea 3",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/45",
                "category": "NOT_READY",
                "code": "25961",
                "label": "Coffee 9",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/37",
                "category": "NOT_READY",
                "code": "27527",
                "label": "Coffee 1",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/39",
                "category": "NOT_READY",
                "code": "32459",
                "label": "Coffee 3",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/43",
                "category": "NOT_READY",
                "code": "33287",
                "label": "Coffee 7",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/42",
                "category": "NOT_READY",
                "code": "33352",
                "label": "Coffee 6",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/40",
                "category": "NOT_READY",
                "code": "34588",
                "label": "Coffee 4",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/50",
                "category": "NOT_READY",
                "code": "35314",
                "label": "Tea 1",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/44",
                "category": "NOT_READY",
                "code": "47712",
                "label": "Coffee 8",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/29",
                "category": "NOT_READY",
                "code": "49433",
                "label": "Coffee Break",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/53",
                "category": "NOT_READY",
                "code": "52163",
                "label": "Break",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/38",
                "category": "NOT_READY",
                "code": "58361",
                "label": "Coffee 2",
                "forAll": "true",
                "systemCode": "false"
            },
            {
                "uri": "/finesse/api/ReasonCode/27",
                "category": "NOT_READY",
                "code": "61028",
                "label": "Lunch Break",
                "forAll": "true",
                "systemCode": "false"
            }
        ]
    }
}