Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Intelligent Quality Check/ speedrule/ POST /CCSQM/rest/ccisqm/v1/speedrule/addSpeedRule
Updated on 2023-09-27 GMT+08:00
View PDF
Share

POST /CCSQM/rest/ccisqm/v1/speedrule/addSpeedRule

Scenario

This interface is invoked to add a speed rule.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/speedrule/addSpeedRule (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

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

No

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.
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

setting

Object

Yes

Basic information

1.1.1

name

String

Yes

Speed rule name

1.1.2

score

Number

Yes

Points deducted due to violation. The value ranges from 0 to 100.

1.1.3

min

Number

Yes

Minimum speed. The value ranges from 1 to 220.

1.1.4

max

Number

Yes

Maximum speed. The value ranges from 1 to 2147483647.

1.1.5

other

Object

No

Trigger conditions

1.1.5.1

call_from

Number

No

Call start time

The value is a timestamp, in seconds.

1.1.5.2

call_end

Number

No

Call end time

The value is a timestamp, in seconds.

1.2

exception

Object

Yes

Exception settings

1.2.1

under

Object

Yes

Sentences said by the customer when the speed is less than the minimum limit

1.2.1.1

customer

Array [String]

No

IDs of sentences said by the customer

1.2.2

over

Object

Yes

Sentences said by the customer when the speed is greater than the maximum limit

1.2.2.1

customer

Array [String]

No

IDs of sentences said by the customer

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

speed_id

String

No

ID of the added speed rule

1.2

resultCode

String

No

Return code. The value 0405000 indicates success, and other values indicate failure.

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 speed rule.

    Request header:

    x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************  
x-TenantSpaceId:202101124979

    Request parameters:

    {
	"setting": {
		"name": "APIcs",
		"score": 4,
		"min": 80,
		"max": 120,
		"other": {
			"call_from": 1622515590,
			"call_end": 1625021193
		}
	},
	"exception": {
		"under": {},
		"over": {}
	}
}

    Response parameters:

    {
	"resultCode": "0405000",
	"speed_id": "925095745760006144",
	"resultDesc": "Operation successful."
}
Parent topic: speedrule