保利威文档中心

幫助中心

批次新增分組記錄

更新時間:2022-10-12 15:25:43

介面描述

1、批量新增分组记录
2、分组记录数量上限是1万条
3、单次只允许增加同一频道的记录
4、校验参会人id是否重复时,不区分大小写
5、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
6、接口支持https协议

介面URL

https://api.polyv.net/live/v4/seminar/group/plan/save-batch

請求方式

POST

介面限制

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

請求參數描述

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

請求體參數描述

參數名 必選 類型 說明
list true Array 批次插入記錄 【詳見list欄位說明

list欄位說明

參數名 必選 類型 說明
viewerId true String 與會者id,長度不超過64位(不可重複)
nickname true String 與會者暱稱,長度不超過64位(僅作為辨認依據,不改變使用者與會名稱)
groupNo true Integer 分組序號,1~50之間
groupRole true String 組內身份,一個分組內不能多於一個組長
leader:組長
member:組員

範例

https://api.polyv.net/live/v4/seminar/group/plan/save-batch?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=3220878

請求體參數

{
  "list" : [{
    "viewerId": "viewerId1",
    "nickname": "viewerId1_nick",
    "groupNo": 1,
    "groupRole": "leader"
  }, {

    "viewerId": "viewerId2",
    "nickname": "viewerId2_nick",
    "groupNo": 1,
    "groupRole": "member"
  }, {

    "viewerId": "viewerId3",
    "nickname": "viewerId3_nick",
    "groupNo": 2,
    "groupRole": "member"
  }]
}

回應參數描述

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

參數名 必選 類型 說明
infoIncorrectViewerIdList Array 不合法的與會者id。(暱稱為空/暱稱長度大於64位/分組序號為空/分組序號不在1~50之間/組內身份為空/組內身份傳參有誤)
duplicateViewerIdList Array 重複的與會者id
duplicateLeaderGroupNoList Array 重複組長的分組序號

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(GroupPlanSaveBatch.class);
/**
 * 批量新增分组记录
 * @throws IOException
 */
@Test
public void testGroupPlanSaveBatch() 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/save-batch";
    String channelId = "2191532";
    String body = "{\n" +
        "  \"list\" : [{\n" +
        "    \"viewerId\": \"viewerId1\",\n" +
        "    \"nickname\": \"viewerId1_nick\",\n" +
        "    \"groupNo\": 1,\n" +
        "    \"groupRole\": \"leader\"\n" +
        "  }, {\n" +
        "\n" +
        "    \"viewerId\": \"viewerId2\",\n" +
        "    \"nickname\": \"viewerId2_nick\",\n" +
        "    \"groupNo\": 1,\n" +
        "    \"groupRole\": \"member\"\n" +
        "  }, {\n" +
        "\n" +
        "    \"viewerId\": \"viewerId3\",\n" +
        "    \"nickname\": \"viewerId3_nick\",\n" +
        "    \"groupNo\": 2,\n" +
        "    \"groupRole\": \"member\"\n" +
        "  }]\n" +
        "}";

    //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));
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试批量新增分组记录接口返回值:{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": 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": "f02d8d1c81b94bf3b761efb9b9bc1fd2.58.16577892258410007",
  "error": {
    "code": 50011,
    "desc": "批量插入分组记录失败,信息有误"
  },
  "data": {
    "infoIncorrectViewerIdList": [],
    "duplicateViewerIdList": ["viewerid2", "viewerid3"],
    "duplicateLeaderGroupNoList": [],
    "correct": false
  },
  "success": false
}
{
  "code": 400,
  "status": "error",
  "requestId": "f02d8d1c81b94bf3b761efb9b9bc1fd2.58.16577892258410007",
  "error": {
    "code": 50010,
    "desc": "数量超过限制,最多10000条数据"
  },
  "data": {
    "infoIncorrectViewerIdList": [],
    "duplicateViewerIdList": [],
    "duplicateLeaderGroupNoList": [],
    "correct": false
  },
  "success": false
}
联系客服,在线咨询