ListAdherenceAgentStates

Gets the agent states for the given @wfm_agent_sids from the given @start_datetime to the @end_datetime
or the current time if not set (start time not inclusive, end time inclusive).
Agent states will be grouped by wfm_agent_sid and ordered by date in ascending order.
It also returns the latest datetime amongst all the states returned.
It can also include the violations against the published schedule for each of the requested agents if @include_violations is set to True.
Errors:

grpc.Invalid: arguments in the request are invalid.

grpc.Internal: error occurs when getting the states.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "agent_states": {
        "property1": {
            "agent_states": [
                {
                    "wfm_agent_sid": 0,
                    "start_datetime": "1s",
                    "adm_states": [
                        "UNSPECIFIED"
                    ],
                    "pause_code": "string"
                }
            ]
        },
        "property2": {
            "agent_states": [
                {
                    "wfm_agent_sid": 0,
                    "start_datetime": "1s",
                    "adm_states": [
                        "UNSPECIFIED"
                    ],
                    "pause_code": "string"
                }
            ]
        }
    },
    "latest_agent_state_datetime": "1s",
    "agent_state_violations": {
        "property1": {
            "violations": [
                {
                    "wfm_agent_sid": 0,
                    "start_datetime": "1s",
                    "expected_rtm_states": [
                        "UNSPECIFIED"
                    ],
                    "expected_pause_code": "string",
                    "actual_rtm_states": [
                        "UNSPECIFIED"
                    ],
                    "actual_pause_code": "string",
                    "violation_duration_seconds": 0,
                    "expected_pause_codes": [
                        "string"
                    ],
                    "adherence_agent_state_violation_id": 0,
                    "expected_scheduling_activity_sid": 0,
                    "expected_reason_code_id": 0,
                    "actual_scheduling_activity_sid": 0,
                    "actual_reason_code_id": 0,
                    "resolved_activity_sid": 0,
                    "resolved_reason_code_id": 0,
                    "resolution_comment": "string",
                    "resolved_by_user_id": "string"
                }
            ]
        },
        "property2": {
            "violations": [
                {
                    "wfm_agent_sid": 0,
                    "start_datetime": "1s",
                    "expected_rtm_states": [
                        "UNSPECIFIED"
                    ],
                    "expected_pause_code": "string",
                    "actual_rtm_states": [
                        "UNSPECIFIED"
                    ],
                    "actual_pause_code": "string",
                    "violation_duration_seconds": 0,
                    "expected_pause_codes": [
                        "string"
                    ],
                    "adherence_agent_state_violation_id": 0,
                    "expected_scheduling_activity_sid": 0,
                    "expected_reason_code_id": 0,
                    "actual_scheduling_activity_sid": 0,
                    "actual_reason_code_id": 0,
                    "resolved_activity_sid": 0,
                    "resolved_reason_code_id": 0,
                    "resolution_comment": "string",
                    "resolved_by_user_id": "string"
                }
            ]
        }
    },
    "diagnostics": [
        {
            "level": "INFORMATION",
            "code": "GENERAL",
            "message": "string",
            "source_entity": {
                "parent_sid": 0,
                "parent_type": "CALL_CENTER_NODE"
            }
        }
    ]
}

🟢200Success