预约系列课程

功能说明

预约系列课程，一个系列课程对应多节课程

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/v1/edu/adapter/education/course/{创建者id}?extId=分配的企业id

请求参数说明

参数名称	参数类型	参数位置	必须	默认值	说明
version	String	Path	是	无	v1
extId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
courseName	String	Body	是	无	课程名称
schoolTypeId	long	Body	是	无	学段id
gradeId	long	Body	是	无	年级id
subjectId	long	Body	是	无	学科id
startDate	date	Body	是	无	开始日期(eg：2020-09-05)
endDate	date	Body	是	无	结束日期(eg：2020-09-06)
courseHour	String	Body	是	无	开课时间：startHour：开始时间，endHour：结束时间，week：标识为周几 eg:[{startHour: "00:00", endHour: "02:00", week: "2"}]
teacherId	long	Body	是	无	主讲教师id
speakerClass	Object	Body	是	无	主讲班级：type：1-主讲班级，2-主讲终端eg:{"type": 1,"id": "557598"//班级id}或{"type": 2,"id": "100634613",/终端id"departmentId": "170917"//终端所属班级id，如所属多个班级取第一个即可}
listenerTeachers	数组	Body	否	无	听课教师id集合 eg：["101087210"]
listenerClasses	数组	Body	否	无	听课班级集合（参考speakerClass）eg：[{"type": 1,"id": "557598"},{"type": 2,"id": "100634613","departmentId": "170917"}]
description	String	Body	否	无	课程介绍
automaticCall	String	Body	是	无	是否自动呼叫终端：true-是，false-否
automaticRecord	int	Body	是	无	自动录制设置：0-不自动录制， 1-课程开始自动录制， 2-预约时间开始自动录制， 3-预约结束时间结束录制
syncLive	boolean	Body	是	无	是否同步直播
publishLiveOnline	int	Body	是	无	是否发布到在线课程：0-关闭 1-同步 2-同步并发布
publishResource	int	Body	是	无	是否发布到优课资源：0-关闭 1-同步 2-同步并发布
cloudClassroomNo	String	Body	是	无	云课堂号

示例代码

请求消息体示例（Json）

{
    "courseName": "123",
    "schoolTypeId": "679338148420911105",
    "gradeId": "679338148441882630",
    "subjectId": "679338148462854169",
    "startDate": "2022-10-29",
    "endDate": "2022-10-29",
    "courseHour": [
        {
            "startHour": "00:05",
            "endHour": "02:10",
            "week": "6"
        }
    ],
    "teacherId": "102490978",
    "speakerClass": {
        "type": 1,
        "id": "1291134"
    },
    "description": "测试课程",
    "automaticCall": false,
    "automaticRecord": 0,
    "syncLive": false,
    "publishLiveOnline": 0,
    "publishResource": 0,
    "cloudClassroomNo": "9082507202"
}

返回结果示例：

成功时返回结果200 ok，失败时返回小鱼RESTAPI错误码

{
    "courseName": "123",
    "lessonAmount": 1,
    "id": "770613985807437824",
    "firstLesson": {
        "courseItemId": "770613987027980288",
        "liveId": "96288fe68418ad8901842c0d50930017",
        "liveReviewUrl": "https://prelive.xylink.com/live/v/968098d1841896a101841e43a5480182"
    }
}

参数名称	说明
id	课程id
courseName	课程名称
lessonAmount	讲次数量
firstLesson	课程下首节讲次信息
courseItemId	讲次id
liveId	直播id
liveReviewUrl	直播观看地址

2022-11-09 17:13:14

导出PDF文档