修改頻道自訂授權設定

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

介面描述

1、修改频道自定义授权设置
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelSetting/{userId}/oauth-custom

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
customUri	true	String	自訂授權地址
channelId	false	String	要設定的頻道號，不提交或傳0則設定所有頻道

範例

http://api.polyv.net/live/v2/channelSetting/1b448be323/oauth-custom

表單參數：

customUri=http%3A%2F%2Fmywebsite.com%2FmyDefinedUrl.php&appId=frlr1zazn3&sign=5CAA286F2278FDEBE90A253506E16790&channelId=2191532&timestamp=1621843813824

回應參數說明

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

data欄位說明

參數名	類型	說明
channelId	String	設定的頻道號
secretKey	String	頻道號對應外部授權的secretKey

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 修改频道自定义授权设置
 * @throws IOException
 */
@Test
public void testSetAuthorizedAddress() 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/channelSetting/%s/oauth-custom",userId);
    String channelId = "2191532";
    String customUri = "http://mywebsite.com/myDefinedUrl.php";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("customUri",customUri);


    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道自定义授权设置接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "channelId": 2191532,
        "secretKey": "6mu6166v4l"
    }]
}

異常範例

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