The teams API is part of Voiso's User Management APIs. Use it to obtain a list of all team names and IDs.
Please refer to the detailed API endpoint specification here.
Making requests
Authentication
The teams API requires the base URL and the user API key.
Request parameters
The teams 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.
HTTP request example:
https://cluster1.voiso.com/api/v2/cdr/teams
?key=cc7c76b8987a27a...b00ab6c3
JSON request example:
{
"method": "GET",
"url": "https://cluster1.voiso.com/api/v2/cdr/teams",
"params": {
"key": "cc7c76b8987a27ab5...b89b00ab6c3"
}
}
Response
The following table describes the elements of the response.
| Element | Description | Type | Notes |
|---|---|---|---|
| name | The name of the team. | string | |
| id | The ID assigned by the system when the team is created. | number |
Response sample
[
{
"name": "Dayshift",
"id": 5915
},
{
"name": "Nightshift",
"id": 6045
},
{
"name": "Marketing",
"id": 8530
},
{
"name": "Support team",
"id": 8413
]
Troubleshooting
The following issues are sometimes encountered:
Invalid User API Key
The teams 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.