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

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

Scenario

This interface is invoked to delete a dialog rule by ID.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/deleteRule (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

x-app-key

String

No

App key ID

1

Content-Type

String

No

The value is fixed to application/json; charset=UTF-8.

2

x-app-key

String

Yes

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

rule_id

String

Yes

Rule ID

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

resultCode

String

No

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

1.2

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: Delete a dialog rule by ID.

    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": "rutuy",
    	"description": "3",
    	"flows": [null]
    }

    Response parameters:

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