Get Agent State

Overview

This API allows the Agent to get the agent states.

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": "GetAgentState"
}

Sample Response

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "SetAgentState",
    "message": {
        "data": {
            "agentTime": "00:00",
            "issupervisor": false,
            "dialogs": "/finesse/api/User/834108959/Dialogs",
            "extension": "5063",
            "firstName": "arul",
            "lastName": "4",
            "loginId": "834108959",
            "loginName": "arul4",
            "mediaType": "1",
            "reasonCodeId": "-1",
            "roles": [
                "Agent"
            ],
            "settings": {
                "wrapUpOnIncoming": "NOT_ALLOWED",
                "wrapUpOnOutgoing": "NOT_ALLOWED"
            },
            "state": "NOT_READY",
            "stateChangeTime": "2022-06-22T13:01:53.750Z",
            "teamId": "5004",
            "teamName": "RTTeam2",
            "uri": "/finesse/api/User/834108959",
            "wrapUpTimer": "60",
            "teams": [
                {
                    "id": "5004",
                    "name": "RTTeam2",
                    "uri": "/finesse/api/User/834108959"
                }
            ]
        },
        "rules": {
            "SequentialActions": {
                "items": {},
                "count": 2
            },
            "ResponseType": 0,
            "ResponseText": "Success",
            "ResponseActual": {
                "user": {
                    "agentTime": "00:00",
                    "issupervisor": false,
                    "dialogs": "/finesse/api/User/834108959/Dialogs",
                    "extension": "5063",
                    "firstName": "arul",
                    "lastName": "4",
                    "loginId": "834108959",
                    "loginName": "arul4",
                    "mediaType": "1",
                    "reasonCodeId": "-1",
                    "roles": [
                        "Agent"
                    ],
                    "settings": {
                        "wrapUpOnIncoming": "NOT_ALLOWED",
                        "wrapUpOnOutgoing": "NOT_ALLOWED"
                    },
                    "state": "NOT_READY",
                    "stateChangeTime": "2022-06-22T13:01:53.750Z",
                    "teamId": "5004",
                    "teamName": "RTTeam2",
                    "uri": "/finesse/api/User/834108959",
                    "wrapUpTimer": "60",
                    "teams": [
                        {
                            "id": "5004",
                            "name": "RTTeam2",
                            "uri": "/finesse/api/User/834108959"
                        }
                    ]
                },
                "systeminfo": {
                    "currentTimestamp": "2022-06-22T13:01:54.040Z",
                    "timeDiffSeconds": 8.96,
                    "deploymentType": "UCCE",
                    "lastCTIHeartbeatStatus": "success",
                    "lastSuccessCTIHeartbeatTime": "1655902913021",
                    "ctiVersion": "23",
                    "ctiHeartbeatInterval": "2",
                    "peripheralId": "5000",
                    "primaryNode": {
                        "host": "fin125com.Acqueonlab.com"
                    },
                    "secondaryNode": {
                        "host": "fin125comb.Acqueonlab.com"
                    },
                    "status": "IN_SERVICE",
                    "systemAuthMode": "NON_SSO",
                    "timezoneOffset": "330",
                    "uri": "/finesse/api/SystemInfo",
                    "xmppDomain": "fin125com.Acqueonlab.com",
                    "xmppPubSubDomain": "pubsub.fin125com.Acqueonlab.com"
                }
            },
            "deploymentType": "UCCE",
            "state": "NOT_READY",
            "ActionsAllowed": {
                "items": {
                    "AxnSetLogout": {
                        "VariableName": "LogOutReasonCode",
                        "VariableType": 1,
                        "VariableStructure": ""
                    },
                    "AxnMakeCall": {
                        "VariableName": "MakeCallNumber",
                        "VariableType": 1,
                        "VariableStructure": ""
                    },
                    "AxnSetReady": null,
                    "AxnSetNotReady": {
                        "VariableName": "NotReadyReasonCode",
                        "VariableType": 1,
                        "VariableStructure": ""
                    }
                },
                "count": 4
            },
            "ButtonStates": {
                "items": {
                    "Logout": "Enable",
                    "MakeCall": "Enable",
                    "Ready": "Enable",
                    "NotReady": "Enable"
                },
                "count": 4
            }
        },
        "source": "api",
        "event": "NOT_READY"
    }