List online users
Provides the current status of online users. The request can be project-specific or can be applied to all projects. Only agents logged into that project as primary will be returned when filtered for a project.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/onlineusers |
| Options | N/A |
| Body | N/A |
| Response | |
| Body | Requested user-based status information, encoded in JSON |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| projectID | string | no | The project ID of the project you want to have your request targeted at. |
| softLimitReached | boolean | no | Indicates whether soft limit is reached. |
| hardLimitReached | boolean | no | Indicates whether hard limit is reached. |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| userid | integer | The user’s unique identifier in VCC’s database. |
| username | string | The user’s username. |
| state | string | User state that indicates the system state of the individual agent. |
| stateDuration | integer | The time spent in the current user state, in seconds. |
| stateChangedAt | string | The last time when the user changed state |
| auxId | integer | The ID of the exact break the agent is on, in case the state is AUX. |
| softLimitReached | boolean | Indicates whether soft limit is reached. If the user status is related to a secondary project, then the limit reflects that project’s settings. |
| hardLimitReached | boolean | Indicates whether hard limit is reached. If the user status is related to a secondary project, then the limit reflects that project’s settings. |
Example
URL: https://mycc.asp.virtual-call-center.eu/v2/onlineusers/123
{
"response": [
{
"userId": 155,
"username": "vcc_john_doe_op",
"state": "AVAILABLE4CALL",
"stateDuration": 3,
"auxId": null,
"stateChangedAt": "2024-05-10T17:55:38+02:00",
"softLimitReached": false,
"hardLimitReached": false
},
{
"userId": 33,
"username": "teszt_elek_op",
"state": "AUX",
"auxId": 1235,
"stateDuration": 50,
"stateChangedAt": "2024-11-20T15:49:41+01:00",
"softLimitReached": false,
"hardLimitReached": false
}
],
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.