Get Live Real-Time Streaming Information for CDN Channels (Alibaba Cloud, Tencent Cloud CDN)

Updated: 2023-05-11 18:18:29

API Description

1、获取cdn频道的直播实时推流信息(阿里、腾讯cdn)
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/monitor/list-stream-info

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. Click here for details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
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 to obtain response data.` [See Signature Generation Rules]
timestamp	true	String	Current 13-digit millisecond timestamp, valid for 3 minutes
channelId	true	String	Channel ID
endTime	false	String	End time
startTime	false	String	Start time

Example

http://api.polyv.net/live/v4/channel/monitor/list-stream-info?appId=frlr1zazn3&sign=4815DC1E0AA6F22AC5D38D38924BEFDB&startTime=&endTime=&channelId=3889955&timestamp=1683799860694

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
data	Array	Data for successful response [See Data Parameter Description]
error	Object	Error information when status code is not 200 [See Error Parameter Description]
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
status	String	Response result, determined by business logic. Returns "success" on success, "error" on failure
success	Boolean	Whether the response was successful

Data Parameter Description

Parameter	Type	Description
audioFrameRate	String	Audio frame rate of the live stream
bitRate	String	Bit rate of the live stream
streamUrl	String	URL of the live stream
time	String	Statistical time (UTC time)
timestamp	Integer	Current 13-digit millisecond timestamp
videoFrameRate	String	Video frame rate of the live stream

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

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. The test cases include HttpUtil.java and LiveSignUtil.java, both included in the downloaded file.

It is strongly recommended to use the Live Java SDK to implement API functionality. 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(getClass());
/**
* 获取cdn频道的直播实时推流信息(阿里、腾讯cdn)
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void monitorListStreamInfoTest() 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/monitor/list-stream-info";
    String channelId = "3889955";
    String endTime = "";
    String startTime = "";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("endTime", endTime);
    requestMap.put("startTime", startTime);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试获取cdn频道的直播实时推流信息(阿里、腾讯cdn)成功：{}", response);
    //do somethings

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "63181d5d82fc4dd785a33de52375bd48.71.16837998896517145",
    "data": [
        {
            "streamUrl": "rtmp://push-d1.videocc.net/recordf/1b448be32316811158957436c19",
            "bitRate": "1176815.9",
            "audioFrameRate": "46.9",
            "videoFrameRate": "15.016666",
            "time": "2023-05-11T10:09:00Z",
            "timestamp": 1683799740000
        }
    ],
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API