文章目录
接口URL
http://api.polyv.net/live/v3/channel/auth/get
接口说明
(接口调用有频率限制,详细请查看)
1、接口用于获取频道观看条件
2、接口支持https
返回结果支持格式
JSON
请求方式
GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | string | 从API设置中获取,在直播系统登记的appId |
timestamp | 是 | string | 当前13位毫秒级时间戳,3分钟内有效 |
sign | 是 | string | 签名,32位大写MD5值 |
channelId | 否 | int | 频道ID |
响应成功JSON示例:
带频道ID的查询(频道生效观看条件)
#主要观看条件是无观看条件,次要观看条件是白名单观看条件
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"channelId": 102666,
"rank": 1, //主要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "none"
},
{
"channelId": 102666,
"rank": 2, //次要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "phone",
"authTips": "观看提示哦,大家请注意"
}
]
}
#主要观看条件是验证码观看条件,次要观看条件是付费观看
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"channelId": 102666,
"rank": 1, //主要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "code",
"authCode": "2194",
"qcodeTips": "请填写验证码",
"qcodeImg": "http://www.polyv.net/code.png"
},
{
"channelId": 102666,
"rank": 2, //次要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "pay",
"payAuthTips": "付费可看啦",
"price": 0.10,
"watchEndTime": null,
"validTimePeriod": 100
}
]
}
#主要观看条件是登记观看,次要观看条件是自定义授权观看
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"channelId": 102666,
"rank": 1, //主要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "info"
},
{
"channelId": 102666,
"rank": 2, //次要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "custom",
"customKey": "18c9a2e2a1",
"customUri": "http://www.polyv.net/custom.htm"
}
]
}
#主要观看条件是外部授权观看,次要观看条件是分享观看
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"channelId": 102666,
"rank": 1, //主要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "external",
"externalKey": "9828d6d5c7",
"externalUri": "http://www.polyv.net/externalUri.htm",
"externalRedirectUri": "http://www.polyv.net/externalRedirectUri.htm"
},
{
"channelId": 102666,
"rank": 2, //次要观看条件
"userId": "edvf2fpec9",
"globalSettingEnabled": "N",
"enabled": "N",
"authType": "wxshare"
}
]
}
不带频道ID的查询(全局观看条件)
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"userId": "ee7fe7fbda",
"rank": 1,
"enabled": "N",
"authType": "phone",
"authTips": "欢迎观看本次直播",
"payAuthTips": "欢迎观看本次直播",
"codeAuthTips": "欢迎观看本次直播",
"infoAuthTips": "欢迎观看本次直播",
"authCode": null,
"qcodeTips": null,
"qcodeImg": null,
"price": 0.00,
"watchEndTime": null,
"validTimePeriod": null,
"customKey": "92daed0df9",
"customUri": null,
"externalKey": "432fdf9889",
"externalUri": null,
"externalRedirectUri": null,
"directKey": "e87d4de349",
"trialWatchEnabled": "N",
"trialWatchTime": null,
"trialWatchEndTime": null,
"whiteListInputTips": "",
"infoDesc": "",
"whiteListEntryText": "会员入口"
},
{
"userId": "ee7fe7fbda",
"rank": 2,
"enabled": "N",
"authType": "none",
"authTips": "欢迎观看本次直播",
"payAuthTips": "欢迎观看本次直播",
"codeAuthTips": "欢迎观看本次直播",
"infoAuthTips": "欢迎观看本次直播",
"authCode": null,
"qcodeTips": null,
"qcodeImg": null,
"price": 0.00,
"watchEndTime": null,
"validTimePeriod": null,
"customKey": "0c97e07670",
"customUri": null,
"externalKey": "33004355bd",
"externalUri": null,
"externalRedirectUri": null,
"directKey": "a4951d801f",
"trialWatchEnabled": "N",
"trialWatchTime": null,
"trialWatchEndTime": null,
"whiteListInputTips": null,
"infoDesc": null,
"whiteListEntryText": ""
}
]
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
字段说明
参数名 | 说明 |
---|---|
code | 请求结果代码,成功为200 错误为400,签名错误为403,接口错误为500 |
status | 请求结果,成功时为"success"错误时为"error" |
message | 错误信息,请求成功时为空串,错误时错误信息 |
data | 请求成功为数据内容,错误为空串 |
channelId | 频道ID |
userId | 用户ID |
rank | 用于实现一个频道设置两个观看条件,为1或2(1为主要条件,2为次要条件) |
globalSettingEnabled | 是否开启全局设置(Y/N) |
enabled | 是否开启观看条件(Y/N) |
authType | 观看条件类型(1. 无限制 none 2. 验证码观看 code 3. 付费观看 pay 4. 白名单观看 phone 5. 登记观看 info 6. 分享观看 wxshare 7. 自定义授权观看 custom 8. 外部授权观看 external) |
authTips | 白名单观看提示信息 |
payAuthTips | 付费观看提示信息 |
authCode | 验证码观看的验证码 |
qcodeTips | 验证码观看的二维码提示 |
qcodeImg | 验证码观看的二维码图片 |
price | 付费观看的价格 |
watchEndTime | 付费观看,截止时间,为null表示:一次付费,永久有效 |
validTimePeriod | 付费观看的截止时长 (天) |
customKey | 自定义授权观看的key |
customUri | 自定义授权观看的接口地址 |
externalKey | 外部授权观看的key |
externalUri | 外部授权观看的接口地址 |
externalRedirectUri | 外部授权观看,用户直接访问观看页时的跳转地址 |
codeAuthTips | 验证码观看条件提示信息 |
infoAuthTips | 登记观看条件提示信息 |
directKey | 直接授权key |
trialWatchEnabled | 付费观看的试看开关(Y/N),默认为N |
trialWatchTime | 试看时间,单位为分钟 |
trialWatchEndTime | 试看截止日期,为null 表示对该频道永久有效 |
whiteListInputTips | 白名单输入提示 |
whiteListEntryText | 白名单入口文案 |
infoDesc | 登记观看描述字段 |
php请求示例
<?php
//引用config.php
include 'config.php';
$channelId="183950";
$params = array(
'appId' => $appId,
'channelId' => $channelId,
'timestamp' => $timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$url = "http://api.polyv.net/live/v3/channel/auth/get?appId=".$appId."&channelId=".$channelId."×tamp=".$timestamp."&sign=".$sign;
echo file_get_contents($url);
?>