Clear Group Records

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

API Description

1、清空研讨会分组记录
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/seminar/group/plan/delete-all

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 Parameters

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 side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	Integer	Channel ID

Example

https://api.polyv.net/live/v4/seminar/group/plan/delete-all?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=3220878

Response Parameters

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

Error Parameters

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 integration of the base code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own project source code. 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(GroupPlanDeleteAll.class);
/**
 * 清空分组记录
 * @throws IOException
 */
@Test
public void testGroupPlanDeleteAll() 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/live/v4/seminar/group/plan/delete-all";
    String channelId = "2191532";

    //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));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("清空分组记录，返回值：{}",response);

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

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

Error Example

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}

{
  "code": 403,
  "status": "error",
  "error": {
    "code": 10002,
    "desc": "签名错误"
  },
  "success": false
}