Query Live Session by Custom Session UUID
Updated: 2022-09-15 09:50:53
API Description
1、查询根据自定义场次UUID查询直播场次
3、接口支持https协议
API URL
http://api.polyv.net/live/v3/channel/session/list-session-by-external
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls are subject to rate limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See Obtaining Keys |
| timestamp | true | Long | Current 13-digit millisecond timestamp, valid for 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. All APIs must be called through your own server to relay requests to the POLYV server for response data. See Signature Generation Rules |
| channelId | true | String | Session ID |
| externalSessionId | true | String | Custom live session UUID. This parameter is set via Associate Custom ID with Live Session |
Example
http://api.polyv.net/live/v3/channel/session/list-session-by-external?appId=fso8gzbxlr×tamp=1636421147000&channelId=2659445&externalSessionId=binytest2021110802&sign=56933052D433EB34E9BA0F9DA5197728
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. Contains role information on success See data field description |
data Field Description
| Parameter | Type | Description |
|---|---|---|
| list | List< String > | Session ID |
Java Request Example
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 查询角色信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testQuerySessionListByExternalSessionId() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "https://api.polyv.net/live/v3/channel/session/list-session-by-external";
String channelId="2149710";
String externalSessionId= "test";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("externalSessionId", externalSessionId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.get(url, requestMap);
log.info("根据自定义场次UUID查询直播场次，返回值：{}", response);
//do somethings
}
Response Example
For system global error descriptions, see Global Error Description
Success Example
{
"code": 200,
"status": "success",
"message": "",
"data": {
"list": [
"g41jb9hxbk",
"g41ked2ck6",
"g41k9buc96",
"g41jwdl09l"
]
}
}
Error Example
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
