修改频道关注公众号设置信息

接口描述

1、更新关注公众号设置接口
2、支持多个频道查询
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/promotion/update-channels-follow

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、qrCodeUrl图片的content-type仅支持"image/jpeg"或"image/png"，其他类型会抛出“img url error：request file content-type”异常

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
channelIds	true	String	频道号，多个频道用“,”分隔
qrCodeUrl	true	String	图片链接地址
enabled	false	String	关注公众号功能开关，为空不进行修改 Y：开启 N：关闭
autoShowEnabled	false	String	主动弹窗开关，为空不进行修改 Y：开启 N：关闭
entranceText	false	String	入口文案，最大8个字符、为空是不进行修改
tips	false	String	弹窗提示文案，最大30个字符、为空是不进行修改

示例

http://api.polyv.net/live/v3/channel/promotion/update-channels-follow

表单参数：

appId=fso8gzbxlr&timestamp=1628069484000&channelIds=2452644,2446799&enabled=N&entranceText=welcome&tips=tips&autoShowEnabled=N&qrCodeUrl=http://image.biaobaiju.com/uploads/20181223/20/1545567880-shRzoBCgMS.jpeg&sign=9FC1777C16282BF180AF6CCF12E5437B

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	响应成功时返回null，失败时返回空字符串

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/update-channels-follow";
    String channelIds="2452644,2446799";
    String enabled = "Y";
    String autoShowEnabled = "Y";
    String entranceText = "welcome";
    String tips = "tips";
    String qrCodeUrl = "http://image.biaobaiju.com/uploads/20181223/20/1545567880-shRzoBCgMS.jpeg";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelIds", channelIds);
    requestMap.put("qrCodeUrl", qrCodeUrl);
    requestMap.put("enabled", enabled);
    requestMap.put("autoShowEnabled", autoShowEnabled);
    requestMap.put("entranceText", entranceText);
    requestMap.put("tips", tips);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("修改关注公众号设置，返回值：{}", response);
    //do somethings

}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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