Get Current Availability
GET {{baseUrl}}/v1/agentAvailability?departmentId=<long>
This API lists the current availability of agents in a particular department.
OAuth Scope
Desk.settings.READDesk.basic.READ
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
departmentId | string | ID of the department from which the availability details should be fetched. To include all accessible departments, pass the value of this key as -1. | |
include | string | Key that includes additional, channel-specific information. Values allowed are: mailStatus, phoneStatus, phoneMode, chatStatus, and presenceStatus. | |
limit | string | Number of agents to list. The default and the maximum value allowed is 20. | |
from | string | Index number, starting from which the agents must be fetched. The default value is 0 and the maximum value allowed is 5999. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"chatStatus":"OFFLINE","agentId":"892000000008734","phoneMode":"WEB","phoneStatus":"OFFLINE","mailStatus":"OFFLINE","presenceStatus":"ONLINE","status":"OFFLINE"},{"chatStatus":"ONLINE","agentId":"8920000000056010","phoneMode":"WEB","phoneStatus":"ONLINE","mailStatus":"OFFLINE","presenceStatus":"ONLINE","status":"ONLINE"}],"totalAgentsCount":"2","hasMore":false}