Update a Single Group Record

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

API Description

1、更新单个分组记录
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

API URL

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

Request Method

POST

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
channelId	true	Integer	Channel ID

Request Body Parameter Description

Parameter	Required	Type	Description
oldViewerId	true	String	Original participant ID of the group record to update, max length 64 characters
viewerId	false	String	New participant ID, max length 64 characters
nickname	false	String	New participant nickname, max length 64 characters (for identification only, does not change the user's display name in the session)
groupNo	false	Integer	New group number, between 1 and 50
groupRole	false	String	New role within the group leader: Group leader member: Group member

Example

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

Request Body Parameters

{
  "oldViewerId" : "oldViewerId",
  "viewerId" : "newViewerId",
  "nickname" : "nickname",
  "groupNo" : 1,
  "groupRole" :"member"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. 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 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	String	Returns true on success, empty on error

Error Parameter Description

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

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, both contained in the download file.

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

private static final Logger log = LoggerFactory.getLogger(GroupPlanUpdate.class);
/**
 * 删除单个分组记录
 * @throws IOException
 */
@Test
public void testGroupPlanUpdate() 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/update";
    String channelId = "2191532";
    String body = "{\n" +
        "  \"oldViewerId\" : \"oldViewerId\",\n" +
        "  \"viewerId\" : \"newViewerId\",\n" +
        "  \"nickname\" : \"nickname\",\n" +
        "  \"groupNo\" : 1,\n" +
        "  \"groupRole\" :\"member\"\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

}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": 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": "0249c3cfda4b426ba567dcc18ef07531.63.16577880487180263",
  "error": {
    "code": 50012,
    "desc": "更新分组记录失败，原记录不存在"
  },
  "data": null,
  "success": false
}

{
  "code": 400,
  "status": "error",
  "requestId": "0249c3cfda4b426ba567dcc18ef07531.66.16577882689270277",
  "error": {
    "code": 50013,
    "desc": "更新分组记录失败，组内已有组长"
  },
  "data": null,
  "success": false
}