获取频道关注公众号设置信息
更新时间:2025-10-23 13:50:02
接口描述
1、查询关注公众号设置接口
2、支持多个频道查询
3、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/promotion/list-channels-follow
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelIds | true | String | 频道号,多个频道用“,”分隔 |
示例
http://api.polyv.net/live/v3/channel/promotion/list-channels-follow?appId=fso8gzbxlr×tamp=1628061073000&channelIds=2452644,2446799&sign=90A6E0ECEDE5DB34FD859101136A6318
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 响应成功时返回结果集【详见data字段说明】 |
Data参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| list | Array | 关注公众号设置列表【详见Detail参数描述】 |
Detail参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| channelId | String | 频道号 |
| enabled | String | 关注公众号功能开关,开启Y、关闭N |
| autoShowEnabled | String | 主动弹窗开关,开启Y、关闭N |
| qrCodeUrl | String | 二维码图片链接地址 |
| entranceText | String | 入口文案 |
| tips | String | 弹窗提示文案 |
| pcFollowTips | String | PC-弹窗文案 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 修改回调设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testUpdateSetting() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url="https://api.polyv.net/live/v3/channel/promotion/list-channels-follow";
String channelIds="2452644,2446799";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelIds", channelIds);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("查询关注公众号设置,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": {
"list": [
{
"channelId": 2446799,
"enabled": "N",
"autoShowEnabled": "N",
"qrCodeUrl": "//liveimages.videocc.net/uploaded/images/2021/08/g13osnscym.jpeg",
"entranceText": "welcome",
"tips": "tips"
},
{
"channelId": 2452644,
"enabled": "N",
"autoShowEnabled": "N",
"qrCodeUrl": "//liveimages.videocc.net/uploaded/images/2021/08/g13osnscym.jpeg",
"entranceText": "welcome",
"tips": "tips"
}
]
}
}
异常示例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
