你的位置：首页 / 云直播 / 直播平台API / 频道管理 / 直播状态

查询频道实时推流信息

由发表

接口URL

http://api.polyv.net/live/v3/channel/monitor/get-stream-info

接口说明

1、接口用于获取频道的实时推流信息
2、接口支持https
3、deployAddress、inAddress、lfr信息可能无法获取，返回值为null

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId 是 string 管理员的appId
timestamp 是 long 13位当前时间戳
sign 是 string 签名值
channelId 是 int 频道号

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "deployAddress": "110.88.149.24",
        "inAddress": "110.43.33.126",
        "streamName": "push2.videocc.net/record/edvf2fpec920180705234706134",
        "fps": "15",
        "lfr": "0.0",
        "inBandWidth": "641829"
    }
}

// 暂时未能获取推流信息，请稍后重试
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "deployAddress": null,
        "inAddress": null,
        "streamName": null
        "fps": null,
        "lfr": null,
        "inBandWidth": null
    }
}

响应失败JSON示例：

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

频道当前暂无直播

{
    "code": 400,
    "status": "error",
    "message": "channel status not live",
    "data": ""
}

签名错误

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

字段说明

参数名 说明
code 响应代码，成功为200，失败为400，签名错误为403，异常错误500
status 成功为success，失败为error
message 错误时为错误提示消息
data.deployAddress 推送的CDN节点IP，可能会为null
data.inAddress 推流出口ip，可能会为null
data.streamName 流名
data.fps 推流帧率
data.lfr 推流丢帧率，可能会为null
data.inBandWidth 推流码率

请求示例

<?php

//引用config.php
include 'config.php';

//接口URL上变量
$channelId = "123456";
//接口需要的参数（非sign）赋值
$params = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp,
    'channelId'=>$channelId
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url = "http://api.polyv.net/live/v3/channel/monitor/get-stream-info?appId=".$appId."&sign=".$sign."&timestamp=".$timestamp."&channelId=".$channelId;
//输出接口请求结果
echo file_get_contents($url);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

禁止直播频道推流

由发表

旧版接口地址

接口URL

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

接口说明

1、作用：禁止频道号推流（禁止有效期为24小时，24小时后会恢复频道）
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
userId 是 string 直播账号ID
sign 是 string 签名，为32位大写的MD5值

响应成功JSON示例：

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

响应异常JSON示例：

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

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

字段说明

参数名 类型 说明
code int http code值
status string 状态值
message string 提示的信息
data string 相应的结果

php请求示例

<?php
//接口需要的参数（非sign）赋值
$userId = "XXXXXXXX";
$channelId = "127075";

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url = "http://api.polyv.net/live/v2/stream/$channelId/cutoff?appId=$appId&timestamp=$timestamp&userId=$userId&sign=$sign";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

恢复直播频道推流

由发表

接口URL

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

接口说明

1、作用：恢复频道号推流
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
userId 是 string 直播账号ID
sign 是 string 签名，为32位大写的MD5值

响应成功JSON示例：

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

响应异常JSON示例：

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

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

字段说明

参数名 类型 说明
code int http code值
status string 状态值
message string 提示的信息
data string 相应的结果

php请求示例

<?php
//接口需要的参数（非sign）赋值
$userId = "XXXXXXXX";
$channelId = "127075";

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url = "http://api.polyv.net/live/v2/stream/$channelId/resume?appId=$appId&timestamp=$timestamp&userId=$userId&sign=$sign";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置频道为无直播状态

由发表

接口URL

http://api.polyv.net/live/v2/channels/{channelId}/end

接口说明

1、作用：设置频道状态为无直播状态
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

请求方式

POST

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
userId 是 string 直播账号ID
sign 是 string 签名，为32位大写的MD5值

响应参数

参数名 说明
code 响应状态码
status 响应状态
message 异常错误信息
data 异常错误数据

响应成功JSON示例

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

响应异常JSON示例

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

PHP请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数（非sign）赋值
$channelId = "127075";
$userId = "XXXXXXXX";

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url="http://api.polyv.net/live/v2/channels/$channelId/end?appId=".$appId."&timestamp=".$timestamp."&userId=".$userId."&sign=".$sign;

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

批量查询频道直播流状态

由发表

接口URL

http://api.polyv.net/live/v2/channels/live-status

接口说明

1、作用：批量获取频道直播状态接口
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
channelIds 是 string 用逗号隔开的频道ID，如：10000,100001 最多20个
sign 是 string 签名，32位大写MD5值

响应成功JSON示例：

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
    {
    "channelId":100001,
    "status":"live"
    },
    {
    "channelId":100002,
    "status":"end"
    }
     ]
}

响应失败JSON示例：

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

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

签名错误

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

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 频道状态相关信息
data.channelId 频道ID，整型
data.status 频道的直播状态，字符串，值包括：live end

php请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数（非sign）赋值
$channelIds = "101385,108888";

$params = array(
    'appId'=>$appId,
    'channelIds'=>$channelIds,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$data = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'channelIds' => $channelIds,
    'sign' => $sign
);

$url = "http://api.polyv.net/live/v2/channels/live-status";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$reponse = curl_exec ( $ch );
curl_close ( $ch );
print_r($reponse);

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

设置频道流状态为直播中

由发表

接口URL

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

接口说明

1、作用：设置频道状态为直播中状态
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

请求方式

POST

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 string 当前13位毫秒级时间戳，3分钟内有效
userId 是 string 直播账号ID
sign 是 string 签名，为32位大写的MD5值

响应参数

参数名 说明
code 响应状态码
status 响应状态
message 异常错误信息
data 异常错误数据

响应成功JSON示例

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

响应异常JSON示例

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

PHP请求示例

<?php

//引用config.php
include 'config.php';

//接口需要的参数（非sign）赋值
$channelId = "127072";
$userId = "XXXXXXXX";

$params = array(
    'appId'=>$appId,
    'userId'=>$userId,
    'timestamp'=>$timestamp
  );

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

//接口请求url
$url="http://api.polyv.net/live/v2/channels/$channelId/live?appId=".$appId."&timestamp=".$timestamp."&userId=".$userId."&sign=".$sign;

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;

?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...

查询频道直播状态

由发表

接口URL

http://api.polyv.net/live_status/query

接口说明

1、作用：获取频道直播状态
2、接口支持https协议

请求方式

GET

请求参数限制

true

请求参数

参数名 必选 类型 说明
stream 是 string 可调用获取频道信息接口，获取stream字段的值

返回结果

如果正在直播，返回live，否则返回end。

请求示例：http://api.polyv.net/live_status/query?stream=eciyhturt820160305194727292

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
Loading...