POST /CCSQM/rest/ccisqm/v1/regularqualitytask/addQualityTask
Scenario
This interface is invoked to add a scheduled sample inspection plan.
Method
POST
URI
https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/regularqualitytask/addQualityTask (For example, the domain name is service.besclouds.com.)
Request Description
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
Content-Type |
String |
No |
The value is fixed to application/json; charset=UTF-8. |
2 |
x-app-key |
String |
No |
App key |
3 |
Authorization |
String |
Yes |
Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.) |
4 |
x-UserId |
String |
Yes |
Operator ID You can sign in to the system and go to the employee management page to view the value of userId returned by an interface. |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
appointQuality |
Object |
Yes |
Inspectors to be assigned |
1.1.1 |
setCounts |
Array [Object] |
Yes |
Inspectors |
1.1.1.1 |
count |
Number |
No |
Quantity. The value can contain a maximum of eight characters.
|
1.1.1.2 |
personID |
String |
Yes |
Inspector ID. The value can contain a maximum of 64 characters. |
1.1.2 |
setCountsType |
Integer |
Yes |
Quantity type. The options are 0 (on average) and 2 (by percentage). |
1.2 |
cronStructure |
Object |
Yes |
Period |
1.2.1 |
qiqtCycleType |
String |
Yes |
Repetition mode. The options are 1 (daily), 2 (weekly), and 3 (monthly). |
1.2.2 |
qiqtEndTime |
Integer |
No |
End time, in seconds. This parameter is valid when qiqtEndType is set to 2. The value can contain a maximum of 10 digits. |
1.2.3 |
qiqtEndType |
String |
Yes |
End condition. The options are 1 (number of times) and 2 (time). |
1.2.4 |
qiqtStartTime |
Integer |
Yes |
Start time, in seconds. The value can contain a maximum of 10 characters. |
1.2.5 |
qiqtTotalTimes |
Integer |
No |
Number of times a scheduled task is executed. The value can contain a maximum of eight characters. When qiqtEndType is set to 1, qiqtTotalTimes is mandatory. |
1.3 |
currentRole |
String |
No |
User role |
1.4 |
extractionRange |
Object |
Yes |
Sample inspection scope |
1.4.1 |
currentRole |
String |
No |
User role |
1.4.2 |
fixedColumns |
Object |
Yes |
Sample inspection scope |
1.4.2.1 |
qualityType |
Integer |
Yes |
Sample inspection type. The options are 1 (call scope), 2 (agent quantity), and 3 (agent percentage). |
1.4.2.2 |
durationStart |
Integer |
No |
Minimum call duration, in milliseconds. The value can contain a maximum of 11 characters. |
1.4.2.3 |
qualityNum |
String |
Yes |
Sample inspection quantity. The value can contain a maximum of eight characters. |
1.4.2.4 |
qualityCondition |
Integer |
Yes |
Sample inspection status. The options are 0 (unlimited), 1 (not sampled), and 2 (sampled). |
1.4.2.5 |
durationEnd |
String |
No |
Maximum call duration, in milliseconds. The value can contain a maximum of 11 characters. |
1.4.2.6 |
maxNum |
String |
No |
Maximum sample inspection quantity. The value can contain a maximum of eight characters. When qualityType is not set to 2, maxNum is mandatory and must be greater than or equal to 1. |
1.4.2.7 |
scoreEnd |
String |
No |
Maximum score. The maximum value is 10000. |
1.4.2.8 |
scoreStart |
String |
No |
Minimum score. The maximum value is 10000. |
1.4.2.9 |
staffIds |
Array [String] |
No |
Agents |
1.4.2.10 |
interactionType |
Integer |
Yes |
Interaction type. The options are as follows:
|
1.4.3 |
userId |
String |
No |
User ID |
1.5 |
qiqtName |
String |
Yes |
Plan name. The value can contain a maximum of 64 characters. |
1.6 |
userId |
String |
No |
User ID |
Response Description
- Status code: 200
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
objId |
String |
No |
Unique ID of a sample inspection plan |
1.2 |
resultCode |
String |
No |
Return code
|
1.3 |
resultDesc |
String |
No |
Return description |
- 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: Add a scheduled sample inspection plan.
Content-Type:application/json x-app-key:xxxx-xxxx-xxx-xxxx x-UserId:xxxxxxxxx Authorization:Bearer ********************************
Request parameters:
{ "extractionRange": { "customColumns": null, "fixedColumns": { "qualityCondition": 0, "qualityType": 1, "qualityNum": 100, "staffIds": ["xxxxxx"], "maxNum": 10, "scoreStart": 0, "scoreEnd": 100, "durationStart": 0, "durationEnd": 100 }, "currentRole": "qualityDirector" }, "appointQuality": { "setCounts": [{ "personID": "xxxx", "count": 40 }, { "personID": "xxxxx", "count": 60 }], "setCountsType": 2 }, "cronStructure": { "qiqtCycleType": 1, "qiqtStartTime": 1609295228.86, "qiqtEndType": 2, "qiqtTotalTimes": 1, "qiqtEndTime": 1609554428 }, "qiqtName": "regulartask", "currentRole": "qualityDirector" }
Response header:
Content-Type: application/json;charset=UTF-8
Response parameters:
{ "objId": "954637368599307266", "resultCode": 0, "resultDesc": "success" }
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