修改页面菜单信息

接口描述

1、修改页面菜单信息
2、接口支持https协议

接口URL

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

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

menuId

true

String

菜单id(互动聊天或咨询提问的菜单id不允许设置)【该参数获取自查询频道页面菜单信息

content

true

String

菜单的内容

lang

false

String

菜单语言类型,默认为中文 zh_CN:中文 EN:英文

示例

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

表单参数:

appId=frlr1zazn3&sign=AC442FBE7BC6939D3F0CD9C4322DBB68&menuId=7694a2acd4&channelId=2149813&content=%E6%B7%BB%E5%8A%A0%E7%9A%84%E6%B5%8B%E8%AF%95%E5%86%85%E5%AE%B9aaa&timestamp=1621842830447

响应参数描述

参数名类型说明

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 testUpdateChannelMenu() 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";
    String channelId = "2149813";
    String menuId = "7694a2acd4";
    String content = "添加的测试内容aaa";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("menuId",menuId);
    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": ""
}

Last updated