Get Online Agents
GET {{baseUrl}}/v1/onlineAgents?departmentId=<long>
This API lists the agents who are currently online 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 value is 20 and the maximum value allowed is 6000. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"chatStatus":"ONLINE","agentId":"892000000008734","phoneMode":"WEB","phoneStatus":"ONLINE","mailStatus":"OFFLINE","presenceStatus":"ONLINE","status":"ONLINE"},{"chatStatus":"ONLINE","agentId":"8920000000056010","phoneMode":"WEB","phoneStatus":"ONLINE","mailStatus":"OFFLINE","presenceStatus":"ONLINE","status":"ONLINE"}],"totalAgentsCount":"2","hasMore":false}