Rate this page:

GetUsersRequest

Props

acdQueueId

Copy URL
acdQueueId: 

number

|

undefined

The ACD queue ID to filter

acdStatus

Copy URL
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

Copy URL
applicationId: 

number

The application ID to filter

applicationName

Copy URL
applicationName: 

string

The application name part to filter

count

Copy URL
count: 

number

|

undefined

The max returning record count

excludedAcdQueueId

Copy URL
excludedAcdQueueId: 

number

|

undefined

The excluded ACD queue ID to filter

excludedSkillId

Copy URL
excludedSkillId: 

number

|

undefined

The excluded skill ID to filter

offset

Copy URL
offset: 

number

|

undefined

The first N records are skipped in the output

orderBy

Copy URL
orderBy: 

string

|

undefined

The following values are available: 'user_id', 'user_name' and 'user_display_name'

returnLiveBalance

Copy URL
returnLiveBalance: 

false

|

undefined

|

true

Whether to get the user live balance

showingSkillId

Copy URL
showingSkillId: 

number

|

undefined

The skill to show in the 'skills' field output

skillId

Copy URL
skillId: 

number

|

undefined

The skill ID to filter

userActive

Copy URL
userActive: 

false

|

undefined

|

true

Whether the user is active to filter. Inactive users cannot log in to applications

userDisplayName

Copy URL
userDisplayName: 

string

|

undefined

The user display name part to filter

userId

Copy URL
userId: 

number

|

undefined

The user ID to filter

userName

Copy URL
userName: 

string

|

undefined

The user name part to filter

withQueues

Copy URL
withQueues: 

false

|

undefined

|

true

Whether to get the bound queues

withSkills

Copy URL
withSkills: 

false

|

undefined

|

true

Whether to get the bound skills