修改直播分類順序
更新時間:2022-09-02 18:08:07
接口描述
1、修改直播频道分类的顺序
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/user/category/update-rank
請求方式
POST
接口限制
1、接口同時支援HTTP、HTTPS,建議使用HTTPS以確保接口安全,接口呼叫有頻率限制,詳細請查看
2、「預設分類」不允許移動順序
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則】 |
| categoryId | true | String | 分類id |
| afterCategoryId | true | String | 將分類id位置移動到該id對應的分類之後 |
範例
http://api.polyv.net/live/v3/user/category/update-rank
表單參數:
afterCategoryId=345111&appId=frlr1zazn3&sign=B4B478890FEE3A332984025DF46FB7B0&categoryId=345134×tamp=1621841596190
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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 testUpdateCategoryRank() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/user/category/update-rank";
String categoryId = "345134";
String afterCategoryId="345111";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("categoryId", categoryId);
requestMap.put("afterCategoryId", afterCategoryId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试修改直播分类顺序,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":""
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
