GuardianUsers
Query users in the Talkdesk account via the Guardian API.
Select
The add-in uses the Talkdesk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the add-in.
| Column | Supported Operators |
| Id | =, IN, IS, IS_NOT, NOT_IN |
| Name | =, IN, IS, IS_NOT, LIKE, CONTAINS, NOT_IN |
| =, IN, IS, IS_NOT, LIKE, CONTAINS, NOT_IN | |
| Role | =, IN, IS, IS_NOT, LIKE, CONTAINS, NOT_IN |
| Status | =, IN, IS, IS_NOT, NOT_IN, LIKE, CONTAINS |
| Presence | =, IN, IS, IS_NOT, LIKE, CONTAINS, NOT_IN |
| PresenceType | =, IN, IS, IS_NOT, LIKE, CONTAINS, NOT_IN |
| Risk | =, IN, IS, IS_NOT, NOT_IN |
| CreationTime | =, IS, IS_NOT, <, <=, >, >= |
For example, the following query is processed server-side:
SELECT * FROM GuardianUsers WHERE Id = 'value'
The add-in pushes the ORDER BY clause to the Talkdesk API for the following columns. Sorting on any other column is performed client-side within the add-in.
- Name supports the following sort directions: ASC, DESC.
- Role supports the following sort directions: ASC, DESC.
- Status supports the following sort directions: ASC, DESC.
- CreationTime supports the following sort directions: ASC, DESC.
For example, the following query is sorted server-side:
SELECT * FROM GuardianUsers ORDER BY Name ASC
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the user. | |
| Name | String | The full name of the user. | |
| String | The email address of the user. | ||
| Role | String | The role of the user (e.g. Administrator, Agent). | |
| Status | String | The activation state. Allowed values: ACTIVE, INACTIVE, PENDING. | |
| Presence | String | The current human-readable connection presence (e.g. Available, Offline). | |
| PresenceType | String | The machine-readable presence type (e.g. available, offline). | |
| RingGroups | String | JSON array of ring group names the user belongs to. | |
| Risk | Double | The user risk score. | |
| CreationTime | Datetime | The timestamp when the user account was created. | |
| CallQualityAvgAffectedCalls | Boolean | Indicates if the user has call quality metrics for average affected calls. | |
| CallQualityMosAvg | Double | The average Mean Opinion Score (MOS) for the user's calls, representing overall call audio quality as measured by the system. |