查询分组记录

接口描述

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
}