Move a Single Video Up or Down in the Video Library (Including VOD List and Playback List)

Updated: 2024-07-29 11:17:04

Interface Description

1、修改视频库单个视频的上移、下移（包括点播列表和回放列表）
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/playback/single-sort

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to frequency limits. Click here for 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
listType	false	String	Sorting list type. Default is vod for standard live streaming scenarios, and playback for three-panel scenarios. playback: Playback list vod: VOD list
type	true	String	Move type, up for moving up, down for moving down
videoId	true	String	Video ID in the video library

Example

https://api.polyv.net/live/v3/channel/playback/sort?appId=frlr1zazn3&sign=840FF35DB291A8C010F7CE14A0A985CA&videoId=xxxxx&listType=vod&channelId=2139283&timestamp=1621841731282

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, assists in describing the error reason when code is 400 or 500
data	String	Returns an empty string whether the request succeeds or fails

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelPlayBackTest.class);
/**
 * 修改视频库单个视频的上移、下移（包括点播列表和回放列表）
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetPlaybackSingleSort() 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/v3/channel/playback/single-sort";
    String channelId = "2139283";
    String videoId = "xxxx";
    String type = "up"
    String listType = "vod";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("listType", listType);
    requestMap.put("videoId", videoId);
    requestMap.put("type", type);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改视频库单个视频的上移、下移（包括点播列表和回放列表），返回值：{}", response);
    //do somethings
    
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

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

Error Example

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

{
    "code": 400,
    "status": "error",
    "message": "playback video unable to sort",//排序异常或者无需排序
    "data": ""
}

Live Streaming Server API