Updated on 2023-09-27 GMT+08:00

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

Scenario

This interface is invoked to update a dialog rule.

Method

POST

URI

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

severity

String

Yes

Rule level. The options are normal and critical.

1.2

rule_id

String

Yes

Rule ID

1.3

score

Number

Yes

Rule score

1.4

other

Object

Yes

Additional conditions

1.4.1

call_end

Number

No

Call start timestamp, in seconds

1.4.2

call_from

Number

No

Call end timestamp, in seconds

1.5

min

Number

Yes

Minimum number of dialog logics

1.6

method

String

Yes

Whether a rule is a positive or negative

The options are positive and negative.

1.7

rule_name

String

No

Rule name

1.8

resultCode

String

No

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

1.9

description

String

No

Rule description

1.10

resultDesc

String

No

Return description

1.11

score_type

String

Yes

Rule score type

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

resultDesc

String

No

Return description

1.2

resultCode

String

No

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

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

    Request header:

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

    Request parameters:

    {
    	"severity": "normal",
    	"rule_id": "923084039932350464",
    	"score": 1,
    	"other": {},
    	"min": 1,
    	"method": "positive",
    	"rule_name": "tesat3",
    	"flows": [],
    	"resultCode": "0405000",
    	"description": "4",
    	"completeness": {
    		"hasConversationFlow": false,
    		"sentenceComplete": false,
    		"ruleComplete": false,
    		"hasDescription": true
    	},
    	"resultDesc": "Operation successful."
    	"score_type": "valid"
    }

    Response parameters:

    {
    	"resultCode": "0405000",
    	"resultDesc": "Operation successful."
    }