Pull Stream Live Start Interface
Updated: 2022-09-02 18:08:07
Interface URL
https://api.polyv.net/live/v3/channel/stream/start-pull-stream
Interface Description
1、执行开始拉流直播操作
2、接口支持https
Supported Format
JSON
Request Method
POST
Request Limit
TRUE
Request Parameters
| Parameter | 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 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 and obtain response data. For details, see Signature Generation Rules |
| channelId | Yes | int | Channel ID |
| pullUrl | Yes | string | Pull stream URL |
Successful Response JSON Example:
{
"code": 200,
"status": "success",
"message": "",
"data": ""
}
Failed Response JSON Examples:
No appId entered
{
"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": ""
}
Field Description
| Parameter | Type | Description |
|---|---|---|
| code | int | Response code: 200 for success, 400 for failure, 401 for signature error, 500 for exception error |
| status | string | "success" for success, "error" for failure |
| message | string | Error prompt message when an error occurs |
| data | object | Response result set |
Java Request Example
public static void testStartPullStream() {
String url = "https://api.polyv.net/live/v3/channel/stream/start-pull-stream";
// 用户对应的appId和加密串
String appId = "xxxxxxxxx";
String appSecret = "xxxxxxxxxxxxxxxxxxxxxxxxxx";
int channelId = 10001;
String pullUrl = "rtmp://xxxx";
Map<String, String> params = new HashMap<>();
params.put("channelId", String.valueOf(channelId));
params.put("pullUrl", pullUrl);
PolyvTool.setLiveSign(params, appId, appSecret);
// 调用Polyv的httpClient工具类发送请求
String content = HttpClientUtil.getInstance()
.sendHttpPost(url, params);
System.out.println(content);
}
