This API retrieves the status of all logged-in agents, providing information about their current state, such as Ready, ACW, or Idle.
❗️
Rate Limit:
A maximum of 5 requests per minute is allowed.
👍
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
| Parameter | Description |
|---|
| apiKey* | Your CloudAgent account API Key |
| Content-Type | application/json |
{
"userName": "xxxxxx"
}
| |
|---|
Success response | {
"status": "success",
"message": [
{
"AgentId": "xxx",
"AgentName": "xxx",
"PhoneNumber": "500994",
"AgentState": "READY",
"SkillName": "General, widget"
},
{
"AgentId": "xxx",
"AgentName": "xxxx",
"PhoneNumber": "xxx",
"AgentState": "READY",
"SkillName": "Hyderabad, offline_hyd, webChat, whatsapp"
},
][
{
"AgentId": "xxx",
"AgentName": "xxx",
"PhoneNumber": "500994",
"AgentState": "READY",
"SkillName": "General, widget"
},
{
"AgentId": "xxx",
"AgentName": "xxxx",
"PhoneNumber": "xxx",
"AgentState": "READY",
"SkillName": "Hyderabad, offline_hyd, webChat, whatsapp"
},
]
} |
If userName is empty | "status": "error"
"message": "userName should not be empty" |
If apiKey is empty | "status": "error"
"message": "apiKey should not be empty" |
If userName or apiKey is invalid | "status": "error"
"message": "userName or apiKey is Invalid" |
If rate limit exceeds | {
"message": "Max limit exceeded",
"status": "error"
} |
