민감어 추가
Overview
Once Cloud Moderation is enabled, you can use REST API endpoints from your application backend to add, delete, update, or query keyword libraries associated with Cloud Moderation.
API Call Instructions
Request URL Example
https://xxxxxx/v4/im_msg_audit_mgr/add_cloud_audit_keywords?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Query Parameters
The table below includes only the parameters relevant to this API call. For details on other parameters, see the REST API Overview.
Parameter | Description |
xxxxxx | Currently supported only in Singapore. Use the dedicated domain for the country/region where the SDKAppID is located: Singapore: adminapisgp.im.qcloud.comOther data centers are not yet supported. |
v4/im_msg_audit_mgr/add_cloud_audit_keywords | API endpoint. |
sdkappid | SDKAppID assigned by the Chat Console when creating the application. |
identifier | |
usersig | |
random | Specify a random 32-bit unsigned integer. Range: 0 - 4294967295. |
contenttype | Request format. Fixed value: json. |
Rate Limit
Maximum 200 requests per second.
Request Example
{"SdkAppId":1400187352,"LibID":"1cd0d0ed-0e2c-4d35-ae86-2a1a8697706d","UserKeywords":[{"Content":"xyz123456test1","Label":"Ad"}]}
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. |
UserKeywords | Array | Required | Array of sensitive words to add. |
Content | String | Required | Sensitive word content. |
Label | String | Optional | Sensitive word category: Normal/Illegal/Abuse/Polity/Ad/Porn/Sexy/Terror/Composite. |
Response Example
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "321ea546-46bd-45ae-b0e0-321c8ac6a3b0"}
Response Fields
Field | Type | Description |
ActionStatus | String | Indicates the 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. |
Error Codes
Unless a network error occurs (such as a 502 error), this API always returns HTTP status code 200. The actual error code and error message are provided in the response body via ErrorCode and ErrorInfo.
Private error codes for this API are listed below:
Error Code | Description |
2001 | Internal server error. |
2002 | This command is not supported yet. |
2003 | Invalid request parameters. |
2004 | No permission for this request. |
2015 | Moderation service not enabled. |
2016 | Exceeded limit for adding sensitive words per request. |