Fetches agent availability.

Overview

This is an API to display chat options based on the agent’s availability. Check if there are any available agents who can handle chats that start from a specific entry point. This API fetches agent availability status based on text chat only. For instance, if an agent is only available for video chat, then this API returns the agent availability status as false. This API also returns Business Calendar information, if applicable. If the current time is within the business hours, then it returns the agent availability state as true along with the business hours closing time, otherwise the state is returned as false along with the date and time when the business hours will be open next.

SecurityoAuthAnonymousCustomer
Request
path Parameters
id
required
string <= 255 characters

id of object

Example: 1000
query Parameters
businessCalendar
boolean

flag for getting business hours

Example: businessCalendar=true
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 agent availability status is returned. A True response means that an agent is available. A False response means that no agent is available. If the Business Calendar is applicable and the business hours are open, then the state is returned as true along with the business hours closing time. If the Business Calendar is applicable and the business hours are closed, then the state is returned as false along with the immediate business hours opening date and the time in UTC. If the Business Calendar is not applicable, then only the agent availability is returned.
400

Bad Request

406

Not Acceptable

500

Internal server error

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

  • This example demonstrates getting the agent availability status along with the Business Calendar information during business hours.
    • 

  • GET   /conversation/messagerouter/v3/entrypoint/1000/agentavailability?businessCalendar=true
    • 



{
  • "available": true,
  • "businesscalendar": {
    }
}