Associate Custom ID with Live Session
Updated: 2022-12-15 10:04:04
API Description
1、将直播场次关联自定义的直播场次UUID，关联频道之后开播的场次、以及这些开播场次衍生出来的裁剪和合并视频
3、接口支持https协议
API URL
http://api.polyv.net/live/v3/channel/session/relevance
Request Method
POST
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See details on obtaining keys |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid within 3 minutes |
| sign | true | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See signature generation rules |
| channelId | true | String | Channel ID |
| externalSessionId | true | String | Custom live session UUID, 32 characters in length |
Example
http://api.polyv.net/live/v3/channel/session/relevance?appId=frlr1zazn3&sign=863A72E3380FCB75F9C3C21677692B8D&externalSessionId=w11V61QWoK3332313778613940858739&channelId=2633655×tamp=1636687112547
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Response status code. 200 indicates success, non-200 indicates failure. See global error description |
| status | String | Response status text |
| message | String | Response description. When code is 400 or 500, provides additional error details |
| data | Object | Empty on failure, true on success |
Java Request Example
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
}
Response Example
For system-wide global error descriptions, see Global Error Description
Success Example
{
"code": 200,
"status": "success",
"message": "",
"data": true
}
Error Example
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
