Query Seminar Participation Conditions

Updated: 2024-01-02 16:07:47

Interface Description

1、查询研讨会参会条件
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v3/channel/seminar/setting/auth/get

Request Method

GET

Interface Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
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 never be used directly on the client side. 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	String	Channel ID

Example

https://api.polyv.net/live/v3/channel/seminar/setting/auth/get?appId=frlr1zazn3&sign=8661982EB3646269F9824A6ACCACE25C&timestamp=1621843737789

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, assists in describing error reasons when code is 400 or 500
data	Array	Data content on success, empty string on error See data field description

data Field Description

Parameter	Type	Description
channelId	String	Channel ID
userId	String	User ID
rank	Integer	Used to implement two participation conditions for one channel, value is 1 or 2 (1 for primary condition, 2 for secondary condition)
enabled	String	Whether participation conditions are enabled: N: disabled, Y: enabled
authType	String	Participation condition type password: Password login direct: Independent authorization phone: Whitelist
roleCode	String	Role host: Host attendee: Attendee
password	String	Password for password login
directKey	String	Independent authorization key

Java Request Example

For quick integration of basic code, 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(SeminarAuthTest.class);
/**
 * 查询研讨会参会条件
 * @throws IOException
 */
@Test
public void testGetSeminarAuth() 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/v3/channel/seminar/setting/auth/get";

    //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 system error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [{
    "roleId": 12796,
    "userId": "1b448be323",
    "channelId": 2191532,
    "rank": 1,
    "enabled": "Y",
    "authType": "password",
    "roleName": "主持人",
    "roleCode": "host",
    "password": "464nk4",
    "directKey": null,
    "createdTime": 1626830659000,
    "lastModified": 1626830659000
  }, {
    "roleId": 12797,
    "userId": "1b448be323",
    "channelId": 2191532,
    "rank": 1,
    "enabled": "Y",
    "authType": "password",
    "roleName": "参会人",
    "roleCode": "attendee",
    "password": "w8u81f",
    "directKey": null,
    "createdTime": 1626830659000,
    "lastModified": 1626830659000
  }, {
    "roleId": 15832,
    "userId": "1b448be323",
    "channelId": 2191532,
    "rank": 2,
    "enabled": "Y",
    "authType": "direct",
    "roleName": "主持人",
    "roleCode": "host",
    "password": "464nk4",
    "directKey": "b3z0fy1y3z",
    "createdTime": 1628053046000,
    "lastModified": 1628053046000
  }, {
    "roleId": 15833,
    "userId": "1b448be323",
    "channelId": 2191532,
    "rank": 2,
    "enabled": "Y",
    "authType": "direct",
    "roleName": "参会人",
    "roleCode": "attendee",
    "password": "w8u81f",
    "directKey": "lv2n30e15i",
    "createdTime": 1628053046000,
    "lastModified": 1628053046000
  }]
}

Error Example

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