Class

AggregateQueueState

AggregateQueueState

Members

Array.<string>

# nullable medias

An array of media types through which operators are accessible. Possible values are Engagement#MEDIA_TYPES.

Only defined when the state is CAN_QUEUE.

object

# QUEUE_STATES

Properties:
Name Type Description
CAN_QUEUE string
CANNOT_QUEUE string
QUEUED string
string

# state

Current state of the queue. One of AggregateQueueState#QUEUE_STATES.
QueueTicket

# nullable ticket

A {QueueTicket} instance that acts as a token for visitor's spot in the queue.

Only defined when the state is QUEUED.

object

# TRANSITION_REASONS

Properties:
Name Type Description
ENGAGED string Visitor successfully engaged with operator
CANCELED string Visitor abandoned the queue
UNSTAFFED string All operators became unavailable
CLOSED string Queue was closed by administrative action
DISCONNECTED string Visitor disconnected
FAILED string Visitor failed to enqueue
ALREADY_QUEUED string Visitor can have multiple concurrent sessions browsing the application. This reason indicates that the visitor has already entered the queue from another session.
FORBIDDEN string Visitor is forbidden to enqueue. For example when the Visitor was banned while queued.
string

# nullable transitionReason

The reason of transition from the previous to the current state. One of AggregateQueueState#TRANSITION_REASONS.