Query Group Records

Updated: 2022-09-02 18:08:07

API Description

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

API URL

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

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
channelId	true	Integer	Channel ID
pageNumber	false	Integer	Current page number, value between 1 and 1000; defaults to 1 if not provided
pageSize	false	Integer	Number of items per page, value between 1 and 1000; defaults to 10 if not provided

Example

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

Response Parameters Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, should not be tied to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	Failure reason, returned on failure. Empty on success See data Field Description

Error Parameters Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

data Field Description

Parameter	Type	Description
pageSize	Integer	Number of items per page, default 10, maximum 1000
pageNumber	Integer	Current page number
totalItems	Integer	Total number of items
contents	Array	Query result list See Contents Parameters Description
totalPages	Integer	Total number of pages

Contents Parameters Description

Parameter	Type	Description
channelId	Integer	Channel ID
userId	String	Account ID
viewerId	String	Participant ID
nickname	String	Participant nickname (only used for identification, does not change the participant's display name in the session)
groupNo	Integer	Group sequence number
groupName	String	Group name
groupRole	String	Role within the group leader: Group leader member: Group member

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
  "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
}

Error Example

{
  "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
}