ListAgentStatesForDay

List the real time agent states for published schedule and the org sending the request, starting on the given @start_datetime.
If the @end_datetime is set, all agent state sequences will be returned for the range between @start_datetime and @end_datetime.
If @end_datetime is not set, the agent state sequences will be returned over a 24 hour period or until the current time, whichever is shorter.
DEPRECATED as of Dec/10/2024 - Use ListRealTimeManagementStates instead.
Errors:

grpc.Invalid: the @start_datetime is invalid or beyond the current datetime.

grpc.Internal: error occurs when listing the agent states.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the ListAgentStatesForDay RPC.

start_datetime

string <date-time>

start_datetime

optional

The datetime to start getting agent states from.

Examples:

1s1.000340012s

end_datetime

string <date-time>

end_datetime

optional

An optional parameter.
If set, all agent states will be retrieved for the given datetime range.
If not set, all agent states will be retrieved for either a 24 hour period or until the current time, whichever is shorter.

Examples:

1s1.000340012s

Example

{
    "start_datetime": "1s",
    "end_datetime": "1s"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the ListAgentStatesForDay RPC.

agent_states

array[object (AgentStateSequence) {3}]

agent_states

optional

The list of requested agent states.

start_datetime

string <date-time>

start_datetime

optional

The datetime where the agent state sequence starts.

Examples:

1s1.000340012s

state_segments

array[object (AgentStateSegment) {4}]

state_segments

optional

The list of agent state segments that cover the length of the sequence.

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID of the agent that the real time state sequence relates to.

Example

{
    "agent_states": [
        {
            "start_datetime": "1s",
            "state_segments": [
                {
                    "order_in_rts": 0,
                    "states": [
                        "UNSPECIFIED"
                    ],
                    "width_in_minutes": 0,
                    "width_in_seconds": 0
                }
            ],
            "wfm_agent_sid": 0
        }
    ]
}

🔴500Server Error