Query Default Template Video Moderation

Updated: 2023-12-11 09:38:34

API Description

1、查询视频审核默认模板设置
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/template/video-moderation/get

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining the key
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All API calls must be relayed through your own server to the POLYV server for response data.` See signature generation rules
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 3 minutes

Example

http://api.polyv.net/live/v4/user/template/video-moderation/get?appId=frlr1zazn3&sign=82ADECF49C78E5F6399D99A6EDE4EEAD&timestamp=1677167039930

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
data	Object	Template video moderation settings object See Data parameter description
error	Object	Error information when status code is not 200 See Error parameter description
requestId	String	Request ID, a unique UUID generated for each request, for troubleshooting and debugging only, not for business logic
status	String	Response result, determined by business logic: success returns success, failure returns error
success	Boolean	Whether the response was successful

Data Parameter Description

Parameter	Type	Description
moderationEnabled	String	Moderation switch Y: Enabled N: Disabled
moderationStrategy	String	Moderation strategy (finance_easy: Lenient, finance_normal: Normal, finance_serious: Strict)
imageFrequency	Integer	Frame capture interval (5s, 20s, 60s)
illegalNotify	Object	Violation notification settings

illegalNotify Parameter Description

Parameter	Type	Description
monitorEnabled	String	Switch Y: Enabled N: Disabled
talentEnabled	String	Switch Y: Enabled N: Disabled
assistantEnabled	String	Switch Y: Enabled N: Disabled
platformEnabled	String	Switch Y: Enabled N: Disabled

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own project source code. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询视频审核默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void getVideoModerationSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/template/video-moderation/get";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询视频审核默认模板设置成功：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "63775ea159fe454e87614614070188a8.70.17020177487119185",
    "data": {
        "moderationEnabled": "N",
        "moderationStrategy": "finance_serious",
        "imageFrequency": 5,
        "illegalNotify": {
            "monitorEnabled": "Y",
            "talentEnabled": "Y",
            "assistantEnabled": "Y",
            "platformEnabled": "Y"
        }
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API