修改轉存成功回調設定

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

介面描述

1、设置账号下转存回放视频成功通知回调地址的接口
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/user/{userId}/set-playback-callback

線上API呼叫

請求方式

POST

介面限制

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

2、不提交地址參數url，則回調地址為空，表示關閉回調功能，如果要提交的地址參數url，必須以 http:// 或者 https:// 開頭

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
url	false	String	回調地址url，不提交表示關閉回調功能，如果提交，必須以 http:// 或者 https:// 開頭

範例

http://api.polyv.net/live/v2/user/1b448be323/set-playback-callback

表單參數：

appId=frlr1zazn3&sign=DD7AB7AA70DB70B14EA7EE193E8B6C4A&callback=http%3A%2F%2Fwww.baidu.com&timestamp=1636447775416

回應參數描述

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

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 修改转存成功回调
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetPlaybackCallback() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/user/%s/set-playback-callback",userId);
    String callBack = "http://www.baidu.com";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("url", callBack);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置转存成功回调通知url，返回值：{}", response);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

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