センシティブワード取得

Overview
Once Cloud Moderation is enabled, you can use the REST API from your backend to retrieve a list of sensitive words from a specified keyword library.
API Call Instructions
Request URL Example
https://xxxxxx/v4/im_msg_audit_mgr/get_cloud_audit_keywords?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Query Parameters
The table below lists only the parameters relevant to this API call and their descriptions. For additional parameters, see the REST API Overview.
Parameter
Description
xxxxxx
Currently supported only in Singapore. Use the domain specific to the country/region of your SDKAppID:
Singapore: adminapisgp.im.qcloud.com
Other data centers are not yet supported.
v4/im_msg_audit_mgr/get_cloud_audit_keywords
API endpoint.
sdkappid
SDKAppID assigned by the Chat console when the application is created.
identifier
Must be an app administrator account. For details, see App Administrator.
usersig
Signature generated by the app administrator account. See Generate UserSig for details.
random
Specify a random 32-bit unsigned integer in the range 0 - 4294967295.
contenttype
Request format. Must be set to json.
Rate Limit
Maximum 200 requests per second.
Request Example
{
    "SdkAppId":1400187352,
    "Offset":0,
    "Limit":10,
    "LibID":"1cd0d0ed-0e2c-4d35-ae86-2a1a8697706d",
    "Content":"test123456xyz1"
}
Request Fields
Field
Type
Required
Description
SdkAppId
Integer
Required
Application ID.
Offset
Integer
Required
Offset.
Limit
Integer
Required
Maximum number of items to retrieve, up to 100.
LibID
String
Required
The keyword library ID to use for this operation. This is the ID returned by the Get Keyword Library List API.
Content
String
Optional
If provided, performs a fuzzy search to return matching sensitive words. If empty, returns sensitive words via pagination.
Response Example
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RequestId": "a2b6ab9c-ac0d-4627-b9fd-d3c7525048f9",
    "TotalCount": 1,
    "Infos": [
        {
            "ID": "10756913",
            "Content": "test123456xyz1",
            "CreateTime": "2023-06-24 23:45:04"
        }
    ]
}
Response Fields
Field
Type
Description
ActionStatus
String
Processing result:
OK: Success.
FAIL: Failure.
ErrorCode
Integer
Error code:
0: Success.
Non-zero: Failure.
ErrorInfo
String
Error message.
RequestId
String
Unique identifier for the request.
TotalCount
Integer
Total number of sensitive words in the application.
Infos
Array
List of sensitive words and their attributes.
ID
String
Sensitive word ID.
Content
String
Sensitive word text.
CreateTime
String
Creation time for the sensitive word, format: yyyy-MM-dd HH:mm:ss, timezone: UTC+8.
Error Codes
Unless a network error occurs (such as a 502 error), this API always returns HTTP status 200. Error codes and messages are included in the response body via the ErrorCode and ErrorInfo fields.
For common error codes (60000 to 79999), see Error Codes.
Private error codes for this API are listed below:
Error Code
Description
2001
Internal server error.
2002
This command word is not supported yet.
2003
Invalid request parameters.
2004
No permission for this request.
2015
Moderation service not enabled.
2016
The number of sensitive words added exceeds the per-request limit.

Parameter	Description
xxxxxx	Currently supported only in Singapore. Use the domain specific to the country/region of your SDKAppID: Singapore: `adminapisgp.im.qcloud.com` Other data centers are not yet supported.
v4/im_msg_audit_mgr/get_cloud_audit_keywords	API endpoint.
sdkappid	SDKAppID assigned by the Chat console when the application is created.
identifier	Must be an app administrator account. For details, see App Administrator.
usersig	Signature generated by the app administrator account. See Generate UserSig for details.
random	Specify a random 32-bit unsigned integer in the range 0 - 4294967295.
contenttype	Request format. Must be set to `json`.

Field	Type	Required	Description
SdkAppId	Integer	Required	Application ID.
Offset	Integer	Required	Offset.
Limit	Integer	Required	Maximum number of items to retrieve, up to 100.
LibID	String	Required	The keyword library ID to use for this operation. This is the ID returned by the Get Keyword Library List API.
Content	String	Optional	If provided, performs a fuzzy search to return matching sensitive words. If empty, returns sensitive words via pagination.

Error Code	Description
2001	Internal server error.
2002	This command word is not supported yet.
2003	Invalid request parameters.
2004	No permission for this request.
2015	Moderation service not enabled.
2016	The number of sensitive words added exceeds the per-request limit.