Querying Agent Information by Skill Queue ID (queryAgentInfoBySkillId)
Scenario
Query agent information in a skill queue based on the skill queue ID.
Method
POST
URI
https://Domain name/apiaccess/rest/cc-management/v1/agentAccount/queryAgentInfoBySkillId. For example, the domain name is service.besclouds.com.
Request Description
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
x-app-key |
String |
No |
App key field, which is the user ID. Contact the operation personnel to obtain the app key. |
2 |
Authorization |
String |
Yes |
Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.) |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
requestParam |
Object |
Yes |
Request parameter. |
1.1 |
skillId |
Integer |
Yes |
Skill queue ID. |
1.2 |
pageSize |
Integer |
Yes |
Page size. The maximum value is 100. |
1.3 |
pageNum |
Integer |
Yes |
Page number, starting from 0. |
Response Description
- Status code: 200
Table 3 Response body parameters No.
Parameter
Type
Mandatory or Not
Description
1
schema
Object
Yes
Successful request.
1.1
data
Array (object)
No
Returned data.
1.1.1
workNo
Number
No
Employee ID.
1.1.2
agentType
Number
No
Agent type.
4: audio agent
11: video agent
5: multimedia agent
99: versatile agent
1.1.3
agentWeight
Number
No
Agent weight. A larger weight indicates a higher priority. The minimum value is 1.
1.1.4
accountName
String
No
User name.
1.1.5
sipAccount
String
No
Softphone number.
1.1.6
skillWeight
Number
No
Skill queue weight. The minimum value is 1.
1.1.7
userAccount
String
No
Agent account, which is the same as the agent account for creating an agent.
1.2
count
Integer
No
Number of agents whose information is queried.
1.3
resultCode
String
No
If the request is successful, 0 is returned. If the request fails, 1 is returned, and resultMessage carries the error cause.
- Status code: 400
Incorrect request. Check the request path and parameters.
- Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
- Status code: 404
The requested content is not found. Check the request path.
- Status code: 500
Business failure. Check the values of parameters in the request.
Error Codes
None
Example
Scenario description: Query agent information by skill queue ID.
Request parameters:
{ "skillId":3, "pageSize":10, "pageNum":0 }
Response parameters:
{"data": [ { "workNo": 107, "accountCode": "xxxxx", "agentType": 4, "agentWeight": 1, "accountName": "xxxxx", "sipAccount": "88880006", "skillWeight": 1 } ], "count": 1, "resultCode": "0" }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot