取得講師資訊

更新時間：2023-04-25 15:34:55

介面說明

1、获取讲师信息
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/account/getTeacher

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器轉發呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號

範例

http://api.polyv.net/live/v3/channel/account/getTeacher?appId=frlr1zazn3&sign=B9B8F9128AF8EE0E2E25B492C06E5A72&channelId=2205489&timestamp=1680599633136

回應參數說明

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

Data參數說明

參數名	類型	說明
account	String	講師id，同頻道號
actor	String	講師頭銜
avatar	String	講師頭像，例：//liveimages.videocc.net/uploaded/images/2023/04/gjps9etdpx.jpg
channelId	String	頻道號
nickname	String	講師暱稱
passwd	String	講師登入密碼
loginCode	String	該欄位為null
role	String	該欄位為null

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatRoleTest.class);
/**
 * 查询讲师身份信息
 * @throws IOException
 */
@Test
public void testUpdateTeacherInfo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/account/getTeacher";
    String channelId = "2205489";
    
    //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("测试查询讲师身份信息接口返回值：{}",response);
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "account": "2205489",
        "actor": "讲师1",
        "avatar": "//s1.videocc.net/default-img/avatar/teacher.png",
        "channelId": 2205489,
        "nickname": "葡萄籽",
        "passwd": "Kz37O6",
        "loginCode": null,
        "role": null
    }
}

異常範例

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