단어 목록 가져오기
Overview
Once Content Understanding is enabled, you can use the REST API from your application backend to retrieve the list of keyword libraries.
API Call Instructions
Request URL Example
https://xxxxxx/v4/im_msg_audit_mgr/get_cloud_audit_keywords_ids?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Query Parameters
The table below lists only the parameters that need to be configured when calling this API. For details on additional parameters, see the REST API Overview.
Parameter | Description |
xxxxxx | Currently only supported in Singapore. Use the dedicated domain for the country/region associated with your SDKAppID: Singapore: adminapisgp.im.qcloud.comOther data centers are not supported at this time. |
v4/im_msg_audit_mgr/get_cloud_audit_keywords_ids | API endpoint. |
sdkappid | SDKAppID assigned by the Chat console when creating the application. |
identifier | |
usersig | |
random | Enter a random 32-bit unsigned integer, 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":3}
Request Fields
Field | Type | Required | Description |
SdkAppId | Integer | Required | Application ID. |
Offset | Integer | Required | Offset. |
Limit | Integer | Required | Maximum number of items to request, up to 100. |
Response Example
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "","TotalCount": 3,"Infos": [{"ID": "e77ff172-40f5-404c-8055-20f34504de82","LibName": "4_7_1400187352_1","Describe": "","CreateTime": "2023-02-20 13:53:44 +0800 CST","Suggestion": "Block"},{"ID": "71325721-5303-4c41-af15-00937658918e","LibName": "4_7_1400187352_1","Describe": "","CreateTime": "2023-02-20 13:51:49 +0800 CST","Suggestion": "Block"},{"ID": "7ad18f39-65cf-4b71-913b-e11d051789d3","LibName": "4_7_1400187352_1","Describe": "","CreateTime": "2023-02-20 13:51:38 +0800 CST","Suggestion": "Block"}]}
Response Fields
Field | Type | Description |
ActionStatus | String | Result of the request: OK indicates success. FAIL indicates failure. |
ErrorCode | Integer | Error code: 0 indicates success. Non-zero indicates failure. |
ErrorInfo | String | Error message. |
RequestId | String | Unique identifier for the current request. |
Infos | Array | Array of returned keyword libraries. |
ID | String | Keyword library ID, used for library operations. |
LibName | String | Keyword library name. |
Describe | String | Keyword library description. |
CreateTime | String | Keyword library creation time. |
TotalCount | Integer | Total number of keyword libraries. |
Error Codes
Unless a network error occurs (such as a 502 error), the HTTP status code returned for this API is always 200. Actual error codes and error messages are provided in the response body via ErrorCode and ErrorInfo.
Private error codes for this API are as follows:
Error Code | Description |
2001 | Internal server error. |
2002 | This command is not supported at this time. |
2003 | Invalid request parameters. |
2004 | No permission for this request. |
2015 | Moderation service not enabled. |
2016 | Adding keywords exceeds the per-request limit. |
