POST
method of HTTP, with the X-Ci-Content-Version: Simple
header.{"code": 0,"data": {"event":"ReviewVideo","forbidden_status": 0,"porn_info": {"hit_flag": 0,"label": "","count": 0},"result": 0,"trace_id": "test_trace_id","url": "test_url","cos_headers": {"x-cos-meta-xx": "xx"}},"message": "Test request when setting callback url"}
Parameter | Description | Type | Required |
code | Error code. 0: moderation succeeded; other values: moderation failed. For more information, see Error Codes. | Integer | Yes |
message | Error message. | String | Yes |
data | Details of the live stream moderation result. | Object | Yes |
data
is as described below:Parameter | Description | Type | Required |
trace_id | Request ID. If the job is an async job created through an API, this value is the JobId returned by the API. | String | Yes |
url | URL of the moderated live stream. | String | Yes |
event | Triggered event, which is fixed at ReviewVideo here. | String | Yes |
result | This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). | Integer | Yes |
forbidden_status | If you set automatic freezing, this field indicates the frozen status. Live stream moderation doesn't involve this field. Default value: 0 (not frozen). | Integer | Yes |
cos_headers | The custom header content set when the resource is uploaded. If it is not set, it will not be returned. | Object | No |
porn_info | The moderation result of the pornographic information moderation scene. | Object | No |
ads_info | The moderation result of the advertising information moderation scene. | Object | No |
data_id | The original content will be returned if the DataId parameter is set when the job is submitted, which can contain up to 512 bytes. | String | No |
xx_info
is as described below:Parameter | Description | Type | Required |
hit_flag | The moderation result returned for the moderation scene. Return values: 0: Normal. 1: Confirmed as a violation of the current scene. 2: Suspected as a violation of the current scene. | Integer | Yes |
label | Hit label name, which is empty currently. | String | Yes |
count | The number of sensitive screenshots that hit the moderation scene. | Integer | Yes |
POST
method of HTTP, with the X-Ci-Content-Version: Detail
header.{"EventName": "ReviewVideo","JobsDetail": {"JobId": "xxxxxx","State": "Success","CreationTime": "","Object": "","Label": "Normal","Result": 0,"SnapshotCount": 1,"PornInfo": {"HitFlag": 0,"Count": 0},"AdsInfo": {"HitFlag": 0,"Count": 0},"Snapshot": [{"Url": "","Text": "","SnapshotTime": 0,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"Label": "","SubLabel": ""},"AdsInfo": {"HitFlag": 0,"Score": 0,"Label": "","SubLabel": ""}}],"AudioSection": [{"Url": "","Text": "","OffsetTime": 0,"Duration": 30000,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0},"AdsInfo": {"HitFlag": 0,"Score": 0}}],"BucketId": "examplebucket-1250000000","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "xxx"}}}
Node Name (Keyword) | Description | Type |
JobsDetail | Job result details. | Object |
EventName | Job type: ReviewVideo. | String |
JobsDetail
has the following sub-nodes:Node Name (Keyword) | Description | Type |
Code | String | |
Message | Error message, which will be returned only if State is Failed . | String |
JobId | Moderation job ID. | String |
DataId | The original content will be returned if the DataId parameter is set when the job is submitted, which can contain up to 512 bytes. | String |
State | Status of the live stream moderation job. Valid values: Submitted , Snapshoting , Success , Failed , Auditing . | String |
CreationTime | Creation time of the live stream moderation job. | String |
Url | The URL of the live stream to be moderated. | String |
SnapshotCount | The total number of screenshots. In the callback where the live stream status is Auditing , this field indicates the number of screenshots included in the callback. | Integer |
Label | This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal , Porn , and Ads . | String |
Result | This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). | Integer |
PornInfo | The moderation result of the pornographic information moderation scene. | Object |
AdsInfo | The moderation result of the advertising information moderation scene. | Object |
Snapshot | This field is used to return the result of live stream image moderation. | Array |
AudioSection | This field is used to return the result of live stream sound moderation. If no audio is detected, it will not be returned. | Array |
BucketId | Name of the bucket of the created moderation job. | String |
Region | Bucket region. | String |
ForbidState | If you set automatic freezing, this field indicates the status of the video. Valid values: 0 (not frozen), 1 (frozen), and 2 (file moved). | Integer |
CosHeaders | The custom header content set when the resource is uploaded to COS. If it is not set, it will not be returned. It is in a map structure, where key is the custom header name and value is the content. | Object |
UserInfo | Business field. This field will not exist if UserInfo is not set during job creation. | Object |
Type | Moderation type. live_video will be returned for live stream moderation. | String |
ListInfo | Blocklist/Allowlist status of the account. | Container |
PornInfo
and AdsInfo
have the following sub-nodes:Node Name (Keyword) | Description | Type |
HitFlag | Whether the moderation type is hit. Valid values: 0 (miss), 1 (hit), 2 (suspected). | Integer |
Count | The number of screenshots that hit this moderation scene. | Integer |
Snapshot
has the following sub-nodes:Node Name (Keyword) | Description | Type |
Url | URL of the current live stream screenshot, at which you can view the screenshot. It must be a standard URL. Note: Each URL is valid for two hours. If you need to view the data after two hours, initiate a new query request. | String |
SnapshotTime | This field returns the timestamp of the current screenshot in milliseconds, such as 1649387157000. | Integer |
Text | This field is used to return the OCR text recognition result of the current screenshot. It will be returned only if text content detection is enabled in the moderation policy. | String |
Label | This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal , Porn , Ads . | String |
Result | This field indicates the moderation result. You can perform subsequent operations based on the result. We recommend you handle different results based on your business needs. Valid values: 0 (normal), 1 (sensitive), and 2 (suspiciously sensitive, with human review recommended). | Integer |
PornInfo | The moderation result of the pornographic information moderation scene. | Object |
AdsInfo | The moderation result of the advertising information moderation scene. | Object |
PornInfo
and AdsInfo
have the following sub-nodes:Node Name (Keyword) | Description | Type |
HitFlag | Whether the moderation type is hit. Valid values: 0 (miss), 1 (hit), 2 (suspected). | Integer |
Score | The confidence the moderation result hits the moderation scene. Value range: 0–100. The higher the value, the more likely the content hits the currently returned moderation scene. For example, Porn 99 means that the content is very likely to be pornographic. | Integer |
Label | This field indicates the overall result label of the screenshot, which may be SubLabel , a person name, etc. | String |
Category | This field indicates the specific hit moderation type. Note: This field may return null. | String |
SubLabel | This field indicates the specific sub-label hit by the moderation job; for example, SexBehavior is a sub-label under the Porn label.Note: This field may return null, indicating that no specific sub-labels are hit. | String |
OcrResults | This field represents the detailed OCR result, including the text coordinate information and text recognition result. It will be returned if there is non-compliant content. | Array |
LibResults | This field returns results based on recognition against the risk library. Note: This field will not be returned if no samples in the risk library are hit. | Container Array |
LibResults
has the following sub-nodes:Node Name (Keyword) | Description | Type |
ImageId | This field represents the hit image sample ID in the risk library. | String |
Score | This field returns the confidence under the current label. Value range: 0–100. The higher the value, the more likely the image hits a sample in the risk library. For example, Porn 99 means that the content is very likely to hit a pornographic sample in the library. | Integer |
OcrResults
has the following sub-nodes:Node Name (Keyword) | Description | Type |
Text | The specific text content recognized by OCR in the image. | String |
Keywords | Keywords hit by the current moderation scene. | Array |
Location | This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the OCR detection frame in the image for quick location of the recognized text. | Object |
ObjectResults
has the following sub-nodes:Node Name (Keyword) | Description | Type |
Name | This field is used to return the name of the recognized object, such as person name. | String |
Location | This parameter is used to return the position (X and Y coordinates of the top-left corner, length, width, and rotation angle) of the recognition result in the image for you to quickly locate information. | Object |
Location
has the following sub-nodes:Node Name (Keyword) | Description | Type |
X | This parameter is used to return the pixel position of the abscissa (X) of the top-left corner of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. | Float |
Y | This parameter is used to return the pixel position of the ordinate of the top-left corner (Y) of the detection frame. It can be combined with other parameters to uniquely determine the size and position of the detection frame. | Float |
Height | This parameter is used to return the height of the detection frame (the length starting from the top-left corner and extending down the Y axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame. | Float |
Width | This parameter is used to return the width of the detection frame (the length starting from the top-left corner and extending to the right on the X axis). It can be combined with other parameters to uniquely determine the size and position of the detection frame. | Float |
Rotate | This parameter is used to return the rotation angle of the detection frame. Valid values: 0–360 (degrees), and the direction is counterclockwise rotation. This parameter can be combined with the X and Y coordinate parameters to uniquely determine the specific position of the detection frame. | Float |
AudioSection
has the following sub-nodes:Node Name (Keyword) | Description | Type |
Url | URL of the current live stream sound segment, at which you can get the content of the segment. It must be a standard URL. Note: Each URL is valid for two hours. If you need to view the data after two hours, initiate a new query request. | String |
Text | This field is used to return the ASR text recognition result of the current live stream sound segment. | String |
OffsetTime | This field returns the timestamp of the current sound segment in milliseconds, such as 1649387157000. | Integer |
Duration | The duration of the current sound segment in milliseconds. | Integer |
Label | This field is used to return the maliciousness label with the highest priority in the detection result, which represents the moderation result suggested by the model. We recommend you handle different types of violations and suggestions based on your business needs. Return values: Normal , Porn , and Ads . | String |
Result | Recognition result for reference. Valid values: 0 (normal), 1 (sensitive), 2 (suspiciously sensitive). | Integer |
PornInfo | The moderation result of the pornographic information moderation scene. | Object |
AdsInfo | The moderation result of the advertising information moderation scene. | Object |
PornInfo
and AdsInfo
have the following sub-nodes:Node Name (Keyword) | Description | Type |
HitFlag | Whether the moderation type is hit. Valid values: 0 (miss), 1 (hit), 2 (suspected). | Integer |
Score | The confidence the moderation result hits the moderation scene. Value range: 0–100. The higher the value, the more likely the content hits the currently returned moderation scene. For example, Porn 99 means that the content is very likely to be pornographic. | Integer |
Category | This field indicates the specific hit moderation type. Note: This field may return null. | String |
Keywords | Keywords hit by the current moderation scene. Nothing will be returned if there is none. | Array |
LibResults | This field returns results based on recognition against the risk library. Note: This field will not be returned if no samples in the risk library are hit. | Container Array |
LibResults
has the following sub-nodes:Node Name (Keyword) | Description | Type |
LibType | Type of the hit risk library. Valid values: 1 (preset blocklist/allowlist library), 2 (custom risk library). | Integer |
LibName | Name of the hit risk library. | String |
Keywords | Keywords hit in the library. There may be multiple returned values representing multiple hit keywords. | String Array |
UserInfo
has the following sub-nodes:Node Name (Keyword) | Description | Type | Required |
TokenId | Account information, which can contain up to 128 bytes. | String | No |
Nickname | Nickname information, which can contain up to 128 bytes. | String | No |
DeviceId | Device information, which can contain up to 128 bytes. | String | No |
AppId | Unique app ID, which can contain up to 128 bytes. | String | No |
Room | Room ID information, which can contain up to 128 bytes. | String | No |
IP | IP address information, which can contain up to 128 bytes. | String | No |
Type | Business type, which can contain up to 128 bytes. | String | No |
ReceiveTokenId | User account to receive messages, which can contain up to 128 bytes. | String | No |
Gender | Gender information, which can contain up to 128 bytes. | String | No |
Level | Level information, which can contain up to 128 bytes. | String | No |
Role | Role information, which can contain up to 128 bytes. | String | No |
ListInfo
has the following sub-nodes:Node Name (Keyword) | Description | Type |
ListResults | Results in all hit lists. | Container Array |
ListResults
has the following sub-nodes:Node Name (Keyword) | Description | Type |
ListType | Type of the hit list. Valid values: 0 (allowlist), 1 (blocklist). | Integer |
ListName | Name of the hit list. | String |
Entity | Entity hit in the list. | String |
{"code": 0,"data": {"event":"ReviewVideo","forbidden_status": 0,"porn_info": {"hit_flag": 0,"label": "","count": 0},"result": 0,"trace_id": "vxzt90jl2dfscxxxxxxxxxxxxxxxxx","url": "https://66665.livepush.myqcloud.com/video.flv","cos_headers": {"x-cos-meta-id": "666666"}},"message": "success"}
{"EventName": "ReviewVideo","JobsDetail": {"JobId": "xxxxxx","State": "Success","CreationTime": "2021-08-10T21:01:10+08:00","Url": "https://66665.livepush.myqcloud.com/video.flv","Label": "Normal","Result": 0,"SnapshotCount": 1,"PornInfo": {"HitFlag": 0,"Count": 0},"AdsInfo": {"HitFlag": 0,"Count": 0},"Snapshot": [{"Url": "https://video-1250000000.cos.ap-chongqing.myqcloud.com/test/0.jpg","Text": "","SnapshotTime": 41,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0,"Label": "","SubLabel": ""},"AdsInfo": {"HitFlag": 0,"Score": 0,"Label": "","SubLabel": ""}}],"AudioSection": [{"Url": "https://audio-1250000000.cos.ap-guangzhou.myqcloud.com/0.mp3","Text": "","OffsetTime": 0,"Duration": 30000,"Label": "Normal","Result": 0,"PornInfo": {"HitFlag": 0,"Score": 0},"AdsInfo": {"HitFlag": 0,"Score": 0}}],"BucketId": "examplebucket-1250000000","Region": "ap-chongqing","ForbidState": 0,"CosHeaders": {"x-cos-meta-id": "xxxx"}}}
Was this page helpful?