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

POST /CCSQM/rest/ccisqm/v1/conversation-rules/addRule

Scenario

This interface is invoked to create a dialog rule.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/addRule (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

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

No.

Parameter

Type

Mandatory or Not

Description

1.1

rule_name

String

Yes

Rule name

1.2

description

String (1024)

No

Rule description

1.3

severity

String

Yes

Rule level. The options are normal and critical.

1.4

score_type

String

Yes

Score type

  • valid
  • invalid

1.5

score

Number

Yes

Rule score

1.6

method

String

Yes

The options are as follows:

  • positive
  • negative

1.7

min

Number

Yes

Minimum number of dialog logics

1.8

other

Object

Yes

Other content

1.8.1

call_from

Number

No

Call start timestamp, in seconds

1.8.2

call_end

Number

No

Call end timestamp, in seconds

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

rule_id

String

No

Rule ID

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: Create a dialog rule.

    Request header:

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

    Request parameters:

    {
	"severity": "normal",
	"score_type": "valid",
	"method": "positive",
	"score": 1,
	"min": 1,
	"other": {},
	"rule_name": "aseew",
	"description": "3"
}

    Response parameters:

    {
	"rule_id": "923084345118298112",
	"resultCode": "0405000",
	"resultDesc": "Operation successful."
}
Parent topic: conversationrules