사전 심사 인터페이스

Feature Overview
Once Content Understanding is enabled, you can proactively invoke the REST API from your application backend to submit audio, video, text, or image content for moderation. Text and image moderation responses are returned synchronously. Audio and video moderation responses are delivered asynchronously via webhook.
API Calling Description
Sample request URL
https://xxxxxx/v4/im_msg_audit/content_moderation?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The table below lists the parameters relevant to this API. For additional details, refer to the REST API Overview.
Parameter
Description
xxxxxx
Currently, only Singapore is supported. Use the dedicated domain for the country or region where your SDKAppID resides:
Singapore: adminapisgp.im.qcloud.com
Other data centers are not supported at this time. 
v4/im_msg_audit/content_moderation
API endpoint.
sdkappid
SDKAppID assigned by the Chat console when creating the application.
identifier
Must be an app administrator account. For more details, see App Administrator.
usersig
Signature generated by the app administrator account. For details, see Generate UserSig.
random
Enter a random 32-bit unsigned integer, valid range: 0 - 4294967295.
contenttype
Request format. Fixed value: json.
Rate limit
Maximum: 200 requests per second.
Request example
{
    "AuditName":"C2C",
    "ContentType":"Text",
    "Content":"abc",
    "ExtSender":"sender_xx",
    "ExtReceiver":"receiver_yy"
}
Request fields
Field
Type
Required
Description
AuditName
String
Required
Specifies the moderation configuration.
Common moderation configuration values: C2C / Group / UserInfo / GroupInfo / GroupMemberInfo / RelationChain
Custom moderation configuration values: Custom Moderation Configuration ID
Custom configurations must be created in the console. The proactive moderation API uses the custom configuration ID as the value of AuditName to route the request to the corresponding moderation scenario. 
ContentType
String
Required
Type of content for moderation. Valid values: Text/Image/Audio/Video.
Content
String
Required
Content to be moderated. Maximum size: 8KB. For file moderation, provide the corresponding URL. For image moderation, maximum size is 5MB.
ExtSender
String
Optional
Sender identifier: can be left empty, filled with the corresponding Chat UserID, or a custom sender ID. If provided, you can filter and analyze details in the Content Understanding console.
ExtReceiver
String
Optional
Receiver identifier: can be left empty, filled with the corresponding Chat UserID/GroupID, or a custom receiver ID. If provided, you can filter and analyze details in the Content Understanding console.
Sample response
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "RequestId": "91fa78f3-18c8-4b20-9c56-5845df18f634",
    "Result": "Block",
    "Score": 100,
    "Label": "Polity",
    "Keywords": [
        "abc"
    ]
}
Response fields
Field
Type
Description
ActionStatus
String
Result of the request processing:
OK: Success.
FAIL: Failure.
ErrorCode
Integer
Error code:
0: Success.
Non-zero: Failure.
ErrorInfo
String
Detailed error message.
RequestId
String
Moderation identifier. For asynchronous audio/video moderation, use RequestId to retrieve results from the webhook. For configuration.
Result
String
Moderation suggestion for text/image: Pass/Review/Block.
Score
Integer
Malicious score for text/image moderation: 0–100. Higher score indicates greater maliciousness.
Label
String
Content label matched: Normal/Polity/Porn/Illegal/Abuse/Terror/Ad/Sexy/Composite.
Error codes
Unless a network error occurs (such as 502), the HTTP status code for this API is always 200. Actual error codes and error messages are provided in the ErrorCode and ErrorInfo fields of the response body.
For common error codes (60000–79999), see Error Codes.
Private error codes for this API are listed below:
Error Code
Description
60003
Invalid request parameters.
60020
Content Understanding service not enabled.
60022
Internal request error. Please contact us.
93000
Content submitted for moderation exceeds the maximum limit of 8KB.
93001
Internal request error. If retry does not resolve, please contact us.
93005
Batch moderation API only supports text/image moderation.
93006
Batch moderation API timeout. Timeout duration is 5 seconds.
93007
Batch moderation API does not support duplicate ContentId.
93008
Batch moderation API supports a maximum of 10 Content submissions at a time.
﻿

Parameter	Description
xxxxxx	Currently, only Singapore is supported. Use the dedicated domain for the country or region where your SDKAppID resides: Singapore: `adminapisgp.im.qcloud.com` Other data centers are not supported at this time.
v4/im_msg_audit/content_moderation	API endpoint.
sdkappid	SDKAppID assigned by the Chat console when creating the application.
identifier	Must be an app administrator account. For more details, see App Administrator.
usersig	Signature generated by the app administrator account. For details, see Generate UserSig.
random	Enter a random 32-bit unsigned integer, valid range: 0 - 4294967295.
contenttype	Request format. Fixed value: `json`.

Field	Type	Required	Description
AuditName	String	Required	Specifies the moderation configuration. Common moderation configuration values: `C2C / Group / UserInfo / GroupInfo / GroupMemberInfo / RelationChain` Custom moderation configuration values: Custom Moderation Configuration ID Custom configurations must be created in the console. The proactive moderation API uses the custom configuration ID as the value of `AuditName` to route the request to the corresponding moderation scenario.
ContentType	String	Required	Type of content for moderation. Valid values: `Text/Image/Audio/Video`.
Content	String	Required	Content to be moderated. Maximum size: 8KB. For file moderation, provide the corresponding URL. For image moderation, maximum size is 5MB.
ExtSender	String	Optional	Sender identifier: can be left empty, filled with the corresponding Chat UserID, or a custom sender ID. If provided, you can filter and analyze details in the Content Understanding console.
ExtReceiver	String	Optional	Receiver identifier: can be left empty, filled with the corresponding Chat UserID/GroupID, or a custom receiver ID. If provided, you can filter and analyze details in the Content Understanding console.

Error Code	Description
60003	Invalid request parameters.
60020	Content Understanding service not enabled.
60022	Internal request error. Please contact us.
93000	Content submitted for moderation exceeds the maximum limit of 8KB.
93001	Internal request error. If retry does not resolve, please contact us.
93005	Batch moderation API only supports text/image moderation.
93006	Batch moderation API timeout. Timeout duration is 5 seconds.
93007	Batch moderation API does not support duplicate ContentId.
93008	Batch moderation API supports a maximum of 10 Content submissions at a time.