修改頁面選單排序

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

介面描述

1、设置直播频道菜单的顺序
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/menu/update-rank

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
menuIds	true	String	頻道選單ID列表，必須是完整的列表（不能多也不能少），表示按該順序排列選單【該參數取得自查詢頻道頁面選單資訊】
lang	false	String	選單語言類型，預設為中文 zh_CN：中文 EN：英文

範例

http://api.polyv.net/live/v3/channel/menu/update-rank

表單參數：

appId=frlr1zazn3&sign=55100143DF26B4112363B86912B27EC4&menuIds=7694a2acd4%2C971d1c8c0d%2Cc40aab816d%2C75ab4023e2&channelId=2149813&timestamp=1621842781807

回應參數描述

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

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(MenuTest.class);
/**
 * 修改页面菜单排序
 * @throws IOException
 */
@Test
public void testUpdateRank() 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/channel/menu/update-rank";
    String channelId = "2149813";
    String menuIds = "7694a2acd4,971d1c8c0d,c40aab816d,75ab4023e2";

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

    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改页面菜单排序接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

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

異常範例

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