センシティブワード削除
Overview
Once Content Understanding is enabled, you can use REST API endpoints from your app backend to add, delete, update, or query keyword libraries for Content Understanding.
API Call Instructions
Request URL Example
https://xxxxxx/v4/im_msg_audit_mgr/delete_cloud_audit_keywords?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Query Parameters
The following table lists only the parameters relevant to this API call. For additional parameters, see the REST API Overview.
Parameter | Description |
xxxxxx | Only Singapore is currently supported. Use the dedicated domain for your SDKAppID: Singapore: adminapisgp.im.qcloud.comOther data centers are not yet supported. |
v4/im_msg_audit_mgr/delete_cloud_audit_keywords | API endpoint. |
sdkappid | SDKAppID assigned in the Chat console when you create your application. |
identifier | |
usersig | |
random | Provide a random 32-bit unsigned integer, range: 0 - 4294967295. |
contenttype | Request format. Value must be json. |
Rate Limit
Maximum 200 requests per second.
Request Example
{"SdkAppId":1400187352,"LibID":"1cd0d0ed-0e2c-4d35-ae86-2a1a8697706d","Keywords":["test123456xyz2"]}
Request Fields
Field | Type | Required | Description |
SdkAppId | Integer | Required | Application ID. |
LibID | String | Required | The keyword library ID to use for this operation. This is the ID returned by the Get Keyword Library List API. |
Keywords | Array | Required | List of sensitive keywords to delete. You can delete up to 10 keywords per request. |
Response Example
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "0874e3f7-c30a-49c0-953d-867e9243ff53","Details": [{"KeywordID": "10756914","Keyword": "test123456xyz2","Deleted": true,"ErrorInfo": ""}],"Count": 1}
Response Fields
Field | Type | Description |
ActionStatus | String | Result of the request: OK: Success FAIL: Failure |
ErrorCode | Integer | Error code: 0: Success. Non-zero: Failure. |
ErrorInfo | String | Error message. |
RequestId | String | Unique identifier for the current request. |
Details | Array | Array containing information about the deleted sensitive keywords. |
KeywordID | String | ID of the deleted sensitive keyword. |
Keyword | String | Content of the deleted sensitive keyword. |
Deleted | Bool | Indicates if the keyword was deleted successfully. |
ErrorInfo | String | Error message if deletion failed. |
Count | Integer | Total number of keywords deleted successfully. |
Error Codes
Unless a network error occurs (for example, a 502 error), this API always returns HTTP status code 200. Error codes and messages are provided in the response body through the ErrorCode and ErrorInfo fields.
Private error codes for this API are as follows:
Error Code | Description |
2001 | Internal server error. |
2002 | The command word is not supported. |
2003 | Invalid request parameters. |
2004 | No permission for this request. |
2015 | Moderation service not enabled. |
2016 | The number of dirty words added exceeds the per-request limit. |