Delete Remastered Courseware
Updated: 2022-09-02 18:08:07
Interface URL
https://api.polyv.net/live/v3/channel/pptRecord/batch-delete
Interface Description
1、接口用于删除重制课件任务, 可批量参数，正在进行重制中的任务不能删除
2、接口支持https
Supported Format
JSON
Request Method
POST
Request Limit
TRUE
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Obtained from API settings, the appId registered in the live streaming system |
| timestamp | Yes | long | Current time in milliseconds (13-digit) |
| sign | Yes | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be saved 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 and obtain response data. See Signature Generation Rules |
| channelId | Yes | int | Channel number |
| taskIds | Yes | string | List of task IDs, multiple task IDs separated by "," |
Successful Response JSON Example:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"result": true
}
}
Response Field Description
| Parameter | Description |
|---|---|
| code | Status code: 200 for success, 403 for signature failure, 400 for parameter error, 500 for server error |
| status | "success" on success, "error" on failure |
| message | Empty string on success, error description on failure |
| data | Response data |
| data.result | Processing result: true for success |
Failed Response JSON Example:
Parameter error
{
"code": 400,
"status": "error",
"message": "param validate error",
"data": ""
}
appId not provided
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
Incorrect appId
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
Timestamp error
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Invalid channel number
{
"code": 403,
"status": "error",
"message": "illegal channel id: %s",
"data": ""
}
Java Request Example
public void testAddRecordTask() {
String url = "https://api.polyv.net/live/v3/channel/pptRecord/batch-delete";
// appId和加密串
String appId = "xxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxx";
String taskIds = "1,2,3";
int channelId = 123;
Map<String, String> params = new HashMap<>();
params.put("taskIds", taskIds);
params.put("channelId", String.valueOf(channelId));
// 调用Polyv的工具类方法设置sign
PolyvTool.setLiveSign(params, appId, appSecret);
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
