Modify Live Stream Introduction Menu

Updated: 2022-09-02 18:08:07

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
content	true	String	Content of the live stream introduction (HTML page content can be filled here, such as adding images, text styles, etc.)
menuType	true	String	Menu type, currently only supports the value desc

Example

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

Form parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description message, assists in describing error reasons when code is 400 or 500
data	String	Returns "success" on success, empty on error

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "success"
}

Error Example

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