修改频道微信分享信息(新版)
旧版接口地址修改频道微信分享信息(旧版)
接口描述
1、修改频道微信分享信息,对应新版后台的 营销-分享设置
2、接口支持https协议
接口URL
http://api.polyv.net/live/v4/channel/share/update
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、weixinShareCustomUrl、webShareCustomUrl需要进行URL编码
请求参数描述
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
channelId
true
String
频道号
shareBtnEnable
true
String
是否开启分享,Y:开启,N:关闭
titleType
true
String
标题类型follow直播标题、custom自定义
weixinShareTitle
false
String
分享标题,最大长度50,标题类型为custom时,该字段必填
weixinShareDesc
false
String
分享简介,最大长度120,标题类型为custom时,该字段必填
weixinShareCustomUrl
false
String
微信自定义分享地址,最大长度512,链接必须带协议,如:https://,链接需要进行encode
webShareCustomUrl
false
String
网页观看自定义分享地址,最大长度512,链接必须带协议,如:https://,链接需要进行encode
示例
http://api.polyv.net/live/v4/channel/share/update?shareBtnEnable=Y&titleType=custom&weixinShareDesc=%E4%BF%9D%E5%88%A9%E5%A8%81%E6%B5%8B%E8%AF%95%E5%BE%AE%E4%BF%A1%E5%88%86%E4%BA%AB%E6%8F%8F%E8%BF%B0&appId=frlr1zazn3&weixinShareTitle=%E4%BF%9D%E5%88%A9%E5%A8%81%E6%B5%8B%E8%AF%95%E5%BE%AE%E4%BF%A1%E5%88%86%E4%BA%AB%E6%A0%87%E9%A2%98&sign=F1EB80BAA9D52621CC9D90175BF75B0F&weixinShareCustomUrl=httPs%3A%2F%2Fpolyv.com&channelId=2567762×tamp=1632818720193
响应参数描述
code
Integer
响应状态码,200为成功返回,非200为失败
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
响应结果,由业务决定,成功返回true,失败返回false
data
Object
成功响应时返回null
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
Error参数描述
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(ChannelShareTest.class);
@Test
public void testUpdateChannelShare() throws IOException, NoSuchAlgorithmException {
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v4/channel/share/update";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", "2567762");
requestMap.put("shareBtnEnable", "Y");
requestMap.put("titleType", "custom");
requestMap.put("weixinShareTitle", "保利威测试微信分享标题");
requestMap.put("weixinShareDesc", "保利威测试微信分享描述");
requestMap.put("weixinShareCustomUrl", "httPs://polyv.com");
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url,requestMap);
log.info("测试设置频道分享设置,返回值:{}", response);
}
响应示例
成功示例
{
"code": 200,
"status": "success",
"requestId": "0be255f3-51e6-482d-bc27-82cab8b11607",
"data": null,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"requestId": "560d3c9c4d2d4736948906cf3769feea.67.16360831361283559",
"error": {
"code": 10001,
"desc": "分享开关不能为空"
},
"data": null,
"success": false
}
Last updated
Was this helpful?