保利威文档中心

幫助中心

更新頻道影片審核設定(需開通)

更新時間:2023-04-04 09:31:23

介面描述

1、更新频道视频审核设置
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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分鐘內有效

請求體參數描述

參數名 必選 類型 說明
channelId true Integer 頻道id
moderationEnabled true String 審核開關,Y:開啟,N:關閉
illegalNotify true Object 【詳見IllegalNotify參數描述
imageFrequency true Integer 截幀間隔(5:旗艦版(每分鐘12審);20:加強版(每分鐘3審);60:標準版(每分鐘1審))
moderationStrategy true String 審核策略,finance_easy:寬鬆審核策略,finance_normal:一般審核策略,finance_serious:嚴格審核策略

IllegalNotify參數描述

參數名 必選 類型 說明
assistantEnabled false String 助理通知,Y:開啟,N:關閉,預設為N
monitorEnabled false String 監播通知,Y:開啟,N:關閉,預設為N
platformEnabled false String 平台通知,Y:開啟,N:關閉,預設為N
talentEnabled false String 主播通知,Y:開啟,N:關閉,預設為N

範例

http://api.polyv.net/live/v4/channel/video-moderation/update?appId=gga9dadhzm&sign=6AFE86666016B502E668174613B29585&channelId=3775168&timestamp=1679623766123

請求體json參數:

{
    "illegalNotify": {
        "platformEnabled": "Y",
        "monitorEnabled": "Y",
        "assistantEnabled": "Y",
        "talentEnabled": "Y"
    },
    "imageFrequency": "60",
    "moderationStrategy": "finance_serious",
    "moderationEnabled": "Y"
}

回應參數描述

參數名 類型 說明
code Integer 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態
data Boolean 成功回應的資料
error Object 狀態碼非200時的錯誤資訊【詳見Error參數描述
requestId String 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤
status String 回應結果,由業務決定,成功返回success,失敗返回error
success Boolean 是否成功回應

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 videoModerationUpdateTest() 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/update";
    String channelId = "3775168";
    String moderationStrategy = "finance_serious";
    String imageFrequency = "60";
    String moderationEnabled = "Y";
    String assistantEnabled = "Y";
    String monitorEnabled = "Y";
    String platformEnabled = "Y";
    String talentEnabled = "Y";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", channelId);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("imageFrequency", imageFrequency);
    jsonMap.put("moderationEnabled", moderationEnabled);
    jsonMap.put("moderationStrategy", moderationStrategy);
    Map<String, Object> illegalNotifyMap = new HashMap<>();
    jsonMap.put("illegalNotify", illegalNotifyMap);
    illegalNotifyMap.put("assistantEnabled", assistantEnabled);
    illegalNotifyMap.put("monitorEnabled", monitorEnabled);
    illegalNotifyMap.put("platformEnabled", platformEnabled);
    illegalNotifyMap.put("talentEnabled", talentEnabled);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试更新频道视频审核设置成功:{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f0103b0961754d3a887f82e35032a6ea.69.16796237824386651",
    "data": true,
    "success": true
}

異常範例

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