Team APIs

Team API represents a team and contains the team’s name and users associated with the team. The Team object does not contain a full User object for each of the team's users, but a summary object that contains the User loginId, firstName, lastName, ReasonCode, and extension parameters.

• Team API Parameters

• Subscribe Team

• Sign out an Agent

• Change agent state

• Silent monitor an agent's call

• Drop Participant

The following is the sample response of Team API:

{
    "rules": {
        "ButtonStates": {
            "items": {
                "NotReady": "Enable",
                "SetLogout": "Enable"
            },
            "count": 2
        },
        "ActionsAllowed": {
            "items": {
                "AxnSetNotReady": {
                    "VariableName": "NotReadyReasonCode",
                    "VariableType": 1,
                    "VariableStructure": ""
                },
                "AxnSetLogOut": {
                    "VariableName": "LogOutReasonCode",
                    "VariableType": 1,
                    "VariableStructure": ""
                }
            },
            "count": 2
        },
        "ResponseType": 0,
        "ResponseText": "Success"
    },
    "data": {
        "agentTime": "00: 00",
        "dialogs": "/finesse/api/User/47483650/Dialogs",
        "extension": "5025",
        "firstName": "RTDev2",
        "lastName": "RTDev2",
        "loginId": "47483650",
        "mediaType": "1",
        "state": "READY",
        "stateChangeTime": "2019-12-24T14: 00: 06.287Z",
        "uri": "/finesse/api/User/47483650",
        "teamId": "5003",
        "rules": {
            "ButtonStates": {
                "items": {
                    "NotReady": "Enable",
                    "SetLogout": "Enable"
                },
                "count": 2
            },
            "ActionsAllowed": {
                "items": {
                    "AxnSetNotReady": {
                        "VariableName": "NotReadyReasonCode",
                        "VariableType": 1,
                        "VariableStructure": ""
                    },
                    "AxnSetLogOut": {
                        "VariableName": "LogOutReasonCode",
                        "VariableType": 1,
                        "VariableStructure": ""
                    }
                },
                "count": 2
            },
            "ResponseType": 0,
            "ResponseText": "Success"',
            "ResponseActual": {
                "agentTime": "00: 00",
                "dialogs": "/finesse/api/User/47483650/Dialogs",
                "extension": "5025",
                "firstName": "RTDev2",
                "lastName": "RTDev2",
                "loginId": "47483650",
                "mediaType": "1",
                "state": "READY",
                "stateChangeTime": "2019-12-24T14: 00: 06.287Z",
                "uri": "/finesse/api/User/47483650",
                "teamId": "5003"
            }
        }
    },
    "event": "READY",
    "source": "event"
}