授權和連線 Token

更新時間：2022-09-02 18:08:07

介面描述

1、获取授权和连麦的token
2、接口支持https协议

介面 URL

http://api.polyv.net/live/v3/channel/common/get-chat-token

線上 API 呼叫

請求方式

POST

介面限制

1、介面同時支援 HTTP 與 HTTPS，建議使用 HTTPS 以確保介面安全。介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	當前 13 位毫秒級時間戳，3 分鐘內有效
sign	true	String	簽名，為 32 位大寫的 MD5 值，`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己的伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
userId	true	String	觀看者使用者 ID
role	true	String	角色 teacher：講師 admin：管理員 guest：嘉賓 assistant：助教 viewer：觀看者
origin	false	String	觀看來源，可自訂 web：網頁端 client：客戶端 app：手機應用端

範例

http://api.polyv.net/live/v3/channel/common/get-chat-token

表單參數：

role=viewer&appId=frlr1zazn3&origin=web&sign=F9DCE80BFC6DE3293D5EE432C1B8CD55&userId=1b448be323&channelId=2094979&timestamp=1621844705410

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200 為成功回傳，非 200 為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當 code 為 400 或 500 時，輔助描述錯誤原因
data	Object	請求失敗時為空，請求成功時為頻道的資訊【詳見data 欄位說明】

data 欄位說明

參數名	類型	說明
token	String	連結介面所需的 token 值，有效期 6 小時
mediaChannelKey	String	連線所需的 key
roomId	String	房間號
childRoomEnabled	String	是否開啟子房間 Y：開啟 N：關閉
chatApiDomain	String	聊天室 API 位址
chatDomain	String	聊天室 Socket 位址

Java 請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播 Java SDK 完成 API 的功能對接，直播 Java SDK 對 API 呼叫邏輯、異常處理、資料簽名、HTTP 請求執行緒池進行了統一封裝和最佳化。

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<String, String> 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
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "chatApiDomain":"apichat.polyv.net",
        "childRoomEnabled":"N",
        "mediaChannelKey":"e235543623u0jd193b575afed369cce5e52hj1oe8000413e9020c21adf91ab136dfd1b7aeeeddfa6c883e9437b81085c5b28c7707caa44fe41826c5bae97baa242a5a8bb7b4d4d706d29f667a7a812fe94fca054210c603cb1f727e02307c1f2a9d5d7bfafc077de33ff9a232761ef004c496dfa536c5e2fb0fb033a04066188bd148aaf1e9d2efe20c2f1ab31464b6d0afb54393fcfb269a065eb5625c289a2e752030ec4631d842021540b3b0466b0c0a19b590ab087aadb19bf621c657b7f003123572e5590fb43175ef120969b2ac125ae2db7d3a6f0c1fa87ec05c7cbb0f20016ed3a3354a6ce50c73c9fecbfe17a98a0bada2f1e6970515cd373a8e12aaa0bd7fc29bfebeb771939156c90c89fbd2da3647ecf050a738e306f4f2a13e9564ba24cbbd26e720d8dab76aa3ee901c10a1754e3dc9ac5173dc75898ea79e9fc851de045dc27f7bde1c58c7591cd186e72dd3d15052ff85925e6fe680599fc8e602b",
        "chatDomain":"chat.polyv.net",
        "roomId":"2094979",
        "token":"7f6d83hojaw2f2bb3b46f875946a75"
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}