Restore Videos from Recycle Bin

Updated: 2025-01-14 15:18:04

API Description

1、通过视频id恢复回收站中的视频到视频列表，支持批量恢复，一次性最多支持恢复100个视频
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

API URL

http://api.polyv.net/v2/video/{userid}/recover-videos

<a href="/req.html?api=http://api.polyv.net/v2/video/{userid}/recover-videos"" target="_blank">Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
ptime	true	Long	Current time in milliseconds timestamp, valid for 3 minutes
sign	true	String	Signature, a 40-character uppercase SHA1 value. `The secretkey 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
vids	true	String	Video IDs, multiple videos separated by English commas, up to 100 at a time

Example

http://api.polyv.net/v2/video/1b448be323/recover-videos

Form parameters:

vids=1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1&sign=B72906295FF92E1A07338DBB5BEBEDFD69BD4EE6&ptime=1617154178480

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, auxiliary error reason when code is 400 or 500
data	String	Returns empty for both success and failure

Error Code List

Error Code	message	Description
400	sign can not be empty.	Encryption string is empty
400	ptime is too old.	Timestamp expired
400	ptime is illegal.	Timestamp parameter format is incorrect or exceeds current time by 3 minutes
400	Could not find user by userId.	userId does not exist
400	the sign is not right.	Incorrect signature
400	vids can't be empty	Video vid is empty
400	vids limits 100	vids count exceeds 100

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD 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(VodVideoManagementTest.class);
/**
 * 从回收站恢复视频
 */
@Test
public void testRecoverVideo() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/v2/video/"+userId+"/recover-videos";
    String vids = "1b448be323e6eee0484ad35a4b55b96d_1,1b448be323e131655fe4a70cc01fd490_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userId", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);

    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试从回收站恢复视频,{}", response);
    //do somethings
}

Response Example

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

Success Example

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

Error Example

Incorrect signature

{
    "code":400,
    "status":"error",
    "message":"the sign is not right",
    "data":""
}

Timestamp expired

{
    "code":400,
    "status":"error",
    "message":"ptime is too old.",
    "data":""
}

Video vids is empty

{
    "code":400,
    "status":"error",
    "message":"vids can't be empty",
    "data":""
}

vids count exceeds 100

{
    "code":400,
    "status":"error",
    "message":"vids limits 100",
    "data":""
}

VOD Server API