Batch Publish Staged Video Subtitle Files

Updated: 2025-07-21 10:06:59

Interface Description

1、用于批量设置暂存视频字幕文件的发布状态，控制字幕在观看页是否显示
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v4/channel/record-file/subtitle/batch-publish

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See 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]
subtitles	true	Array	Subtitle publishing information list
subtitles[].id	true	Integer	Subtitle ID
subtitles[].status	true	String	Subtitle status, finish - not displayed on the viewing page, publish - displayed on the viewing page

Example

http://api.polyv.net/live/v4/channel/record-file/subtitle/batch-publish?appId=xxx&timestamp=1691559540000&sign=xxx

Request Body Example

[
  {
    "id": 123,
    "status": "publish"
  },
  {
    "id": 124,
    "status": "finish"
  }
]

Response Parameter Description

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 the business. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when the status code is not 200 [See Error Field Description]
data	Object	[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

Data Parameter Description

Returns an empty object on success.

Java Request Example

For quick integration of the 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 to implement API functionality. The Live Java SDK provides a unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 暂存视频的字幕文件批量发布
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void batchPublishSubtitleTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/record-file/subtitle/batch-publish";
    
    //请求body数据
    List<Map<String, Object>> subtitles = new ArrayList<>();
    Map<String, Object> subtitle1 = new HashMap<>();
    subtitle1.put("id", 123);
    subtitle1.put("status", "publish");
    subtitles.add(subtitle1);
    
    Map<String, Object> subtitle2 = new HashMap<>();
    subtitle2.put("id", 124);
    subtitle2.put("status", "finish");
    subtitles.add(subtitle2);
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.postJson(url, requestMap, JsonUtil.toJson(subtitles));
    log.info("测试暂存视频的字幕文件批量发布成功：{}", response);
    //do somethings
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "data": {},
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "字幕id不能为空"
    },
    "success": false
}

Live Streaming Server API