Guardian Users API
Overview
The Guardian Users API, a Talkdesk Guardian™ solution, provides all the information Guardian has about the users of an account (name, role, ring groups, creation place, user activation, status, and the user's overall call quality).
Use Case
As a real life example, consider the scenario where a company needs a list of users that have been added and from those, the company wants to see the ones that have activated their account. The company might also have the need to know to which roles and ring groups the users belong to, as well as their status (online, offline, etc.). The Guardian Users API provides all the relevant information to enable the company to make informed decisions on the agents' management.
Usage
All users
Getting a list with users’ information available for all users of a certain account.
The intended results can be filtered and sorted. The response can be in JSON
format or it can be a CSV file.
User by identifier
Getting all information available for the user of the account with the requested ID. The {id}
in the URL is replaced with the desired user ID. The results can be filtered and sorted.
User roles history
Getting a list with all the role changes in the timeline of the requested user. The {id}
in the URL is replaced with the desired user ID. The results can be filtered and sorted.
API Availability
The Guardian Sessions API has been in General Availability since August 2021.
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.
Updated 12 months ago