The users API is part of Voiso's User Management APIs. Use it to obtain a list of all agent names and IDs. Please refer to the detailed API endpoint specification here.
The users API requires the base URL and the user API key.
The users API uses the key parameter: the user API key representing the user making the request. Based on the user's permissions configured, Voiso provides the data allowed for that particular user.
Simple HTTP request example:
https://cluster1.voiso.com/api/v3/cdr/users ?key=cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3
The users API also enables you to apply filters to the GET request. The following filters are supported:
| Parameter | Description | Type | Required | Notes |
|---|---|---|---|---|
| name | The name of the user. | string | Optional | Get only information for the specified user. |
| The email address of the user. | string | Optional | Get only information for the user based on the specified sign-in email address. | |
| sip_account | The SIP server address for the user's WebRTC Softphone. | string | Optional | Get only information for the user based on the specified SIP server address. |
| sag | The user's role. | string | Optional | Get only information for the users who are assigned to the specified security access group. |
| extension | The WebRTC extension of the user. | string | Optional | Get only information for the user based on the specified contact center extension. |
| caller_id | The Caller ID group of the user. | string | Optional | Get only information for the users who are assigned to the specified caller ID group. |
| timezone | The time zone of the user. | string | Optional | Get only information for the users who are assigned to the specified time zone. |
Full HTTP request example:
https://cluster1.voiso.com/api/v3/cdr/users ?key=cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3&name=<string>&email=<string>&sip_account=<string>&sag=<string>&extension=<string>&caller_id=<string>&timezone=<string>
JSON request example:
{
"method": "GET",
"url": "https://cluster1.voiso.com/api/v3/cdr/users",
"params": {
"key": "cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3",
"name": "<string>",
"email": "<string>",
"sip_account": "<string>",
"sag": "<string>",
"extension": "<string>",
"caller_id": "<string>",
"timezone": "<string>"
}
}
The following table describes the elements of the response.
| Element | Description | Type | Notes |
|---|---|---|---|
| id | The ID assigned by the system when the user is created. | number | |
| name | The name of the user, corresponding to the Name field in the User profile. | string | |
| The email address the agent uses to sign in to Voiso. | string | ||
| sip_account | The SIP address of the user's softphone. | string | |
| sag | The name of the Security Access Group to which the user is assigned. | string | |
| extension | The contact center extension used to route calls to the user. | string | |
| caller_id | The name of the caller ID group to which the user is assigned. | string | |
| timezone | The name of the time zone selected for the user. | string | |
| webrtc_ringtone | The name of the ringtone assigned to the user. | string | |
| agent_in_teams | A comma-separated list of the IDs of the Teams to which the user is assigned. | string | Use the Teams API to obtain the team IDs. |
| supervisor_in_teams | A comma-separated list of the IDs of the Teams that the user supervises. | string | Use the Teams API to obtain the team IDs. |
| assigned_skills | An object containing an array of the names of the skills and the assigned skill level. | object | The skills are returned as a comma-separated list of key-value pairs, both of type string in this format: "name": "number" |
| assigned_queues | A comma-separated list of queue names. | string | |
| employee_id | The value assigned to the user in the Employee ID field of the user profile. | string |
{
"id": 28982,
"name": "AG D",
"email": "ag@g.com",
"sip_account": "ag@cc1.email.net",
"sag": "Agent",
"extension": "2594",
"caller_id": "378",
"timezone": "Istanbul",
"webrtc_ringtone": "null,",
"agent_in_teams": "3623, 7850",
"supervisor_in_teams": "Support",
"assigned_skills": {
"Claims": "1",
"Technical": "10",
"Mandarin": "1"
},
"assigned_queues": "AG Queue, Support",
"employee_id"": "123"
}
The following issues are sometimes encountered:
The users API requires the user API key to validate the request. If you see this error, "error": "Invalid User API Key", check that you use the correct user API key. For more information about API keys, refer to Authentication.
Was this page helpful?