查詢頻道頁面選單資訊

更新時間：2025-09-25 23:58:46

介面描述

1、查询频道页面菜单信息
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/menu/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

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

範例

http://api.polyv.net/live/v3/channel/menu/list?appId=frlr1zazn3&sign=DDB34065848210FB6E5FCE0AC10AAF88&channelId=2149813&timestamp=1621842637766

回應參數說明

欄位	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	成功時為選單列表詳細資料【詳見data欄位說明】

data欄位說明

參數名	類型	說明
menuId	String	選單Id
menuType	String	選單類型 desc：直播介紹 chat：互動聊天 quiz：諮詢提問 text：圖文選單 iframe：推廣外鏈
name	String	選單名稱
ordered	String	排序
content	String	內容
lang	String	選單語言類型 zh_CN：中文 EN：英文
iframeOpenType	String	開啟方式（currentPage 目前頁面 menuDisplay 選單顯示 newPage 新頁面）（此參數針對選單類型為外鏈推廣時有效）
linkType	Integer	外鏈推廣選單連結類型（10:通用連結，11:多平台連結，預設10）（此參數針對選單類型為外鏈推廣時有效）

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 testChannelMenuList() 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/list";
    String channelId = "2149813";

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

    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道页面菜单信息接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "menuId": "7694a2acd4",
        "menuType": "text",
        "name": "测试菜单aa",
        "ordered": 1,
        "content": "添加的测试内容aaa",
        "lang": "zh_CN"
    }, {
        "menuId": "971d1c8c0d",
        "menuType": "desc",
        "name": "直播介绍",
        "ordered": 2,
        "content": "直播测试内容bbb",
        "lang": "zh_CN"
    }, {
        "menuId": "c40aab816d",
        "menuType": "quiz",
        "name": "提问",
        "ordered": 3,
        "content": null,
        "lang": "zh_CN"
    }, {
        "menuId": "75ab4023e2",
        "menuType": "chat",
        "name": "互动聊天",
        "ordered": 4,
        "content": "",
        "lang": "zh_CN"
    }]
}

異常範例

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