删除单个分组记录

接口描述

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

接口URL

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

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，

请求参数描述

参数名

必选

类型

说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

channelId

true

Integer

频道号

请求体参数描述

参数名

必选

类型

说明

viewerId

true

String

需要删除的分组记录的参会人id，长度不超过64位

示例

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

请求体参数

{
  "viewerId": "viewerId123"
}

响应参数描述

参数名

类型

说明

code

Integer

状态码，与 http 状态码相同，用于确定基本的响应状态

status

String

响应结果，由业务决定，成功返回success，失败返回error

success

Boolean

是否成功响应

requestId

String

请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

error

Object

data

String

成功时为true，错误时为空

Error参数描述

参数名

类型

说明

code

Integer

错误代码，用于确定具体的错误原因

desc

String

错误描述，与 error.code 对应

Java请求示例

private static final Logger log = LoggerFactory.getLogger(GroupPlanDelete.class);
/**
 * 删除单个分组记录
 * @throws IOException
 */
@Test
public void testGroupPlanDelete() 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/delete";
    String channelId = "2191532";
    String body = "{\n" +
        "  \"viewerId\": \"viewerId123\"\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
}

Previous清空分组记录 Next查询分组记录

Last updated 5 months ago

Was this helpful?

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

private static final Logger log = LoggerFactory.getLogger(GroupPlanDelete.class); /** * 删除单个分组记录 * @throws IOException */ @Test public void testGroupPlanDelete() 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/delete"; String channelId = "2191532"; String body = "{\n" + " \"viewerId\": \"viewerId123\"\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 }