Interface AgentAvailability

Information about the current availability of an agent while a user is waiting to be connected. If these are not set the web chat will provide generic messaging letting the user know that a request for an agent has been sent.

Note that only one of these fields will be used by web chat if more than one has been assigned a value. Priority first goes to estimated_wait_time, then position_in_queue, and then message.

interface AgentAvailability {
    estimated_wait_time?: number;
    message?: string;
    position_in_queue?: number;
}

Properties

estimated_wait_time? message? position_in_queue?

Properties

Optionalestimated_wait_time

estimated_wait_time?: number

The estimated wait time for the user in minutes. E.g. "Current wait time is 2 minutes."

Optionalmessage

message?: string

A custom message to display to the user containing the updated status. This may contain markdown.

Since

Web chat 6.7.0. This value will be ignored if used with earlier versions of web chat.

Optionalposition_in_queue

position_in_queue?: number

The current position of the user in a queue. E.g. "You are number 2 in line."

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR