Query Channel Video Moderation Settings (Requires Activation)

Updated: 2023-03-24 10:36:31

API Description

1、查询频道视频审核设置
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
channelId	true	String	Channel ID
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 saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and retrieve 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/channel/video-moderation/get?appId=gga9dadhzm&sign=65D40CA6D843CD4B7B0D6377D23CBE05&channelId=3775168&timestamp=1679622629258

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
data	Object	Query video moderation response entity [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, only used for troubleshooting and debugging, not related to business logic
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful

Data Parameter Description

Parameter	Type	Description
channelId	Integer	Channel number of the current configuration task
illegalNotify	Object	[See IllegalNotify Parameter Description]
imageFrequency	Integer	Frame capture interval, in seconds. Values: 5, 20, 60. Captures one frame every X seconds
moderationEnabled	String	Moderation feature toggle. Y: Enabled, N: Disabled
moderationStrategy	String	Moderation strategy. finance_easy: Lenient, finance_normal: Normal, finance_serious: Strict

IllegalNotify Parameter Description

Parameter	Type	Description
assistantEnabled	String	Assistant notification. Y: Enabled, N: Disabled
monitorEnabled	String	Monitor notification. Y: Enabled, N: Disabled
platformEnabled	String	Platform notification. Y: Enabled, N: Disabled
talentEnabled	String	Host notification. 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 basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. 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 videoModerationGetTest() 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/channel/video-moderation/get";
    String channelId = "3775168";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("channelId", channelId);
    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": "da46fa518e934191afa887c82913f3bf.70.16796226551092965",
    "data": {
        "channelId": 3775168,
        "moderationEnabled": "Y",
        "moderationStrategy": "finance_serious",
        "imageFrequency": 5,
        "illegalNotify": {
            "monitorEnabled": "Y",
            "talentEnabled": "N",
            "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