修改直播介绍菜单

接口描述

1、设置自定义菜单中用户设置菜单的直播介绍
2、接口URL中的{userId}为直播账号ID
3、接口URL中的{channelId}为频道号
4、接口支持https协议

接口URL

http://api.polyv.net/live/v2/channelSetting/{userId}/{channelId}/set-menu

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
content	true	String	直播介绍的内容（此处可以填html页面的相关内容，如增加图片、增加文字样式等）
menuType	true	String	菜单类型，目前仅支持取值为desc

示例

http://api.polyv.net/live/v2/channelSetting/1b448be323/2149813/set-menu

表单参数：

appId=frlr1zazn3&sign=8F36F34A385F8F35CF9763FAC49F49CB&menuType=desc&content=%E7%9B%B4%E6%92%AD%E6%B5%8B%E8%AF%95%E5%86%85%E5%AE%B9bbb&timestamp=1621842860985

响应参数描述

参数名	类型	说明
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 testSetmenu() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "2149813";
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/%s/set-menu",userId,channelId);
    String menuType = "desc";
    String content = "直播测试内容bbb";

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

    requestMap.put("menuType",menuType);
    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": "success"
}

异常示例

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