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

POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveWord

Scenario

This interface is invoked to add a sensitive word.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveWord (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

sw_name

String

Yes

Sensitive word name

1.2

score

Number

No

Sensitive word score

1.3

exception

Object

No

Sensitive word exception

1.3.1

customer

Array [String]

No

Sentence said by the customer

1.3.2

staff

Array [String]

No

Sentence said by the agent

1.4

category_id

String

Yes

Unique ID of a sensitive word category

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

sw_id

String

No

Unique ID of a sensitive word

1.2

resultCode

String

No

Return code

  • 0401000: success
  • Others: 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 sensitive word.

    Request header:

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

    Request parameters:

    {
	"category_id": "923002678840135680",
	"sw_name": "test11",
	"score": -4,
	"exception": {
		"customer": ["14166"],
		"staff": []
	}
}

    Response parameters:

    {
	"resultCode": "0401000",
	"sw_id": "923007085031985152",
	"resultDesc": "Operation successful."
}
Parent topic: sensitiveWordManage