Retrieve Queue depth and wait time.

Overview

This is an API for display chat option based on queue depth and wait time. Gets details of the number of chats waiting in the queue for assignment, and the estimated wait time (in seconds)in the queue. Use this API to decide to show or hide the chat link on the website based on wait time and number of chats in the queue.

SecurityoAuthAnonymousCustomer
Request
path Parameters
id
required
string <= 255 characters

id of object

Example: 1000
header Parameters
Accept
required
string
Default: application/json

The content type accepted by the client.

Enum: "application/json" "application/xml"
Accept-Language
required
string

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

400

Bad Request

406

Not Acceptable

500

Internal server error

get/entrypoint/{id}/livesessionstatus
Request samples
Response samples
application/json
    

  • This example is to get the number of chats waiting in the queue for assignment and the estimated wait time.
    • 

  • GET /conversation/messagerouter/v3/entrypoint/1000/livesessionstatus
    • 



{
  • "waitTime": 10,
  • "queueDepth": 2
}