新增頁面選單
更新時間:2025-09-25 23:58:46
介面說明
1、添加一个频道菜单
2、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/menu/add
請求方式
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 | 頻道號 |
| name | true | String | 選單名稱 |
| type | true | String | 選單類型 desc:直播介紹 chat:互動聊天 quiz:諮詢提問 text:圖文選單 iframe:推廣外鏈 qa:問答 buy:商品列表 invite:邀請榜 |
| content | false | String | 選單內容 當選單類型為直播介紹、圖文選單時,該值為選單的內容。 當選單類型為外鏈推廣時,如果連結類型是通用連結,該值為外鏈連結位址,如果連結類型是多平台連結,該值是json物件字串,json物件的屬性如下表說明。 當選單類型為互動聊天、諮詢提問時,該值不需要傳值,預設為null |
| lang | false | String | 選單語言類型,不傳該參數預設為中文 zh_CN:中文 EN:英文 |
| iframeOpenType | false | String | 開啟方式(currentPage 目前頁面 menuDisplay 選單顯示 newPage 新頁面)(此參數針對選單類型為外鏈推廣時有效) |
| linkType | false | Integer | 外鏈推廣選單連結類型(10:通用連結,11:多平台連結,預設10)(此參數針對選單類型為外鏈推廣時有效) |
外鏈推廣多平台連結物件參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| jumpWay | String | 跳轉方式:NEW_WINDOW(新視窗)/CURRENT_WINDOW(目前視窗)/POP_UP(彈出視窗) |
| link | String | 通用連結 |
| pcLink | String | PC端連結 |
| mobileLink | String | 行動端連結 |
| wxMiniprogramOriginalId | String | 小程式原始ID |
| wxMiniprogramAppId | String | 小程式APPID |
| wxMiniprogramLink | String | 小程式頁面路徑 |
| mobileAppLink | String | 手機app連結 |
| iosLink | String | iOS連結 |
| androidLink | String | Android連結 |
| otherLink | String | 其他連結 |
範例
http://api.polyv.net/live/v3/channel/menu/add
表單參數:
appId=frlr1zazn3&name=%E6%B5%8B%E8%AF%95%E8%8F%9C%E5%8D%95aa&sign=6032B243196C57BCEFE7C063DCEFEC9F&type=text&channelId=2306525&content=%E8%8F%9C%E5%8D%95%E5%86%85%E5%AE%B9aaaa×tamp=1621842602123
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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:推廣外鏈 qa:問答 buy:商品列表 invite:邀請榜 |
| name | String | 選單名稱 |
| ordered | Integer | 選單順序,值越小,越靠前。新新增的選單預設位於最後。 |
| content | String | 選單內容 |
| lang | String | 選單語言類型 zh_CN:中文 EN:英文 |
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 testAddMenu() 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/add";
String channelId = "2149813";
String name = "测试菜单aa";
String type = "text";
String content = "菜单内容aaaa";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("name",name);
requestMap.put("type",type);
requestMap.put("content",content);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试增加页面菜单接口返回值:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"menuId": "7694a2acd4",
"menuType": "text",
"name": "测试菜单aa",
"ordered": 5,
"content": "菜单内容aaaa",
"lang": "zh_CN"
}
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
