查詢分組記錄

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

介面描述

1、查询分组记录
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递
3、接口支持https协议

介面URL

https://api.polyv.net/live/v4/seminar/group/plan/get

請求方式

GET

介面限制

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

請求參數描述

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

範例

https://api.polyv.net/live/v4/seminar/group/plan/get?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=2191532

回應參數描述

參數名	類型	說明
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欄位說明

參數名	類型	說明
pageSize	Integer	每頁資料大小，預設10，最大值1000
pageNumber	Integer	目前的頁數
totalItems	Integer	總筆數
contents	Array	查詢的結果列表【詳見Contents參數描述】
totalPages	Integer	總頁數

Contents參數描述

參數名	類型	說明
channelId	Integer	頻道號
userId	String	帳號id
viewerId	String	與會者id
nickname	String	與會者暱稱（僅作為辨認依據，不改變使用者與會名稱）
groupNo	Integer	分組序號
groupName	String	分組名稱
groupRole	String	組內身份 leader：組長 member：組員

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(GroupPlanGet.class);
/**
 * 查询分组记录
 * @throws IOException
 */
@Test
public void testGroupPlanGet() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v4/seminar/group/plan/get";
    String channelId = "2191532";


    //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);
    //do somethings

}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "requestId": "914c6a18ad8440258ac515d93c789d88.59.16581208815250009",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalPages": 1,
    "totalItems": 4,
    "contents": [{
      "channelId": 2191532,
      "userId": "1b448be323",
      "viewerId": "viewerId1",
      "nickname": "viewerId1_nick",
      "groupNo": 1,
      "groupName": "1组",
      "groupRole": "leader"
    }, {
      "channelId": 2191532,
      "userId": "1b448be323",
      "viewerId": "22222",
      "nickname": "8888",
      "groupNo": 1,
      "groupName": "1",
      "groupRole": "member"
    }, {
      "channelId": 2191532,
      "userId": "1b448be323",
      "viewerId": "viewerId2",
      "nickname": "viewerId1_nick",
      "groupNo": 2,
      "groupName": "2组",
      "groupRole": "member"
    }, {
      "channelId": 2191532,
      "userId": "1b448be323",
      "viewerId": "viewerId3",
      "nickname": "viewerId1_nick",
      "groupNo": 2,
      "groupName": "2组",
      "groupRole": "member"
    }]
  },
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}

{
  "code": 403,
  "status": "error",
  "error": {
    "code": 10002,
    "desc": "签名错误"
  },
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "914c6a18ad8440258ac515d93c789d88.64.16581210376260021",
  "error": {
    "code": 10001,
    "desc": "单次查询不能大于1000条"
  },
  "data": null,
  "success": false
}