保利威文档中心

幫助中心

查詢頻道影片審核記錄列表

更新時間:2024-04-22 19:18:32

介面描述

1、查询频道场次审核记录列表
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
timestamp true String 當前13位毫秒級時間戳,3分鐘內有效
channelId true String 頻道號
label false String 識別類型,Normal:正常,Porn:色情,Abuse:謾罵,Ad:廣告,Custom:自訂違規;Badword:自訂嚴禁詞;Illegal:違規;Polity:涉政;Moan:呻吟;Terror:暴恐;Religion:宗教;Sexy:性感;Teenager:青少年;Copyright:版權;多個使用英文逗號分隔
pageNumber false String 當前頁數,第幾頁
pageSize false String 分頁大小,預設10,最大不超過1000
resultType false String 結果類型,1:通過,2:違規,3:疑似,多個使用英文逗號分隔
sessionId false String 頻道場次id

範例

http://api.polyv.net/live/v4/channel/video-moderation/result/list?pageNumber=1&appId=gga9dadhzm&sign=612561DF5502DD76CE1B760EB2B907BA&pageSize=20&label=&sessionId=gj4z866us3&resultType=&channelId=3775168&timestamp=1679622317653

回應參數描述

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

Data參數描述

參數名 類型 說明
contents Array 分頁資料集合【詳見Contents參數描述
pageNumber Integer 當前頁數,第幾頁
pageSize Integer 分頁大小
totalItems Integer 總記錄數
totalPages Integer 總頁數

Contents參數描述

參數名 類型 說明
channelId Integer 頻道id
createTime String 審核時間
id Integer 主鍵id
imageUrl String 圖片連結
label String 識別類型,Normal:正常,Porn:色情,Abuse:謾罵,Ad:廣告,Custom:自訂違規;Badword:自訂嚴禁詞;Illegal:違規;Polity:涉政;Moan:呻吟;Terror:暴恐;Religion:宗教;Sexy:性感;Teenager:青少年;Copyright:版權;多個使用英文逗號分隔
labelDesc String 識別類型描述
moderationStrategyDesc String 策略描述
ocrKeyword String ocr關鍵詞
ocrText String ocr文本
politicalName String 涉政人物
resultType Integer 審核結果(1:通過,2:違規,3:疑似)
resultTypeDesc String 審核結果描述
sessionId String 場次id
taskId Integer 任務id
userId String POLYV用戶ID,和保利威官網一致,取得路徑:官網->登入->直播(開發設定)

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 resultListTest() 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/result/list";
    String channelId = "3775168";
    String label = "";
    String pageNumber = "1";
    String pageSize = "20";
    String resultType = "";
    String sessionId = "gj4z866us3";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("label", label);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    requestMap.put("resultType", resultType);
    requestMap.put("sessionId", sessionId);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询频道场次审核记录列表成功:{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "6c13efc8cc424973b7ba76deb33e664e.67.16796223224271993",
    "data": {
        "pageNumber": 1,
        "pageSize": 20,
        "totalPages": 2,
        "totalItems": 28,
        "contents": [
            {
                "id": 636,
                "userId": null,
                "channelId": 3775168,
                "sessionId": "gj4z866us3",
                "taskId": 304,
                "imageUrl": "http://oss-live-1.videocc.net/audio/video/3775168/b7649358-a8cd-4637-ae8c-f1c60b579395.jpg",
                "ocrText": "小王八掉眼泪 你鳖伤心",
                "ocrKeyword": "",
                "politicalName": "",
                "label": "Normal",
                "labelDesc": "正常",
                "resultType": 1,
                "resultTypeDesc": "通过",
                "moderationStrategyDesc": "严格审核策略",
                "createTime": 1678950744000
            },
            {
                "id": 635,
                "userId": null,
                "channelId": 3775168,
                "sessionId": "gj4z866us3",
                "taskId": 304,
                "imageUrl": "http://oss-live-1.videocc.net/audio/video/3775168/719a9814-e0eb-4e09-acb3-d183f342dc54.jpg",
                "ocrText": "",
                "ocrKeyword": "",
                "politicalName": "",
                "label": "Terror",
                "labelDesc": "暴恐",
                "resultType": 2,
                "resultTypeDesc": "违规",
                "moderationStrategyDesc": "严格审核策略",
                "createTime": 1678950685000
            }
        ]
    },
    "success": true
}

異常範例

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