保利威文档中心

帮助中心

直播服务端 API

查询频道视频审核设置（需开通）

更新时间：2023-03-24 10:36:31

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥】
channelId true String 频道ID
sign true String 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
timestamp true String 当前13位毫秒级时间戳，3分钟内有效

示例

http://api.polyv.net/live/v4/channel/video-moderation/get?appId=gga9dadhzm&sign=65D40CA6D843CD4B7B0D6377D23CBE05&channelId=3775168&timestamp=1679622629258

响应参数描述

参数名 类型 说明
code Integer 状态码，与 http 状态码相同，用于确定基本的响应状态
data Object 查询视频审核返回实体【详见Data参数描述】
error Object 状态码非200时的错误信息【详见Error参数描述】
requestId String 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
status String 响应结果，由业务决定，成功返回success，失败返回error
success Boolean 是否成功响应

Data参数描述

参数名 类型 说明
channelId Integer 当前配置任务所属频道号
illegalNotify Object 【详见IllegalNotify参数描述】
imageFrequency Integer 截帧时长，单位：秒，取值：5、20、60，间隔X秒截取一帧
moderationEnabled String 审核功能的开关，Y：开启，N：关闭
moderationStrategy String 审核策略，finance_easy：宽松审核策略，finance_normal：一般审核策略，finance_serious：严格审核策略

IllegalNotify参数描述

参数名 类型 说明
assistantEnabled String 助理通知，Y：开启，N：关闭
monitorEnabled String 监播通知，Y：开启，N：关闭
platformEnabled String 平台通知，Y：开启，N：关闭
talentEnabled String 主播通知，Y：开启，N：关闭

Error参数描述

参数名 类型 说明
code Integer 错误代码，用于确定具体的错误原因
desc String 错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "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
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询