创建互动培训。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdkapi.xylink.com/api/rest/edu/external/training/course/{version}?extId={extId}
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
automaticRecord | String | Body | 是 | 无 | 是否自动录制:0/1 |
classPassword | String | Body | 否 | 无 | 上课密码 |
cloudClassroomName | String | Body | 是 | 无 | 云课堂名 |
cloudClassroomSource | String | Body | 是 | 无 | 云会议室来源(exist-已存在,system-系统分配) |
cloudClassroomNo | String | Body | 否 | 无 | 云会议室号(云会议室来源为exist则必传) |
controlPassword | String | Body | 否 | 无 | 管控密码(云会议室来源为system则必传) |
courseName | String | Body | 是 | 无 | 课程名称 |
trainingType | String | Body | 是 | 无 | 培训类型:cycle_day:周期培训-每天 cycle_week:周期培训-每周 single:单次培训 |
courseTime | Map | Body | 是 | 无 | 开课时间,与trainingType关联:trainingType:courseTime cycle_day:[{from: "07:00:00", to: "09:05:00"}] cycle_week:[{week: "1", from: "02:00:00", to: "03:10:00"}] single:[{from: "07:00:00", to: "09:05:00"}] |
startDate | String | Body | 是 | 无 | 开始日期(eg:2020-09-05) |
endDate | String | Body | 是 | 无 | 结束日期(eg:2020-09-06) |
syncCourse | boolean | Body | 是 | 无 | 是否同步课程中心:true/false |
syncLive | boolean | Body | 是 | 无 | 是否同步直播:true/false |
notificationType | Map | Body | 是 | 无 | 通知类型:{ "app":true,//app通知 "email":false,//邮件通知 "sms":false//短信通知 } |
remindType | Map | Body | 是 | 无 | 提醒类型:{ "app":true, "email":false, "sms":false } |
remindTime | String | Body | 存在提醒类型为true时必须 | 无 | 提前提醒分钟数 |
listenerKeyList | 数组 | Body | 否 | 无 | 听课人员列表(手机号、邮箱、终端号)eg: [ "15202848699", "287201", "15202848698@163.com", ] |
teacherKeyList | 数组 | Body | 否 | 无 | 讲师列表(同听课人员) |
请求消息体示例(Json)
{
"automaticRecord":0,
"classPassword":"",
"cloudClassroomName":"测试",
"cloudClassroomSource":"exist",
"cloudClassroomNo":"9005643",
"controlPassword":"123456",
"courseName":"语文课",
"trainingType":"cycle_day",
"courseTime":[{"from": "07:00:00", "to": "09:05:00"}],
"startDate":"2020-09-05",
"endDate":"2020-09-06",
"syncCourse":true,
"syncLive":false
"notificationType":{"app":true,"email":false,"sms":false},
"remindType":{"app":true,"email":false,"sms":false},
"remindTime":true,
"listenerKeyList":["15202848699","287201","15202848698@163.com"],
"teacherKeyList":"15202848699","287201","15202848698@163.com"]
}
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
"514400106640838656" //互动培训id
返回参数说明
参数名称 | 说明 |
互动培训id |