Modify Seminar Channel Recording Settings

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

API Description

1、修改研讨会频道录制设置
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/seminar/setting/set-record

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate 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
channelId	true	String	Channel ID
enabled	true	String	Recording switch, Y to enable, N to disable
recordMode	true	String	Recording mode, auto for automatic, manual for manual

Example

http://api.polyv.net/live/v3/channel/seminar/setting/set-record

Form parameters:

appId=frlr1zazn3&sign=01556AABE64ED5C285FF5378392FCD8C&channelId=2377623&timestamp=1621840770330&enabled=Y&recordMode=auto

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, provides error details when code is 400 or 500
data	Object	Response data

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the 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(ChannelSettingTest.class);
/**
 * 修改研讨会频道录制设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRecordSetting() 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/seminar/setting/set-record";
    String channelId = "2377623";
    String enabled = "Y";
    String recordMode = "auto";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("enabled", enabled);
    requestMap.put("recordMode", recordMode);
    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": null
}

Error Example

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