The deleted_users API is part of Voiso's User Management APIs. Use it to obtain a list of agent names and IDs for all the previously deleted agents.
Please refer to the detailed API endpoint specification: Get deleted users
Making requests
Authentication
The deleted_users API requires the Base URL and the API key of a specific user.
Request parameters
The deleted_users API uses the key parameter: the API key of a specific user 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/deleted_agents
?key=cc7c76b8987a27ab5...b89b00ab6c3
JSON request example:
{
"method": "GET",
"url": "https://cluster1.voiso.com/api/v2/cdr/deleted_agents",
"params": {
"key": "cc7c76b8987a27ab5...b89b00ab6c3"
}
}
Response
The following table describes the elements of the response.
| Element | Description | Type | Notes |
|---|---|---|---|
| id | The ID the system assigns when the user is created. | number | |
| name | The name of the former user. | string |
Response sample
[
{
"id": 28982
"name": "Roberta Ride",
}
]
Troubleshooting
The following issues are sometimes encountered:
Invalid User API Key
The deleted 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.