:JSON response parameters

Parameter

Description

Example value

inWaitingRoom

Indicates whether the current request is in the waiting room. The value is true.

true

waitTime

The wait time for the current request, in minutes. The value is an integer greater than or equal to 0. The wait time is determined by the following factors:

• Waiting room configuration

  • Total number of active users

  • Number of new users per minute

  • Session duration

  • Whether session renewal is disabled

  • Queuing method

• Actual user access patterns

• Origin server processing payload

In some cases, such as when the number of requests is low, the system may not be able to estimate the wait time. In this situation, `waitTime` is set to 0.

5

waitTimeKnown

Indicates whether the wait time for the current request can be estimated.

• true: The wait time can be estimated.

• false: The wait time cannot be estimated.

true

waitTimeFormatted

The format of the wait time for the current request. The parameter value can be one of the following:

• A number and a unit, such as 5 minutes. This indicates the estimated wait time.

• A time range, such as 3 minutes to 5 minutes. This indicates the approximate range of the wait time.

• unknown: The wait time cannot be estimated.

5 minutes

3 minutes to 5 minutes

queueIsFull

Indicates whether the waiting room queue is full. This status is set to true when the estimated queue time exceeds 24 hours. Valid values:

• true: The queue is full.

• false: The queue is not full.

false

queueAll

Indicates whether the waiting room is configured to queue all requests. Valid values:

• true: The waiting room queues all requests.

• false: The waiting room does not queue all requests.

false

lastUpdated

The last update time of the JSON response for the current request.

2024-09-10T12:00:00.000Z

refreshIntervalSeconds

The required refresh interval for the current request, in seconds. Refreshing at this interval ensures that the request remains properly queued.

20