Checks eliglibility of chat entrypoint to handle new chats.

Overview

Checks eligibility of a chat entry point to handle new chat activities based on the following conditions:

  1. If there are any agents available to work on new chat activities.
  2. If the 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 the 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 agent availability and whether queue associated with the given entry point can accept more chats. This API get queue depth and agent availability of requested chat entry point ID. Please note that it returns response considering text chat only.

SecurityoAuthAnonymousCustomer
Request
path Parameters
id
required
string <= 255 characters

id of object

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

Content type accepted by client.

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

Language locale accepted by 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

  • Entry point eligibility is returned. This is identified by value of the attribute responseType. This attribute can have any one of the following values
    • 0 - The queue associated with this entry point can handle new chats.
    • 1 - No agent is available to work on new chats.
    • 2 - Maximum queue depth has reached for the queue associated with the given entry point and no new chats will be processed.
400

Bad Request

406

Not Acceptable

500

Internal server error

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

  • This example is to check the eligibility of a chat entry point to handle new chat activities.
    • 

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



{
  • "responseType": 0
}