post https://{domainname}/ca_apis/getAgentLogins
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.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
Header parameters
| Parameter | Description |
|---|---|
| Content-Type | application/json |
Body Params
{
"userName": "xxxxxx"
}
Possible responses
| 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" }, ] } |
| 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" } |