直播场次关联自定义ID
更新时间:2022-12-15 10:04:04
接口描述
1、将直播场次关联自定义的直播场次UUID,关联频道之后开播的场次、以及这些开播场次衍生出来的裁剪和合并视频
3、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/session/relevance
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| channelId | true | String | 频道ID |
| externalSessionId | true | String | 自定义直播场次UUID,32位长度 |
示例
http://api.polyv.net/live/v3/channel/session/relevance?appId=frlr1zazn3&sign=863A72E3380FCB75F9C3C21677692B8D&externalSessionId=w11V61QWoK3332313778613940858739&channelId=2633655×tamp=1636687112547
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | Object | 请求失败时为空,请求成功时为true |
Java请求示例
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 直播场次关联自定义ID
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testRelevanceSessions() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/session/relevance";
String channelId = "2633655";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("externalSessionId", super.getRandomString(32));
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url,requestMap);
String response = HttpUtil.postFormBody(url, null);
log.info("直播场次关联自定义ID,返回值:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "",
"data": true
}
异常示例
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
