Fetches capacity of all agents.

Overview

This is an API for display chat option based on agent capacity for chats. Fetches the capacity of all agents to work on new chat activities in the queue of the given entry point. This API returns the difference between the maximum load that all agents can take and the current load of all agents in the queue of the entry point. Use this API to decide if we need to show the Chat button or offer new chats to customers only when there are agents available to take more work.

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

  • The remaining capacity of agents for the entry point is returned. A positive number reflects the remaining capacity. Zero means either there are no agents available in the system, or all agents are working to their maximum load.
400

Bad Request

406

Not Acceptable

500

Internal server error

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

  • This example is to get the capacity of all agents to work on new chat activities.
    • 

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



{
  • "count": 1
}