批次修改頻道皮膚
更新時間:2022-09-02 18:08:07
介面說明
1、批量修改频道装修皮肤
2、接口支持https协议
介面URL
http://api.polyv.net/live/v4/channel/decorate/skin/update-batch
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
2、僅支援新版後台,舊版後台若該頻道號已開啟通用設定,則無法修改成功。
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelIds | true | String | 用英文逗號分隔的頻道號,如:10000,100001 最多500個 |
| skin | true | String | 皮膚 black:時尚黑 red:喜慶紅 blue:科技藍 white:經典白 green:薄荷綠 golden:富貴金 |
範例
http://api.polyv.net/live/v4/channel/decorate/skin/update-batch?appId=frlr1zazn3&skin=green&sign=3BF08DAE570AAA601D2E12A3AA85E622&channelIds=2272655%2C1965681%2C2477096×tamp=1646289479777
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗 |
| status | String | 回應結果,由業務決定,成功返回success,失敗返回error |
| success | Boolean | 回應結果,由業務決定,成功返回true,失敗返回false |
| data | Object | 成功回應時返回true,失敗時返回false |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位說明】 |
| requestId | String | 請求ID,每次請求產生的唯一UUID,僅可用於排查、除錯,不應與業務掛鉤 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
/**
* 批量修改频道皮肤
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateSkin() 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/decorate/skin/update-batch";
String channelIds = "2272655,1965681,2477096";
String skin = "green";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelIds", channelIds);
requestMap.put("skin", skin);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postFormBody(url, null);
log.info("测试批量修改频道皮肤,返回值:{}", response);
}
回應範例
成功範例
{
"code": 200,
"status": "success",
"requestId": "9975d9a5cfb04944a89c7c7e14868ac2.70.16462894821814759",
"data": true,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360828899123425",
"error": {
"code": 30004,
"desc": "找不到频道"
},
"success": false
}
