# 授权和连麦token ### 接口描述 ``` 1、获取授权和连麦的token 2、接口支持https协议 ``` ### 接口URL ``` http://api.polyv.net/live/v3/channel/common/get-chat-token ``` [在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/common/get-chat-token/README.md) ### 请求方式 ``` POST ``` ### 接口约束 1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md) ### 请求参数描述 | 参数名 | 必选 | 类型 | 说明 | | --------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appId | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】 | | timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 | | sign | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 | | channelId | true | String | 频道号 | | userId | true | String | 观看者用户Id | | role | true | String |

角色
teacher：讲师
admin：管理员
guest：嘉宾
assistant：助教
viewer：观看者

| | origin | false | String |

观看来源，可以自定义
web：网页端
client：客户端
app：手机应用端

| ### 示例 ```requestUrl http://api.polyv.net/live/v3/channel/common/get-chat-token ``` 表单参数： ```requestUrl role=viewer&appId=frlr1zazn3&origin=web&sign=F9DCE80BFC6DE3293D5EE432C1B8CD55&userId=1b448be323&channelId=2094979×tamp=1621844705410 ``` ### 响应参数描述 | 参数名 | 类型 | 说明 | | ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | code | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】 | | status | String | 响应状态文本信息 | | message | String | 响应描述信息，当code为400或者500的时候，辅助描述错误原因 | | data | Object | 请求失败时为空，请求成功时为频道的信息 【详见[data字段描述](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/channel/operate/get_chat_token.md?id=data%E5%AD%97%E6%AE%B5%E6%8F%8F%E8%BF%B0)】 | #### data字段描述 | 参数名 | 类型 | 说明 | | ---------------- | ------ | ------------------------------ | | token | String | 链接接口需要的token值，有效期6小时 | | mediaChannelKey | String | 连麦需要的key | | roomId | String | 房间号 | | childRoomEnabled | String |

是否开启子房间
Y：开启
N：关闭

| | chatApiDomain | String | 聊天室api地址 | | chatDomain | String | 聊天室socket地址 | ### Java请求示例 快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。 > 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。 ```java private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class); /** * 查询授权和连麦的token * @throws IOException * @throws NoSuchAlgorithmException */ @Test public void testGetChatToken() 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/common/get-chat-token"; String channelId = "2094979"; String role = "viewer"; String origin = "web"; Map requestMap = new HashMap<>(); requestMap.put("appId", appId); requestMap.put("timestamp", timestamp); requestMap.put("channelId", channelId); requestMap.put("userId", userId); requestMap.put("role", role); requestMap.put("origin", origin); requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret)); String response = HttpUtil.postFormBody(url, requestMap); log.info("测试查询授权和连麦的token，返回值：{}", response); //do somethings } ``` ### 响应示例 系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md) 成功示例 ```json { "code":200, "status":"success", "message":"", "data":{ "chatApiDomain":"apichat.polyv.net", "childRoomEnabled":"N", "mediaChannelKey":"e235543623u0jd193b575afed369cce5e52hj1oe8000413e9020c21adf91ab136dfd1b7aeeeddfa6c883e9437b81085c5b28c7707caa44fe41826c5bae97baa242a5a8bb7b4d4d706d29f667a7a812fe94fca054210c603cb1f727e02307c1f2a9d5d7bfafc077de33ff9a232761ef004c496dfa536c5e2fb0fb033a04066188bd148aaf1e9d2efe20c2f1ab31464b6d0afb54393fcfb269a065eb5625c289a2e752030ec4631d842021540b3b0466b0c0a19b590ab087aadb19bf621c657b7f003123572e5590fb43175ef120969b2ac125ae2db7d3a6f0c1fa87ec05c7cbb0f20016ed3a3354a6ce50c73c9fecbfe17a98a0bada2f1e6970515cd373a8e12aaa0bd7fc29bfebeb771939156c90c89fbd2da3647ecf050a738e306f4f2a13e9564ba24cbbd26e720d8dab76aa3ee901c10a1754e3dc9ac5173dc75898ea79e9fc851de045dc27f7bde1c58c7591cd186e72dd3d15052ff85925e6fe680599fc8e602b", "chatDomain":"chat.polyv.net", "roomId":"2094979", "token":"7f6d83hojaw2f2bb3b46f875946a75" } } ``` 异常示例 ```json { "code": 400, "status": "error", "message": "invalid signature.", "data": "" } ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://polyv.gitbook.io/document/docs/live/api/channel/operate/get_chat_token.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.