Image detection types within the webpage. See Image Detection Types. If not provided, defaults to political, pornographic, and advertising detection. Note: POLITICS is equivalent to PERSON (political face detection) + VIOLENCE (terrorism detection).
txtType
string
No
Text detection types within the webpage. See Text Detection Types. If not provided, defaults to standard risk detection.
videoImgType
string
No
Detection types for video frame captures within the webpage. Required when moderating videos. See Video Image Detection Types.
videoAudioType
string
No
Detection types for audio within videos on the webpage. See Video Audio Detection Types. Video audio-only moderation is not supported.
appId
string
No
Application identifier. Used to distinguish different applications within the same company. The value should be agreed upon with ISHUMEI.
callback
string
No
Callback HTTP URL. When non-empty, the service sends moderation results to this URL. Required when fileFormat is provided.
callbackParam
json_object
No
Pass-through field. When callback is provided, this field is returned along with the moderation result in the callback request.
Inappropriate scene detection (smoking, drinking, gambling, drug use, condoms, meaningless frames)
Video Audio Detection Types
Combine multiple types with underscores (e.g., POLITICS_PORN_MOAN).
Value
Description
POLITICS
Political content detection
PORN
Pornographic content detection
AD
Advertising detection
MOAN
Moaning detection
ABUSE
Abusive language detection
ANTHEN
National anthem detection
AUDIOPOLITICAL
Audio political content detection
NONE
Do not detect audio
articleDoubleJumpConfig Object
Parameter
Type
Required
Description
isOpen
bool
No
Whether to enable double-jump webpage moderation. Default: disabled.
articleScreenShotConfig Object
Parameter
Type
Required
Description
isOpen
bool
No
Whether to enable webpage screenshot moderation. Default: disabled.
width
int
No
Screenshot width. Default: 1080.
height
int
No
Screenshot height. Default: 6480.
data Object
Parameter
Type
Required
Description
url
string
No
Webpage URL to be moderated. The URL must be downloadable and its content-type header must be text/html. Max content size: 500 MB. Text length limit: 500,000 characters. Image limit: 500 images. Video limit: 50 segments. Either url or text is required.
text
string
No
Webpage text content to be moderated. Plain text content moderation. Text length limit: 500,000 characters. Either url or text is required.
tokenId
string
Yes
Unique client user account identifier for user behavior analysis. For webpage detection scenarios, pass the webpage URL.
channel
string
No
Business scenario. Configured via channel table.
returnHtml
bool
No
Whether to return HTML with highlighted risk content for human review. Default: false.
nickname
string
No
User nickname. Strongly recommended — malicious users on most platforms spread spam, political violations, and traffic-diversion content through nicknames.
ip
string
No
Client IP address for IP-based user behavior analysis and comparison against the ISHUMEI IP blocklist.
detectFrequency
float
No
Frame capture interval for videos within the webpage (0.5–60 seconds). Default: 5 seconds.
passThrough
json_object
No
Pass-through parameter, returned as-is in the response.
Result type. 0: machine moderation. 1: human moderation.
finalResult
int32
Yes
Whether this is the final moderation result. 0: not final (machine result; human review pending). 1: final result (can be used directly). Defaults to 1 if only machine moderation is configured.
Response Codes
Code
Message
1100
Success
1901
QPS limit exceeded
1902
Invalid parameters
1903
Service failure
9101
Unauthorized operation
Callback Mode
If callback is specified in the request parameters, the system automatically pushes machine moderation results to the specified URL. The callback response structure is the same as the synchronous response. When the HTTP status code 200 is returned, the push is considered successful; otherwise, the system retries up to 8 times.
Callback Response Codes
Code
Message
1100
Success
1901
QPS limit exceeded
1902
Invalid parameters
1903
Service failure
9100
Insufficient balance
9101
Unauthorized operation
detail Object
Parameter
Type
Required
Description
model
string
Yes
Rule identifier.
description
string
Yes
Risk reason description for the policy rule.
descriptionV2
string
No
New version risk reason description. Only returned for new policies during the transition period.
riskSummary
json_object
No
Risk summary with counts of each risk type. Returned only when type is NOVEL. See riskSummary.
riskDetail
json_array
No
Risk details for each content segment. Returned only when type is NOVEL. When returnHtml is true, only REJECT and REVIEW segments are returned. When false, all segments are returned. See riskDetail Array.
riskHtml
string
No
HTML with risk content highlighted, embeddable in display pages. Returned only when type is NOVEL and returnHtml is true.
hits
json_array
No
Webpage hit information. Generally empty — hit details are in riskDetail.
passThrough
json_object
No
Pass-through parameter returned as-is.
doubleJumpDetails
json_array
No
Returned when double-jump webpage moderation is enabled. See doubleJumpDetails.
doubleJumpDetails Array
Each element represents a double-jump URL and its risk details:
Parameter
Type
Required
Description
url
string
Yes
Double-jump URL link.
model
string
Yes
Rule identifier.
description
string
Yes
Risk reason description for the policy rule.
descriptionV2
string
No
New version risk reason description. Only returned for new policies during the transition period.
riskSummary
json_object
No
Risk summary. Returned only when type is NOVEL. See riskSummary.
Indicates whether text or nickname hit the sensitive word. text: text hit. nickname: nickname hit.
name
string
Yes
Name of the sensitive word list that was hit.
organization
string
No
Company identifier of the matched list. GLOBAL indicates a global list.
words
string_array
No
All matched sensitive words from the corresponding list.
wordPositions
json_array
No
All matched sensitive words with positions. See wordPositions.
wordPositions
Parameter
Type
Required
Description
word
string
No
The matched sensitive word.
position
string
No
Position of the sensitive word.
auxInfo Object
Parameter
Type
Required
Description
textNum
int
Yes
Number of characters in the current request (matches billing count). Includes Chinese characters, English letters, punctuation, and spaces.
imgNum
int
Yes
Number of images in the current request (matches billing count). Animated images are split into 3 frames; long images are segmented.
videoNum
int
Yes
Number of videos in the current request. Legacy compatibility field — not recommended for use.
billingImgNum
int
Yes
Number of video frame captures in the current request (matches billing count).
billingAudioDuration
int
Yes
Audio duration (in seconds) within videos in the current request (matches billing count). If the audio track duration differs from the video duration, billing is based on the actual audio track duration.
Array of requestId strings returned by ISHUMEI. Maximum of 10 items.
Response Parameters
Parameter
Type
Required
Description
code
int
Yes
Response code.
message
string
Yes
Response message.
requestId
string
No
Unique request identifier. Returned when code is not 1100.
contents
json_array
No
Query results. Returned when code is 1100. See contents Array.
contents Array
Each element represents a query result:
Parameter
Type
Required
Description
requestId
string
Yes
Machine moderation request identifier.
humanResult
json_object
No
Human moderation result. Only present after human review is completed.
machineResult
json_object
No
Machine moderation result. Only present after machine moderation is completed. Uses the same structure as the Synchronous Response Parameters.
mergeResult
json_object
No
Merged human and machine moderation result. Returns human result if available; otherwise returns machine result. If neither exists, this field is not present.