渠道推广列表
更新时间:2026-07-13 11:57:31
接口描述
1、查询渠道推广列表
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/popularization/list
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道号 |
示例
http://api.polyv.net/live/v4/channel/popularization/list?appId=frlr1zazn3&sign=39744576F6CECA12533CD8C73EF166D2&channelId=2272655×tamp=1639730848124
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败 |
| status | String | 响应结果,由业务决定,成功返回success,失败返回error |
| success | Boolean | 响应结果,由业务决定,成功返回true,失败返回false |
| data | Object | 成功响应时返回分发列表信息【详见data字段说明】 |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
| requestId | String | 请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码,用于确定具体的错误原因 |
| desc | String | 错误描述,与 error.code 对应 |
data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| pageNumber | Integer | 当前页数,第几页 |
| pageSize | Integer | 分页大小 |
| totalPages | Integer | 总页数 |
| totalItems | Integer | 总记录数 |
| contents | Array | 分页数据集合: ChannelPopularizationViewerVO |
ChannelPopularizationViewerVO参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| promoteId | String | 渠道ID |
| popularizationName | String | 渠道名称 |
| visitsNum | long | 总访问次数 |
| reservationNum | int | 预约人数 |
| watchNum | int | 观看次数 |
| viewerNum | int | 观看人数 |
| averageWatchTime | String | 人均观看时长 |
| enrollNum | int | 报名观看人数 |
| createdTime | int | 创建时间 (13位毫秒时间戳) |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 查询渠道推广列表
* @throws IOException
*/
@Test
public void list() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/popularization/list";
String channelId = "2272655";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("测试查询分发地址及开关状态,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"data": {
"contents": [
{
"averageWatchTime": "00:00:00",
"createdTime": 1616384611000,
"enrollNum": 0,
"popularizationName": "甘肃分公司",
"promoteId": "Fq5gpU",
"reservationNum": 10,
"viewerNum": 10,
"visitsNum": 20,
"watchNum": 40
},
{
"averageWatchTime": "00:00:00",
"createdTime": 1616384156000,
"enrollNum": 0,
"popularizationName": "新疆分公司",
"promoteId": "rqibqI",
"reservationNum": 10,
"viewerNum": 10,
"visitsNum": 50,
"watchNum": 30
}
],
"pageNumber": 1,
"pageSize": 10,
"totalItems": 30,
"totalPages": 3
},
"requestId": "3eda6c34-018c-4744-af02-93c85151f0ee",
"status": "success",
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "366c4df40d814803a6ee3b04ceec437e.680953.16397317894687813",
"error": {
"code": 30004,
"desc": "找不到频道"
},
"success": false
}
