Channel Live Recording Mark Feature

Updated: 2024-05-28 09:38:29

Interface Description

1、设置直播录制打点
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v3/channel/record/add-breakpoint

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 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 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 for response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID
type	true	String	Mark type, pause to pause recording, resume to continue recording
fromStartStop	false	String	Whether to pause recording from the very beginning. Y means yes, otherwise no. Only effective when type is pause.

Example

https://api.polyv.net/live/v3/channel/record/add-breakpoint

Form Parameters:

appId=frlr1zazn3&origin=playback&sign=01556AABE64ED5C285FF5378392FCD8C&channelId=10003&type=pause

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, provides error details when code is 400 or 500
data	Boolean	Returns true on successful request, returns empty on failure

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The 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 encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(ChannelRecordTest.class);
/**
 * 频道直播录制打点
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddBreakPoint() 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/record/add-breakpoint";
    String channelId = "2139283";
    String type = "pause";

    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    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 global system error descriptions, see Global Error Description

Success Example

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

Error Example

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

{
"code": 400,
"status": "error",
"message": "channel in no live",//频道在直播中才能设置
"data": ""
}

Live Streaming Server API