Modify Seminar Meeting Type

Updated: 2023-02-22 10:48:49

Interface Description

1、修改研讨会会议类型
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

Interface URL

https://api.polyv.net/meet/v1/channel/live-type/update

Request Method

POST

Interface Constraints

The interface has a frequency limit. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Obtaining Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value See Signature Generation Rules
channelId	true	String	Channel ID

Request Body Parameter Description

Parameter	Required	Type	Description
seminarLiveType	true	String	Meeting type private - Internal seminar public - External live broadcast

Example

https://api.polyv.net/meet/v1/channel/live-type/update?appId=frlr1zazn3&sign=B6424CE5E5D94BB795BC7B3AA6058949&channelId=3589029&timestamp=1677033522629

Request body parameters:

{
    "seminarLiveType":"public"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business. Returns success on success, error on failure
success	Boolean	Whether the response is successful
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	Failure reason, returned on failure. Empty on success See data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

Java Request Example

For quick access to the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. HttpUtil.java and LiveSignUtil.java in the test case are included in the downloaded file.

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

private static final Logger log = LoggerFactory.getLogger(LiveTypeUpdate.class);
/**
 * 修改研讨会会议类型
 * @throws IOException
 */
@Test
public void testUpdateLiveType() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/meet/v1/channel/live-type/update";
    String channelId = "3589029";
    String body = "{\n" +
    "    \"seminarLiveType\":\"public\"\n" +
    "}";
    
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试修修改研讨会会议类型接口返回值：{}",response);
    //do somethings
}

Response Example

For system-wide error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "82c0b2fba8a940419c75540f3fb6a635.64.16652796585214411",
  "data": null,
  "success": true
}

Error Example

{
  "code": 400,
  "status": "error",
  "requestId": "82c0b2fba8a940419c75540f3fb6a635.60.16652797835524421",
  "error": {
    "code": 10001,
    "desc": "研讨会直播类型不正确"
  },
  "data": null,
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "6fa092a476ba43f3962c62de38557321.74.16652797988577027",
  "error": {
    "code": 30005,
    "desc": "非法频道ID: 2665820"
  },
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "c4920bc4c27e40e18a8a9241d462450a.64.16653728084970005",
  "error": {
    "code": 125001,
    "desc": "研讨中不允许修改配置"
  },
  "data": null,
  "success": false
}

Seminar Server API