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

POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordDetail

Scenario

This interface is invoked to obtain details about a sensitive word based on its unique ID.

Method

POST

URI

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

sw_id

String

Yes

Unique ID of a sensitive word

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

sw_name

String

No

Sensitive word name

1.3

score

Number

No

Sensitive word score

1.4

exception

Object

No

Sensitive word exception

1.4.1

customer

Array [Object]

No

Sentence said by the customer

1.4.1.1

category_id

String

No

Unique ID of a sentence category

1.4.1.2

sentence_id

String

No

Unique ID of a sentence

1.4.1.3

sentence_name

String

No

Sentence name

1.4.2

staff

Array [Object]

No

Sentence said by the agent

1.4.2.1

category_id

String

No

Unique ID of a sentence category

1.4.2.2

sentence_id

String

No

Unique ID of a sentence

1.4.2.3

sentence_name

String

No

Sentence name

1.5

category_id

String

No

Unique ID of a sensitive word category

1.6

resultCode

String

No

Return code

  • 0401000: success
  • Others: failure

1.7

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: Obtain details about a sensitive word based on its unique ID.

    Request header:

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

    Request parameters:

    {
    	"sw_id": "894378241547046912"
    }

    Response parameters:

    {
    	"exception": {
    		"customer": [{
    			"category_id": "894378237264662528",
    			"sentence_id": "14171",
    			"sentence_name": "Intent name demo3"
    		}],
    		"staff": [{
    			"category_id": "894378237264662529",
    			"sentence_id": "14161",
    			"sentence_name": "Intent name demo1"
    		}, {
    			"category_id": "894378237264662529",
    			"sentence_id": "14166",
    			"sentence_name": "Intent name demo2"
    		}]
    	},
    	"score": "-10",
    	"category_id": "894378241379274752",
    	"resultCode": "0401000",
    	"sw_id": "894378241547046912",
    	"resultDesc": "Operation successful."
    	"sw_name": "La la la"
    }