Query Channel Live Screenshot

Updated: 2022-09-02 18:08:07

API Description

1、截图功能，查询当前频道正在直播的截图（截图五分钟更新一次）
2、接口URL中的{channelId}为频道号
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/stream/{channelId}/capture

Online API Call

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining 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

Example

http://api.polyv.net/live/v2/stream/1965681/capture

Form parameters:

appId=frlr1zazn3&sign=56CB347C3D71093F0D8EFBE59AF7CDA0&timestamp=1621842995655

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	String	Screenshot URL on success, empty on error

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java 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(ChannelOperateTest.class);
/**
 * 查询频道直播截图
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetCaptureImage() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v2/stream/%s/capture";
    String channelId = "1965681";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询频道直播截图，返回值：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "//liveimages.videocc.net/uploaded/images/2021/03/fx0p8ouo04.jpg"
}

Error example

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