List users
List all users in VCC’s database.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/users |
| Options | N/A |
| Body | N/A |
| Response | |
| Body | Array of users, encoded in JSON |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your call centre’s unique identifier (subdomain). |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| extension | string | The user’s extension. |
| group_name | string | User’s group, as defined by the supervisor. |
| groupid | integer | User’s groupid. |
| hourly | integer | Agent’s hourly wage. |
| is_agent | boolean | Shows whether the user is an agent. |
| name | string | Name of the user. |
| projectIds | array | the IDs of the project that the user is assigned to. |
| status | string | User status, defining whether the user can log in or not. Possible values: – active – inactive |
| teams_name | string | Name of the user’s team, as defined by the supervisor. |
| userid | integer | The user’s unique identifier in VCC’s database. |
| username | string | The user’s username. |
| custom_data | object | Any custom data created for users, if any. |
Example
URL: https://mycc.asp.virtual-call-center.eu/v2/users
{
"response": [
{
"status": "active",
"name": "Peter Green",
"username": "peter",
"extension": "4",
"userid": 4,
"hourly": 0,
"is_agent": true,
"teams_name": "default_team",
"groupid": 2,
"group_name": "admin"
},
{
"status": "active",
"name": "Michaela Cooper",
"username": "michaela_supervisor",
"extension": "5",
"userid": 5,
"hourly": 0,
"is_agent": true,
"teams_name": "default_team, Google_external_team",
"projectIds": [
"275",
"276",
"279",
"280",
"1",
"282",
"283"
],
"groupid": 3,
"group_name": "supervisor"
},
{
"status": "active",
"name": "Alexandra",
"username": "g_alexandra",
"extension": "5",
"userid": 5,
"hourly": 1200,
"is_agent": true,
"teams_name": "default_team, Google_external_team",
"projectIds": [
"275",
"276",
"1",
"282",
"283"
],
"groupid": 4,
"group_name": "operator"
}
],
"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.