Modify Question Feature Toggle

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

API Description

1、开启或关闭咨询提问功能开关
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channel/menu/{channelId}/update-consulting-enabled

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 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]
enabled	true	String	Consultation question toggle Y: Enable N: Disable

Example

http://api.polyv.net/live/v2/channel/menu/2149813/update-consulting-enabled

Form Parameters:

appId=frlr1zazn3&sign=2A842151E2E8C75314A93AD59065B923&enabled=N&timestamp=1621842718832

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 reason
data	Object	Empty for both success and failure

Java Request Example

For quick integration of the base code, please 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, both contained in the download 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 pools.

private static final Logger log = LoggerFactory.getLogger(MenuTest.class);
/**
 * 修改提问功能开关
 * @throws IOException
 */
@Test
public void testUpdateConsultingEnabled() 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/channel/menu/%s/update-consulting-enabled",channelId);
    String enabled = "N";

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

    requestMap.put("enabled",enabled);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改提问功能开关接口返回值：{}",response);
    //do somethings

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API