保利威文档中心

幫助中心

刪除重製課件

更新時間:2022-09-02 18:08:07

介面URL

https://api.polyv.net/live/v3/channel/pptRecord/batch-delete

介面說明

1、接口用于删除重制课件任务, 可批量参数,正在进行重制中的任务不能删除
2、接口支持https

支援格式

JSON

請求方式

POST

請求數限制

TRUE

請求參數

參數名 必選 類型 說明
appId string 從API設定中取得,在直播系統登記的appId
timestamp long 13位當前毫秒級時間戳
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
channelId int 頻道號
taskIds string 任務ID列表,多個任務ID使用","進行分隔

回應成功JSON範例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "result": true
    }
}

回應欄位說明

參數名 說明
code 狀態碼,成功為200,簽名失敗為403,參數錯誤為400,服務端錯誤為500
status 成功為success,錯誤時為error
message 成功為"",錯誤時為錯誤描述資訊
data 回應資料
data.result 處理結果,true成功

回應失敗JSON範例:

參數錯誤

{
    "code": 400,
    "status": "error",
    "message": "param validate error",
    "data": ""
}

未輸入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正確

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

時間戳錯誤

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

簽名錯誤

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

非法頻道號

{
    "code": 403,
    "status": "error",
    "message": "illegal channel id: %s",
    "data": ""
}

java請求範例

public void testAddRecordTask() {
        String url = "https://api.polyv.net/live/v3/channel/pptRecord/batch-delete";
        // appId和加密串
        String appId = "xxxxxxx";
        String appSecret = "xxxxxxxxxxxxxxxxxx";
        String taskIds = "1,2,3";
        int channelId = 123;
        Map<String, String> params = new HashMap<>();
        params.put("taskIds", taskIds);
        params.put("channelId", String.valueOf(channelId));
        // 调用Polyv的工具类方法设置sign
        PolyvTool.setLiveSign(params, appId, appSecret);
        String content = HttpClientUtil.getInstance()
                .sendHttpPost(url, params);
        System.out.println(content);
}
联系客服,在线咨询