Get RTMP Pull URL for a Channel
Updated: 2022-09-02 18:08:07
Interface URL
https://api.polyv.net/live/v3/channel/monitor/rtmp-pull-url
Interface Description
1、接口用于获取频道获取频道的rtmp拉流地址
2、接口支持https
Response Format
JSON
Request Method
GET
Request Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Obtained from API settings, the appId registered in the live streaming system |
| timestamp | Yes | long | Current 13-digit millisecond timestamp, valid within 3 minutes |
| sign | Yes | 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 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 and obtain response data. See signature generation rules |
| channelId | Yes | int | Channel ID |
| day | Yes | int | Validity period in days, e.g., 1 means valid for one day from the current time |
Successful Response JSON Example:
{
"code": 200,
"status": "success",
"message": "",
"data": "rtmp://pull-d1.videocc.net/recordf/4f57ea01de16002237826505a7b?auth_key=1602645379-0-0-5d6bc0d1ea472b161ee9e0ea3646bess"
}
Failed Response JSON Example:
No appId provided
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
Incorrect appId
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
Timestamp error
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Illegal access
{
"code": 400,
"data": "",
"message": "forbidden",
"status": "error"
}
Field Description
| Parameter | Description |
|---|---|
| code | Response code: 200 for success, 400 for failure, 403 for signature error, 500 for exception error |
| status | "success" for success, "error" for failure |
| message | Error message when an error occurs |
| data | Success data |
Java Request Example
public static void test() {
String url = "https://api.polyv.net/live/v3/channel/monitor/rtmp-pull-url";
// 用户对应的appId和加密串
String appId = "xxxxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
int channelId = 10001;
Map<String, String> params = new HashMap<>();
params.put("channelId", channelId);
params.put("day", 1);
PolyvTool.setLiveSign(params, appId, appSecret);
// 调用Polyv的httpClient工具类发送请求
String content = HttpClientUtil.getInstance()
.sendHttpGet(url + "?" + PolyvTool.mapJoinNotEncode(params));
System.out.println(content);
}
