GetUsersRequest
Props
acdQueueId
acdQueueId: number
| undefined
The ACD queue ID to filter
acdStatus
acdStatus: string
| string[]
The ACD status list separated by semicolons (;) to filter. The following values are possible: OFFLINE, ONLINE, READY, BANNED, IN_SERVICE, AFTER_SERVICE, TIMEOUT, DND
applicationId
applicationId: number
The application ID to filter
applicationName
applicationName: string
The application name part to filter
count
count: number
| undefined
The max returning record count
excludedAcdQueueId
excludedAcdQueueId: number
| undefined
The excluded ACD queue ID to filter
excludedSkillId
excludedSkillId: number
| undefined
The excluded skill ID to filter
offset
offset: number
| undefined
The first N records are skipped in the output
orderBy
orderBy: string
| undefined
The following values are available: 'user_id', 'user_name' and 'user_display_name'
returnLiveBalance
returnLiveBalance: false
| undefined
| true
Whether to get the user live balance
showingSkillId
showingSkillId: number
| undefined
The skill to show in the 'skills' field output
skillId
skillId: number
| undefined
The skill ID to filter
userActive
userActive: false
| undefined
| true
Whether the user is active to filter. Inactive users cannot log in to applications
userDisplayName
userDisplayName: string
| undefined
The user display name part to filter
userId
userId: number
| undefined
The user ID to filter
userName
userName: string
| undefined
The user name part to filter
withQueues
withQueues: false
| undefined
| true
Whether to get the bound queues
withSkills
withSkills: false
| undefined
| true
Whether to get the bound skills