Rate this page:

SQ_GetAgentsRequest

Props

applicationId

Copy URL
applicationId: 

number

ID of the application to search by

applicationName

Copy URL
applicationName: 

string

|

undefined

Name of the application to search by. Can be used instead of application_id

count

Copy URL
count: 

number

|

undefined

Number of items to show in the output

excludedSqQueueId

Copy URL
excludedSqQueueId: 

number

|

undefined

ID of the SmartQueue to exclude

excludedSqQueueName

Copy URL
excludedSqQueueName: 

string

|

undefined

Name of the SmartQueue to exclude. Can be used instead of excluded_sq_queue_id

handleCalls

Copy URL
handleCalls: 

boolean

Whether the agent can handle calls. When set to false, the agent is excluded from the CALL-request distribution

offset

Copy URL
offset: 

number

|

undefined

Number of items to skip in the output

sqQueueId

Copy URL
sqQueueId: 

any

|

number

|

number[]

List of SmartQueue IDs separated by semicolons (;). Use 'all' to select all the queues

sqQueueName

Copy URL
sqQueueName: 

string

|

string[]

List of SmartQueue names separated by semicolons (;). Can be used instead of sq_queue_id

sqSkills

Copy URL
sqSkills: 

any

Skills to filter in the json array format. The array should contain objects with the sq_skill_id/sq_skill_name, min_sq_skill_level, and max_sq_skill_level keys where skill levels range from 1 to 5

sqStatuses

Copy URL
sqStatuses: 

any

Filter statuses in the json array format. The array should contain objects with the sq_status_type and sq_status_name keys. Possible values for sq_status_type are 'CALL' and'IM'. Possible values for sq_status_name are 'OFFLINE', 'ONLINE', 'READY', 'IN_SERVICE', 'AFTER_SERVICE', 'DND'

userId

Copy URL
userId: 

any

|

number

|

number[]

List of user IDs separated by semicolons (;)

userName

Copy URL
userName: 

string

|

string[]

List of user names separated by semicolons (;). Can be used instead of user_id

userNameTemplate

Copy URL
userNameTemplate: 

string

|

undefined

Substring of the user name to filter

withSqQueues

Copy URL
withSqQueues: 

false

|

undefined

|

true

Whether to display agent queues

withSqSkills

Copy URL
withSqSkills: 

false

|

undefined

|

true

Whether to display agent skills

withSqStatuses

Copy URL
withSqStatuses: 

false

|

undefined

|

true

Whether to display agent current statuses