查询播放器列表(旧版)
更新时间:2025-02-20 19:09:11
接口描述
目前已有新版本的播口,建议使用新版本接口:查询播放器列表
1、通过用户id,查询播放器列表
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
接口URL
http://api.polyv.net/v2/play/{userid}/player-list
在线API调用 ``
请求方式
GET
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
示例
http://api.polyv.net/v2/play/1b448be323/player-list?sign=1E3CFEEC4EA888571A84156E5BF57EBB35ECAA72&ptime=1617845463779
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Array | 响应成功时返回播放器列表信息【详见data字段说明】,响应失败时返回空 |
data字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| playerName | String | 播放器名称 |
| playerId | String | 播放器id,例如"1b448be323" |
| date | String | 创建日期,例如"2020-09-28 14:17:08" |
| isDefault | Integer | 是否是默认播放器 1:是 0:否 |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodVideoPlayerTest.class);
/**
* 查询播放器列表
*/
@Test
public void testGetPlayerList() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v2/play/" + userId + "/player-list";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userid", userId);
requestMap.put("ptime", ptime);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.get(url, requestMap);
log.debug("测试查询播放器列表,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "success",
"data": [
{
"playerName": "默认播放器-红色",
"playerId": "MDL7ARoayp",
"date": "2021-04-02 11:53:44",
"isDefault": 1
},
{
"playerName": "创建的播放器",
"playerId": "d4b8dDzXsT",
"date": "2021-03-30 11:38:33",
"isDefault": 0
},
{
"playerName": "默认播放器",
"playerId": "1b448be323",
"date": "2020-09-28 14:17:08",
"isDefault": 0
}
]
}
异常示例
{
"code": 400,
"status": "error",
"message": "sign can not be empty.",
"data": ""
}
