保利威文档中心

幫助中心

影片禁播與解禁

更新時間:2025-01-14 15:47:36

介面說明

1、通过视频id将视频修改为解禁状态或禁播状态,解禁状态的视频可以正常播放,禁播状态的视频无法播放,一次最多只能操作500个视频id
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/forbidden

線上API呼叫

請求方式

POST

介面限制

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

2、注意事項: 只能修改「已發布」狀態的影片為禁播狀態, 只能修改「已禁播」狀態的影片為已發布狀態, 當請求中的影片id包含多種狀態時,只對符合條件的影片id進行狀態修改操作,並回傳成功;若沒有符合條件的影片id則回傳錯誤。

請求參數說明

參數名 必填 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器轉發呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
vids true String 影片id,多個影片以英文逗號分隔,如a2dc4f25179499d6586362672838cc2d_a,a2dc4f25179499d6586362672838cc2d_a 一次最多只能傳500個影片id
forbidden true Integer 影片狀態
1:禁播
0:解禁

範例

http://api.polyv.net/v2/video/1b448be323/forbidden

表單參數:

vids=1b448be3239c2ef0cb3ab9fd105f7fb2_1&forbidden=1&sign=5FBEB20C93D6FB6D715756CA0D25DBE96EFAD05A&ptime=1617156768546

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功回傳,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 回應成功和失敗都回傳空字串

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(VodVideoManageManagementTest.class);
/**
 *视频禁播与解禁
 */
@Test
public void testSetForbiddenStatus() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/video/"+userId+"/forbidden";
    String vids="1b448be3239c2ef0cb3ab9fd105f7fb2_1";
    String forbidden=String.valueOf(1);

    //调用参数
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userId", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);
    requestMap.put("forbidden", forbidden);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试视频禁播与解禁,{}", response);
    //do somethings
}

回應範例

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

成功範例

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

異常範例

簽名錯誤

 {
     "code": 400,
     "status": "error",
     "message": "the sign is not right.",
     "data": ""
 }

時間戳過期

{
    "code": 400,
    "status": "error",
    "message": "ptime is too old",
    "data": ""
}

一次最多只能操作500個vid

{
    "code": 400,
    "status": "error",
    "message": "vid count can't over 500",
    "data": ""
}

只能修改「已發布」狀態的影片為禁播狀態

{
    "code": 400,
    "status": "error",
    "message": "只能修改“已发布”状态的视频为禁播状态",
    "data": ""
}

只能修改「已禁播」狀態的影片為已發布狀態

{
    "code": 400,
    "status": "error",
    "message": "只能修改“已禁播”状态的视频为已发布状态",
    "data": ""
}
联系客服,在线咨询