接口URL
https://api.polyv.net/live/v3/channel/watch/tuwen/list
接口说明
1、接口用于获取频道图文内容列表
2、接口支持https
支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| timestamp | 是 | long | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | 是 | string | 签名，为32位大写的MD5值 |
| channelId | 是 | int | 频道号 |
| id | 否 | int | 图文内容的序列号：为空表示获取第一页数据，且同时会返回置顶数据。非空表示获取 id 比该值小的记录（也就是更早发布的内容），此时不返回置顶列表。 |
| imageMode | 否 | string | 是否为图片模式，Y表示为图片模式，N表示文字加图片的模式，默认为N |
响应成功JSON示例：
{
"code": 200,
"status": "success",
"message": "",
"data": {
"total": 5,
"contents": [
{
"id": 17378,
"channelId": 409708,
"text": "<p>对对对</p>",
"images": [
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741331430886.png",
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741331490988.jpeg"
],
"top": "N",
"createdTime": 1574133151000
},
{
"id": 17376,
"channelId": 409708,
"text": "<p>地方地方地方</p>",
"images": [
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741331256627.jpeg"
],
"top": "N",
"createdTime": 1574133129000
},
{
"id": 17374,
"channelId": 409708,
"text": "<p>顶顶顶顶</p>",
"images": [],
"top": "N",
"createdTime": 1574133116000
},
{
"id": 17372,
"channelId": 409708,
"text": "<p>dddddd哈哈哈</p>",
"images": [
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741323650758.jpeg"
],
"top": "N",
"createdTime": 1574132371000
},
{
"id": 17370,
"channelId": 409708,
"text": "<p>hello</p>",
"images": [
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741323407247.png"
],
"top": "Y",
"createdTime": 1574132348000
}
],
"topContents": [
{
"id": 17370,
"channelId": 409708,
"text": "<p>hello</p>",
"images": [
"http://liveimages.videocc.net/uploadimage/20191119/chat_img_409708_15741323407247.png"
],
"top": "Y",
"createdTime": 1574132348000
}
],
"setting": {
"id": 22162,
"nickname": "主持人",
"actor": "主持人",
"avatar": "//livestatic.videocc.net/assets/wimages/pc_images/logo.png"
}
}
}
响应失败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": 400,
"status": "error",
"message": "param is not digit: dsadasd",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码，成功为200，失败为400，签名错误为401，异常错误500 |
| status | 成功为success，失败为error |
| message | 错误时为错误提示消息 |
| data | 成功响应时为回放详情分页数据 |
| total | 总的返回结果条数 |
| contents | 返回的图文列表内容，是个数组 |
| id | 图文内容序列号,可用于查询条件参数id |
| channelId | 频道ID |
| text | 文本内容 |
| images | 图片地址，是个数组 |
| top | 是否置顶，Y表示是，N表示否 |
| createdTime | 内容发送的时间，13位的时间戳 |
| topContents | 置顶的图文信息，是个数组 |
| id | 图文内容序列号,可用于查询条件参数id |
| channelId | 频道ID |
| text | 文本内容 |
| images | 图片地址，是个数组 |
| top | 是否置顶，Y表示是，N表示否 |
| createdTime | 内容发送的时间，13位的时间戳 |
| setting | 图文直播相关设置信息 |
| id | 设置的序列号 |
| nickname | 操作人的昵称 |
| actor | 操作人的头衔 |
| avatar | 操作人的头像 |
php请求示例
<?php
//引用config.php
include 'config.php';
$params = array(
'appId' => $appId,
'timestamp' => $timestamp,
'channelId' => 206204,
'imageMode' => 'N',
'id' => 5
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "https://api.polyv.net/live/v3/channel/watch/tuwen/list?".http_build_query($params);
$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 0);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
Loading...
