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

POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordsByCategoryId

Scenario

This interface is invoked to obtain the list of sensitive words in a sensitive word category based on its unique ID.

Method

POST

URI

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

category_id

String

Yes

Unique ID of a sensitive word category

1.2

page

Number

Yes

Page number

1.3

limit

Number

Yes

Number of records on each page

  • Value range: 5, 10, 20, 50, and 100

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

paging

Object

No

Pagination information

1.1.1

total

Number

No

Total number of query results

1.2

data

Array [Object]

No

Returned sentence dataset

1.2.1

sw_id

String

No

Sensitive word ID

1.2.2

sw_name

String

No

Sensitive word name

1.2.3

category_id

String

No

Unique ID of a sensitive word category

1.3

resultCode

String

No

Return code

  • 0401000: success
  • Others: failure

1.4

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 path 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: Obtain the list of sensitive words in a sensitive word category based on its unique ID.

    Request header:

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

    Request parameters:

    {
    	"page": 1,
    	"limit": 10,
    	"category_id": "894378241379274753"
    }

    Response parameters:

    {
    	"data": [{
    		"category_id": "894378241379274753",
    		"sw_id": "894378241689653248",
    		"sw_name": "Ha ha ha"
    	}],
    	"resultCode": "0401000",
    	"paging": {
    		"total": 1
    	},
    	"resultDesc": "Operation successful."
    }