Delete Channel Menu

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

API Description

1、删除频道菜单
2、接口支持https协议

API URL

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

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 details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 your own server to relay requests to the POLYV server for response data.` See signature generation rules
menuIds	true	String	Menu IDs. Separate multiple IDs with commas. Obtain this parameter 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/delete

Form Parameters:

appId=frlr1zazn3&sign=BF5C6D0DE307CD3A48A93519574E000A&menuIds=7694a2acd4&timestamp=1621842890503

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details.
data	String	Returns 1 on success, empty on error.

Java Request Example

For quick integration, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source 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 testMenuDelete() 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/delete";
    String menuIds = "7694a2acd4";

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

    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 global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API