Fetches queue depth, agent availability and entrypoint status.

Overview

Checks if new chats can be processed by a given chat entry point based on the following conditions:

  1. Chat entry point is active.
  2. If there are any agents available to work on new chat activities.
  3. If queue associated with that entry point has reached its configured maximum depth i.e. total number of chats getting processed by the queue is equal to the maximum number of chats that queue can process at any given point of time.

Use this API to decide to show or hide the chat link on the website based on state of chat entry point, agent availability and whether queue associated with the given entry point can accept more chats.

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}/chatallowed
Request samples
Response samples
application/json
This example demonstrates the following:


    

  • Checks if new chats can be processed by a given chat entry point
    • 

  • This attribute can have value either true or false. If it is true, that means this entry point can handle new chats. If it is false, that means this entry point cannot handle new chats.
    • 



{
  • "allowed": true
}