保利威文档中心

帮助中心

查询频道页面菜单信息

更新时间: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": ""
}
联系客服,在线咨询