更新课节信息

接口描述

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

接口URL

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

请求方式

POST

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

timestamp

true

Long

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

sign

true

String

请求体参数描述

参数名
必选
类型
说明

lessonId

true

Long

课节号

name

false

String

课节名称，长度1~128

startTime

false

Long

开始时间，格式为: 13位时间戳

duration

false

Integer

上课时长，单位: 分钟，5~180

linkNumber

false

Integer

连麦人数，0~16

autoConnectMicroEnabled

false

String

是否自动连麦 Y：自动连麦 N：手动上麦

autoRecordCourseEnabled

false

String

是否自动录制课程 Y：自动录制 N：手动录制

watchCondition

false

String

观看条件 NULL：无条件 CODE：验证码 WHITE_LIST：白名单 DIRECT：独立授权

code

false

String

当观看条件为CODE时需要填写观看验证码（限制16位以内）

secretKey

false

String

观看条件为独立授权时传，不传则后台自动生成（限制32位以内）

resolution

false

Integer

录制清晰度, 720, 1080

playResolution

false

Integer

上课清晰度, 360（如果需要设置更高的清晰度，请联系相关工作人员）

cover

false

String

封面地址URL，长度1~255

teacherId

false

String

老师id，如不传，则不更新，如果传入的是新的id，则根据下列老师信息创新一个新的老师

teacherName

false

String

老师名称，如传入的信息可以查找到现有老师，会更新老师名称

teacherCode

false

String

老师登录手机区号，默认 +86

teacherMobile

false

String

老师手机号，长度5~15

teacherPasswd

false

String

老师密码，长度6~8

示例

http://api.polyv.net/hi-class-api/open/lesson/v1/update?appId=frlr1zazn3&sign=FBEFF2002BBF2A78DD1639A06F590A7C&timestamp=1634629627718

请求体参数

{
    "code": "5678",
    "linkNumber": "1",
    "teacherName": "六老师",
    "lessonId": "8970",
    "playResolution": "360",
    "teacherCode": "+86",
    "resolution": "720",
    "duration": "60",
    "cover": "https://liveimages.videocc.net/uploaded/images/2021/08/g1xcu49u12.jpg",
    "watchCondition": "CODE",
    "teacherId": "g3fdl05syf",
    "name": "测试修改课节",
    "teacherMobile": "15555555555",
    "startTime": "1634630909795",
    "autoConnectMicroEnabled": "N",
    "teacherPasswd": "123456"
}

响应参数描述

参数名
类型
说明

code

Integer

status

String

响应状态文本信息

error

Error

data

Object

data字段描述

参数名
类型
说明

status

Boolean

ture:成功; false:失败

Java请求示例

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

private static final Logger log = LoggerFactory.getLogger(VClassLessonTest.class);
/**
 * 更新课节信息
 * @throws IOException
 */
@Test
public void updateLesson() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/lesson/v1/update";
    String lessonId = "8970";
    String name = "测试修改课节";
    String startTime = "1634630909795";
    String duration = "60";
    String linkNumber = "1";
    String autoConnectMicroEnabled = "N";
    String watchCondition = "CODE";
    String code = "5678";
    String resolution = "720";
    String playResolution = "360";
    String cover = "https://liveimages.videocc.net/uploaded/images/2021/08/g1xcu49u12.jpg";
    String teacherId = "g3fdl05syf";
    String teacherName = "六老师";
    String teacherCode = "+86";
    String teacherMobile = "15555555555";
    String teacherPasswd = "123456";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("lessonId", lessonId);
    jsonMap.put("name", name);
    jsonMap.put("startTime", startTime);
    jsonMap.put("duration", duration);
    jsonMap.put("linkNumber", linkNumber);
    jsonMap.put("autoConnectMicroEnabled", autoConnectMicroEnabled);
    jsonMap.put("watchCondition", watchCondition);
    jsonMap.put("code", code);
    jsonMap.put("resolution", resolution);
    jsonMap.put("playResolution", playResolution);
    jsonMap.put("cover", cover);
    jsonMap.put("teacherId", teacherId);
    jsonMap.put("teacherName", teacherName);
    jsonMap.put("teacherCode", teacherCode);
    jsonMap.put("teacherMobile", teacherMobile);
    jsonMap.put("teacherPasswd", teacherPasswd);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("测试修改课节成功：{}", response);
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "5bc5c3a4a88a487192cb0256b1dadb7f.97.16346296311239761",
    "data": {
        "status": true
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "data": "",
    "error": {
      "code": xx,
      "desc": "错误描述"
    }
}
Previous恢复课节状态为可以上课NextStatistics

Last updated

Was this helpful?