修改课节状态为禁止上课

接口描述

1、禁止课节上课，禁止有效期为24小时，24小时后会恢复课节允许上课（如果课节已到达下课时间，则不允许再上课）
2、接口URL中的{lessonId}为课节号
3、接口支持https协议

接口URL

http://api.polyv.net/hi-class-api/open/lesson/v1/{lessonId}/cutoff

请求方式

POST

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值【详见签名生成规则】
userId	true	String	POLYV用户ID，和保利威官网一致，获取路径：官网->登录->直播（开发设置）

示例

http://api.polyv.net/hi-class-api/open/lesson/v1/11687/cutoff

表单参数：

appId=fyirmfdak4&timestamp=1636339754708&sign=F79C16196B1E8DE8DF474B4E1034875B&userId=17e1c4f329

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
error	Error	错误对象【详见全局错误说明】
data	Object	请求失败时为空，请求成功时为修改状态相应结果 【详见data字段描述】

data字段描述

参数名	类型	说明
status	boolean	操作状态。true：成功；false：失败

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
 * 禁止直播频道推流
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCutoff() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/lesson/v1/%s/cutoff";
    String lessonId = "11687";
    
    url = String.format(url, lessonId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("userId", userId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("修改课节状态为禁止上课，返回值：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
  "code": 200,
  "status": "success",
  "data": {
    "status": true
  },
  "success": true
}

异常示例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 1012,
    "desc": "输入的userId有误"
  },
  "data": null,
  "success": false
}