集团账号使用频道号获取外部授权秘钥

更新时间：2026-08-13 17:32:38

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP、HTTPS，建议使用HTTPS确保接口安全，接口调用有频率限制，详细请查看

2、集团账号接口计算签名请使用集团主账号的appId、appSecret

3、appSecret仅用于生成签名，不需要作为请求参数传输

4、接口结果存在约60秒服务端缓存，修改频道外部授权观看配置后，建议等待缓存刷新后再次查询

请求参数描述

参数名	必选	类型	说明
appId	true	String	集团主账号appId【详见集团账号2.0获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值，`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见签名生成规则】
channelId	true	Integer	频道号，必须大于0

示例

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

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	频道外部授权观看密钥信息【详见Data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Data参数描述

参数名	类型	说明
channelId	Integer	频道号
secretKey	String	频道外部授权观看的secretKey

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码，下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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

错误码说明

错误码	错误描述	说明
10001	channelId不能为空	未传channelId
10001	channelId必须大于0	channelId小于或等于0
10002	签名错误	sign校验失败
30004	找不到频道	频道不存在，或频道不属于当前集团账号及其分账号
1169	频道未开启外部授权观看	频道未开启外部授权观看，或未配置可用的外部授权secretKey
20000	appId is required.	未传appId

注意事项

1、该接口只返回外部授权观看配置中的secretKey；频道未开启外部授权观看时，不返回其他观看限制配置

2、非当前集团账号及其分账号下的频道统一返回“非法的频道ID”，不会返回频道归属信息

3、secretKey属于敏感信息，建议仅在服务端使用和存储，不要输出到前端页面、客户端代码或公开日志

直播服务端 API