接口URL
http://api.polyv.net/live/v3/channel/weixin-share/get
接口说明
(接口调用有频率限制,详细请查看)
1、获取频道的微信分享设置信息
2、接口支持https协议
具体功能请查看 微信分享设置
返回结果支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
channelId | 是 | int | 频道号 |
appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
sign | 是 | string | 签名,为32位大写的MD5值 |
timestamp | 是 | string | 当前13位毫秒级时间戳,3分钟内有效 |
响应成功JSON示例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"channelId": 108888,
"channelName": "多码率测试频道号",
"coverImg": "//livestatic.videocc.net/uploaded/images/2017/12/ewe26lgx61.png",
"weixinShareTitle": "微信分享的标题",
"weixinShareDesc": "微信分享的描述",
"weixinShareCustomUrl": "https://polyv.net",
"webShareCustomUrl":"https://polyv.net"
}
}
响应异常JSON示例:
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
字段说明
参数名 | 说明 |
---|---|
code | 请求状态响应码 |
status | 请求状态 |
message | 错误信息 |
channelId | 频道号 |
channelName | 频道名称 |
coverImg | 微信分享图标,即频道的直播图标 |
weixinShareTitle | 微信分享的标题 |
weixinShareDesc | 微信分享的描述 |
weixinShareCustomUrl | 微信分享客户自定义url |
webShareCustomUrl | 网页分享客户自定义url |
php请求示例
<?php
//引用config.php
include 'config.php';
//接口需要的参数(非sign)赋值
$timestamp = 1528708015437;
$appId = "test";
$channelId = 108888;
$params = array(
'channelId'=>$channelId,
'appId'=>$appId,
'timestamp'=>$timestamp,
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
//接口请求url
$url = "http://api.polyv.net/live/v3/channel/weixin-share/get?channelId=$channelId&appId=$appId×tamp=$timestamp&sign=$sign";
//输出接口请求结果
echo file_get_contents($url);
?>