Query Custom Session ID for Channel Session

Updated: 2026-07-13 11:28:48

API Description

1、查询频道场次对应自定义场次ID
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/session/external-by-session

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
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 for signature generation is critical for communication data security. It must never 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 and retrieve response data.` See Signature Generation Rules
channelId	true	String	Channel ID
sessionId	true	String	Session ID

Example

http://api.polyv.net/live/v4/channel/session/external-by-session?appId=frlr1zazn3&sign=CCE23B86EEEC5AB1E06407DD59F2E1CC&sessionId=g45nuyktxx&channelId=2633655&timestamp=1639552091949

Response Parameters

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns "success" on success, "error" on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not for business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	Custom session response object See data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
channelId	Integer	Channel ID
sessionId	String	Session ID
externalSessionId	String	Custom session ID

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询频道场次对应自定义场次ID
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getExternalSession() 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/v4/channel/session/external-by-session";
    String channelId = "2633655";
    String sessionId = "g45nuyktxx";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道场次对应自定义场次ID：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "0d9fea4e-d5ac-4b0a-88b5-28d2676b597e",
    "data": {
        "channelId": 2633655,
        "sessionId": "g45nuyktxx",
        "externalSessionId": "9Ws24m413u88lC1058uJ3cMwnI87Jv9V"
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "36ea7ef1-7478-4c31-b32f-daa91b93f421",
    "error": {
        "code": 30038,
        "desc": "未找到自定义场次ID"
    },
    "data": null,
    "success": false
}

Live Streaming Server API