服务端API



获取课程分类列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/category/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid"  : "分类唯一ID1",
                "title" : "分类标题1",
                "parent_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1501",
                "create_time": 1546565453000,
            },
          	{
                "uuid"  : "分类唯一ID2",
                "title" : "分类标题2",
                "parent_id": "2C09EBF2-A8D9-4BDF-8D60-FADE743E1502",
                "create_time": 1546565453000,
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 分类唯一ID,最大长度36字符
title String 分类标题,最大长度64字符
parent_id String 分类父ID,最大长度36字符
create_time String 创建时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/course/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
start_time Int 是 课程创建时间的查询起始时间,Unix时间戳,单位毫秒
end_time Int 是 课程创建时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超365天
category_id String 否 课程分类id
is_in Int 否 0 采购课
1 自建课
status Int 否 课程状态:
0 未发布
1 已发布
2 已关闭
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid"  : "课程唯一ID",
                "title" : "课程标题",
                "category_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1508",
                "certificate_id": "100619E7-5004-464D-A80A-D9D2DFA4F271",
                "lector_id": "D1C71591-DCAA-4751-B2C3-B1CC31E95A8E",
                "study_type": 1,
                "status": 1,
                "credit": 5.00,
                "point": 10.00,
                "lesson_num": 5,
                "total_length": 5,
                "description": 5,
                "pc_url": "https://saas.eduto.com/pcHome/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
                "mobile_url": "https://saas.eduto.com/mobile/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
                "create_time": 1546565453000,
                "update_time": 1609957197000,
                "is_charge": 0,
                "price": "0.00",
                "origin_price": "0.00",
            },
          	{
                "uuid"  : "课程唯一ID",
                "title" : "课程标题",
                "category_id": "1C09EBF2-A8D9-4BDF-8D60-FADE743E1509",
                "certificate_id": "200619E7-5004-464D-A80A-D9D2DFA4F272",
                "lector_id": "D1C71591-DCAA-4751-B2C3-B1CC31E95A8E",
                "study_type": 1,
                "status": 1,
                "credit": 5,
                "point": 10.00,
                "lesson_num": 5,
                "total_length": 5,
                "description": 5,
                "pc_url": "https://saas.eduto.com/pcHome/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
                "mobile_url": "https://saas.eduto.com/mobile/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
                "create_time": 1546565453000,
                "update_time": 1609957197000,
                "is_charge": 1,
                "price": "0.10",
                "origin_price": "1.00",
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 课程唯一ID,最大长度36字符
title String 课程标题,最大长度255字符
category_id String 课程分类ID,最大长度36字符
certificate_id String 关联证书ID,最大长度36字符
lector_id String 关联讲师ID,最大长度36字符
study_type Int 学习模式:
1 自由式
2 解锁式
credit Decimal(12,2) 学分数量
point Decimal(12,2) 积分数量
status Int 课程发布状态:
-1 删除
0 未发布
1 已发布
2 关闭
lesson_num Int 课件数量,最大位数11
total_length Int 学时长度,单位秒
description String 课程描述,最大长度65535字符
pc_url String pc端跳转链接
mobile_url String 移动端跳转链接
is_charge Int 是否开启收费 0 否 1是
price Decimal(12,2) 商品价格
origin_price Decimal(12,2) 划线价格
create_time Int 创建时间,Unix时间戳,单位毫秒
update_time Int 更新时间,Unix时间戳,单位毫秒,如果status为-1或者2,此为最后操作时间
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程详情

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/course/course/info​
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
course_id String 是 课程uuid

返回结果:

{
    "code": 0,
    "status": "ok",
    "message": "get info success",
    "data": {
        "uuid": "F6685184-15A0-469C-89A2-3C2C8EF2CAA4",
        "title": "党建课程六建议分类",
        "category_id": "",
        "certificate_id": "",
        "study_type": 1,
        "credit": 0.00,
        "point": 0.00,
        "status": 1,
        "lesson_num": 1,
        "total_length": 10,
        "description": "",
        "type": "normal",
        "lesson_type": "normal",
        "company_id": "dingc4cffb655c00d67f35c2f4657eb6378f",
        "pc_url": "https://saas.eduto.com/pcHome/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
        "mobile_url": "https://saas.eduto.com/mobile/dist/ssoLogin?appid=1D13B009-0482-4B80-B3C3-08CCE0C29E85&corpid=dingc4cffb655c00d67f35c2f4657eb6378f&gotoUrl=courseDetail&uuid=198654DE-19C1-4ACC-B47D-40D859381CAC",
        "create_time": 1609957197000,
        "update_time": 1609957197000
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
uuid String 课程唯一ID,最大长度36字符
title String 课程标题,最大长度255字符
category_id String 课程分类ID,最大长度36字符
certificate_id String 关联证书ID,最大长度36字符
study_type Int 学习模式:
1 自由式
2 解锁式
credit Decimal(12,2) 学分数量
point Decimal(12,2) 积分数量
status Int 课程发布状态:
-1 删除
0 未发布
1 已发布
2 关闭
lesson_num Int 课件数量,最大位数11
total_length Int 学时长度,单位秒
description String 课程描述,最大长度65535字符
pc_url String pc端跳转链接
mobile_url String 移动端跳转链接
create_time Int 创建时间,Unix时间戳,单位毫秒
update_time Int 更新时间,Unix时间戳,单位毫秒,如果status为-1或者2,此为最后操作时间



获取课程课件列表

请求方式:GET(HTTPS)
请求地址:https://oapi.soke.cn/course/lesson/list
Query参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
course_id String 是 课程ID,最大长度36字符
start_time Int 是 课程创建时间的查询起始时间,Unix时间戳,单位毫秒
end_time Int 是 课程创建时间的查询结束时间,Unix时间戳,单位毫秒
注意:起始与结束时间差不超365天
page Int 否 页码,默认从1开始
page_size Int 否 每页条数,最大100,默认100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid"  : "课程唯一ID",
                "title" : "课程标题",
                "type"  : 'document',
				"test_id": '0CAAA346-727D-4030-BAE6-4169D0E1664D',
                "status": 1,
                "credit": 0.00,
                "point" : 5.00,
                "course_id": "41121033-3F87-48E3-B1B7-EBEF3339B8C2",
                "create_time": 1546565453000,
                "length": 120,
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 课程唯一ID,最大长度36字符
title String 课程标题,最大长度255
type String 课件类型  video视频 audio音频 document文档等
video
test
document
audio
article
home_work
link
image
pptx
docx
jpg
pdf
text
doc
ppt
xls
xlsx
txt
test_id String 小测验id,最大长度36字符
status Int 课件发布状态:
-1 删除
0 未发布
1 已发布
2 关闭
credit Decimal(12,2) 学分数量
point Decimal(12,2) 积分数量
course_id String 所属课程ID,最大长度36字符
create_time Int 创建时间,Unix时间戳,单位毫秒
length Int 课件长度,单位秒,最大位数11
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程学员学习列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/user/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
course_id String 是 课程ID
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个
finish_start_time Int 否 学员完成学习时间的查询起始时间,Unix时间戳,单位毫秒
注意:开始时间与当前时间差不能大于365天
finish_end_time Int 否 学员完成学习时间的查询结束时间,Unix时间戳,单位毫秒
注意:开始时间与结束时间差不能小于7天
page Int 否 页码,默认1
page_size Int 否 每页条数,默认100,最大100

Query参数提示: userid_list参数与finish_start_time、finish_end_time时间参数二选一,不能同时不传。

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_user_id"  : "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
                "lesson_num": 5,
                "lesson_finish_num": 5,
                "progress": 30,
                "learn_status": "learning",
                "expire_time": "1609957197000",
                "finish_time": 0,
                "is_delay": 0,
                "point": 0,
                "credit": 0,
                "status": 1,
                "learn_type": "required",
                "enroll_type": "user_assign",
                "create_time": 1546565453000,
                "update_time": 1609957197000,
                "start_time": 1546565453000,
            },
          	{
                "dept_user_id"  : "21121033-3F87-48E3-B1B7-EBEF3339B8C2",
                "lesson_num": 5,
                "lesson_finish_num": 5,
                "progress": 30,
                "learn_status": "learning",
                "expire_time": "1609957197000",
                "finish_time": 0,
                "is_delay": 0,
                "point": 0,
                "credit": 0,
                "status": 1,
                "learn_type": "required",
                "enroll_type": "user_assign",
                "create_time": 1546565453000,
                "update_time": 1609957197000,
                "start_time": 0,
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最大长度64字符
lesson_num Int 课件总数,最大位数10
lesson_finish_num Int 课件完成数量,最大位数10
progress Int 学习总进度,百分比数字1-100
learn_status String 学习状态:
learning 学习中
finished 已完成
expire_time Int 过期时间,Unix时间戳,单位毫秒
finish_time Int 完成时间,Unix时间戳,单位毫秒,未完成为0
is_delay Int 是否延期完成学习:
0 按时完成
1 延期完成
status Int 指派用户状态:
1 指派中
-1 已移除指派
point Float 获得积分
credit Flost 获得学分
learn_type String 学习类型:
required 必修
optional 选修
enroll_type String 报名类型:
all_assign
dept_assign
position_assign
self_assign
tags_assign
user_assign
create_time Int 创建时间,Unix时间戳,单位毫秒
start_time Int 开始学习时间,Unix时间戳,单位毫秒,未开始为0
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程人脸列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/face/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
target_id String 是 来源ID
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个
page Int 否 页码,默认1
page_size Int 否 每页条数,默认100,最大100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid": "31",
				"target_id": "28F845AA-C93E-41F3-BFEB-E0C1257E04F1",
				"reason": "",
				"face_img": "https://ocdn.soke.cn/dingc4cffb655c00d67f35cxxxxxx/course/courseFace/28F845AA-C93E-41F3-BFEB-E0C1257E04F1/1597738267/xxxxx.jpg",
				"sys_face_img": "https://ocdn.soke.cn/dingc4cffb655c00d67f35c2f4657xxxxx/face/30693828561xxxxx.jpg",
				"qualified": "1",
				"dept_user_id": "30693828561194041",
				"create_time": 1597738275000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 唯一uuid
reason String 失败原因
face_img String 课程中上传图片
sys_face_img String 系统中录入的图片
qualified Int 照片是否合格:1=>合格,-1=>不合格
dept_user_id String 用户ID,最大长度64字符
create_time Int 创建时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程课件人脸列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/lessonFace/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
target_id String 是 来源ID,课程课件中的uuid
userid_list String 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个
page Int 否 页码,默认1
page_size Int 否 每页条数,默认100,最大100

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "uuid": "959E3F08-FD0E-487D-8B7F-78C5C1C07B16",
                "target_id": "C0B7654E-E6B7-4288-BC29-41AA3F883585",
                "reason": "",
                "face_img": "https://ocdn.soke.cn/dingc4cffb655c00d67f35cxxxxxx/course/courseFace/28F845AA-C93E-41F3-BFEB-E0C1257E04F1/1597738267/xxxxx.jpg",
                "sys_face_img": "https://ocdn.soke.cn/dingc4cffb655c00d67f35c2f4657xxxxx/face/30693828561xxxxx.jpg",
                "qualified": "1",
                "dept_user_id": "30693828561194041",
                "create_time": 1597738275000
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
uuid String 唯一uuid
reason String 失败原因
face_img String 课程课件中上传图片
sys_face_img String 系统中录入的图片
qualified Int 照片是否合格:1=>合格,-1=>不合格
dept_user_id String 用户ID,最大长度64字符
create_time Int 创建时间,Unix时间戳,单位毫秒
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程课件学习列表

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/lessonLearn/list
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
course_id String 是 课程uuid
lesson_id String 否 课件uuid
userid_list string 否 员工在企业内的UserID列表,多个UserId用英文逗号隔开,一次最多100个
finish_start_time Int 否 学员完成课件学习时间的查询起始时间,Unix时间戳,单位毫秒
注意:开始时间与当前时间差不能大于365天
finish_end_time Int 否 学员完成学习时间的查询结束时间,Unix时间戳,单位毫秒
注意:开始时间与结束时间差不能小于7天
page Int 否 页码,默认1
page_size Int 否 每页条数,默认100,最大100

Query参数提示: userid_list参数与finish_start_time、finish_end_time时间参数二选一,不能同时不传。

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "list": [
            {
                "dept_user_id": "130628610924890078",
        				"lesson_id": "B945FDCF-0CE3-467B-91D3-69FC7B635BA5",
        				"course_id": "8B54D9A0-CC21-4D6B-94A5-762A4F0CD927",
        				"learn_status": "learning",
        				"length": 185,
        				"progress": 1
            }
        ],
        "has_more": 1
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
list Array 返回的用户列表
dept_user_id String 用户ID,最大长度64字符
lesson_id String 课件id,最大长度36字符
course_id String 课程id,最大长度36字符
learn_status String 学习状态
learning 学习中
finished 已完成
length Int 课件总时长,最大位数10
progress Int 课程学习进度,百分比数字1-100
has_more Int 是否还有数据没返回:
1 还有
0 没有



获取课程学员学习详情

  • 请求方式:GET(HTTPS)
  • 请求地址:https://oapi.soke.cn/course/user/info
  • Query参数说明:
参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
course_id String 是 课程ID
dept_user_id String 是 员工在企业内的UserID

返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        "target_id" : "F52FAEAB-5C9F-4A4B-A183-6E04835063A8",
        "target_title" : "课程名称",
        "category_id" : "95DD4D72-E504-4550-81A2-F48EFEEB8FC2",
        "category_title" : "通用课程",
        "dept_user_id"  : "11121033-3F87-48E3-B1B7-EBEF3339B8C1",
        "lesson_num": 5,
        "lesson_finish_num": 5,
        "progress": 30,
        "learn_status": "learning",
        "expire_time": "1609957197000",
        "start_time": 0,
        "finish_time": 0,
        "is_delay": 0,
        "status": 1,
        "learn_type": "required",
        "enroll_type": "user_assign",
        "point": 12.25,
        "credit": 8.10,
        "create_time": 1546565453000,
        "update_time": 1609957197000,
    }
}

参数说明:

参数 类型 说明
data Array 返回的数据包
target_id String 课程ID,最大长度36字符
target_title String 课程名称,最大长度255
category_id String 分类ID,最大长度36字符
category_title String 分类标题,最大长度255
dept_user_id String 用户ID,最大长度64字符
lesson_num Int 课件总数,最大位数10
lesson_finish_num Int 课件完成数量,最大位数10
progress Int 学习总进度,百分比数字1-100
learn_status String 学习状态:
- learning 学习中
- finished 已完成
expire_time Int 过期时间,Unix时间戳,单位毫秒
start_time Int 开始时间,Unix时间戳,单位毫秒,未开始为0
finish_time Int 完成时间,Unix时间戳,单位毫秒,未完成为0
is_delay Int 是否延期完成学习:
- 0 按时完成
- 1 延期完成
status Int 指派用户状态:
- 1 指派中
- -1 已移除指派
learn_type String 学习类型:
- required 必修
- optional 选修
enroll_type String 报名类型:
all_assign
dept_assign
position_assign
self_assign
tags_assign
user_assign
point Decimal(12,2) 获得积分
credit Decimal(12,2) 获得学分
create_time Int 创建时间,Unix时间戳,单位毫秒
update_time Int 更新时间,Unix时间戳,单位毫秒



创建课程

请求方式:POST(HTTPS)
请求地址:https://oapi.soke.cn/course/create
参数说明:

参数 类型 必须 说明
access_token String 是 应用access_token,2小时有效期
title String 是 课程标题
dept_user_id String 是 用户dept_user_id(上传人员userid)
category_id String 是 分类id(通过课程库分类列表获取分类id)
media_id String 是 素材库文件uuid

成功返回结果:

{
    "code": "200",
    "status": "ok",
    "message": "success",
    "data": {
        //创建成功的课程uuid
        "uuid":"376053D7-73B6-44FE-8EF2-4A27E5CC81C6" 
    }
}