Group Account: Obtain External Authorization Secret Key Using Channel ID

Interface Description

1、集团账号通过频道号查询频道外部授权观看的secretKey
2、仅支持查询当前集团账号及其分账号下的频道
3、频道需要已开启外部授权观看
4、接口支持https协议

Interface URL

http://api.polyv.net/live/v4/group/channel/external-auth-key/get

Online API Call

Request Method

GET

Interface Constraints

1. The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

2. For group account interfaces, use the appId and appSecret of the primary group account when calculating the signature.

3. appSecret is only used for signature generation and does not need to be transmitted as a request parameter.

4. Interface results have approximately 60 seconds of server-side caching. After modifying the channel's external authorization viewing configuration, it is recommended to wait for the cache to refresh before querying again.

Request Parameter Description

Example

http://api.polyv.net/live/v4/group/channel/external-auth-key/get?appId=g8dtv537aq&timestamp=1710000000000&channelId=123456&sign=YOUR_UPPERCASE_MD5_SIGN

Response Parameter Description

Error Parameter Description

Data Parameter Description

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded 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(ChannelOperateTest.class);

/**
 * 通过频道号获取外部授权频道secretKey
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupChannelExternalAuthKeyTest() throws IOException, NoSuchAlgorithmException {
    //公共参数，填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/group/channel/external-auth-key/get";
    String channelId = "123456";

    //http调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试通过频道号获取外部授权频道secretKey成功：{}", response);
    //do somethings
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "data": {
        "channelId": 123456,
        "secretKey": "**********"
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "data": null,
    "error": {
        "code": 1097,
        "desc": "非法的频道ID"
    },
    "success": false
}

Error Code Description

Notes

1. This interface only returns the secretKey from the external authorization viewing configuration. When the channel does not have external authorization viewing enabled, no other viewing restriction configurations are returned.

2. Channels not belonging to the current group account or its sub-accounts will uniformly return "Invalid channel ID" without revealing channel ownership information.

3. The secretKey is sensitive information. It is recommended to use and store it only on the server side, and not output it to frontend pages, client code, or public logs.