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.
Request example:
GET 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:
name: The name of the user.email : The email address of the user.sip_account: The SIP server address for the user's WebRTC Softphone.sag: The user's role.extension: The WebRTC extension of the user.caller_id: The Caller ID group of the user.timezone: The time zone of the user.Request example:
GET https://cluster1.voiso.com/api/v3/cdr/users ?key=cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3&filter[name]=<string>&filter[email]=<string>&filter[sip_account]=<string>&filter[sag]=<string>&filter[extension]=<string>&filter[caller_id]=<string>&filter[timezone]=<string>
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.