Modify Page Menu Order

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

API Description

1、设置直播频道菜单的顺序
2、接口支持https协议

API URL

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

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
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. 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]
channelId	true	String	Channel ID
menuIds	true	String	List of channel menu IDs. Must be a complete list (cannot have extra or missing items), indicating the order to arrange menus. [This parameter is obtained from Query Channel Page Menu Information]
lang	false	String	Menu language type, default is Chinese zh_CN: Chinese EN: English

Example

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

Form Parameters:

appId=frlr1zazn3&sign=55100143DF26B4112363B86912B27EC4&menuIds=7694a2acd4%2C971d1c8c0d%2Cc40aab816d%2C75ab4023e2&channelId=2149813&timestamp=1621842781807

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, provides error details when code is 400 or 500
data	String	"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 integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(MenuTest.class);
/**
 * 修改页面菜单排序
 * @throws IOException
 */
@Test
public void testUpdateRank() 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-rank";
    String channelId = "2149813";
    String menuIds = "7694a2acd4,971d1c8c0d,c40aab816d,75ab4023e2";

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

    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": ""
}

Live Streaming Server API