百家云 - 开发者中心在线教育网校系统,视频直播朊务,在线培训平台,视频教育软件

Size: px

Start display at page:

Download "百家云 - 开发者中心在线教育网校系统,视频直播朊务,在线培训平台,视频教育软件"

云寇
3 years ago
Views:

1 小班课直播服务端 API 接口概述本文档为百家云小班课直播服务端的 API 文档, 用户可以通过文档中提供的 API 接口创建及管理直播教室, 导出直播数据信息等注 : 百家云 API 仅提供基础数据, 客户须将数据同步到自己数据库 (DB) 后, 通过自己的数据库 (DB) 来实现业务需求基本约定常见基本约定以及平台术语见下表 : 内容约定请求协议 HTTPS 请求类型 GET/ 参数提交方式 application/x-www-form-urlencoded 或 multipart/form-data 返回数据格式 json 字符编码 UTF8 接口域名 ${private_domain} 个性域名 partner_id 账号的 ID, 由百家云平台分配, 用户可以登录百家云网站后台查看 partner_key 账号的密钥, 由百家云平台分配, 用于计算服务端 API 接口的签名, 用户可以登录百家云网站后台获取说明 : 文档中的数字统一用 int 表示, 即无符号的 64 位正整数, 取值范围是 2^0~2^63 ; 使用流程合作方接入百家云开放平台直播有如下几个步骤 : 注册账号注册后可以登录百家云后台获取 partner_id 和 partner_key 创建教室根据百家云提供的 API 接口创建和管理教室进入教室根据百家云提供的地址或接入百家云 SDK 进入教室获取统计数据使用数据统计相关的接口可以导出直播用户的统计数据接口规范公共请求参数 : 参数类型示例参数说明 partner_id int 合作方账号 ID timestamp int unix 时间戳, 当前的秒数,10 位长的数字 ( 注 : 不是毫秒 ) sign string e10adc3949ba59abbe56e057f20f883e 根据 partner_key 和请求参数计算的签名,32 位的小写字母或数字

2 公共返回参数如下 : 参数类型示例参数说明 code int 1001 错误码, 对应的错误原因参见错误码表 msg string 签名错误错误原因描述 data json 返回的数据, 出错时返回的 data 为 null 个性域名百家云给每个账号都分配了一个个性域名, 客户调用服务端 API 接口对接 SDK 的时候, 都需要用到这个个性域名个性域名可以登录百家云后台, 在账号信息页面查看成为付费客户后, 可以申请修改该个性域名 ( 只能个性一次, 修改后不可再更改 ) 以下服务端的接口, 都是调自己个性域名下的接口例如 : 个性域名是 demo123, 则所有的服务端 API 请求的域名为 : 为方便理解, 以下接口中的个性域名, 都用 ${private_domain} 表示, 在使用的时候请将该变量替换成自己的个性域名签名规则签名计算方式直播服务端每个接口除了传递业务参数外, 还有一个用于校验的 sign 参数 sign 的生成规则如下 : 注 : 将请求参数按 key 字典顺序 (ASCII 值大小 ) 升序排序将排好序的参数拼成 key1=value1&key2=value2&...&keyn=valuen 将以上拼好的串后面再拼上 &partner_key=<partner_key>, 其中 <partner_key> 替换成具体值对以上拼好的串算一个 32 位 md5 值 ( 小写 ), 即得到了签名 partner_key 总是拼在字符串最后面, 并不参与 key 的排序 partner_key 只是计算签名时需要, 在发送请求时不需要发 partner_key 例如, 创建教室的接口需要以下参数 : 1. partner_id= title= 测试教室 3. start_time= end_time= type= partner_key=rlkipaqjxswrqmc/itnhh8i2rifmmbfivsyw03ssi24zankrad0znb2rctzi2avy7+amnjddlmz U89zKUAP3Xg== 以上参数排序后的顺序为 : 1. end_time= partner_id= start_time= timestamp= title= 测试教室 6. type=2 按以上顺序拼接的字符串为 : 1. end_time= &partner_id= &start_time= & timestamp= &title= 测试教室 &type=2

3 再拼上 partner_key 后的字符串为 : 1. end_time= &partner_id= &start_time= & timestamp= &title= 测试教室 &type=2&partner_key=rlkipaqjxswrqmc/itnhh8i2rifmmbfivsyw03ssi24zankrad0znb2rctzi2avy7+am NJDdLmzU89zKUAP3Xg== 最后算出来 32 位的小写的 md5 值为 : 1. 5b c679b0c6256da014af1260 示例代码 (php) 1. <?php /** 4. * 生成签名参数 5. * 6. array $params 请求的参数 7. string $partner_key 8. string 生成的签名 9. */ 10. function getsign($params, $partner_key) { 11. ksort($params);// 将参数按 key 进行排序 12. $str = ''; 13. foreach ($params as $k => $val) { 14. $str.= "{$k}={$val}&"; // 拼接成 key1=value1&key2=value2&...&keyn=valuen& 的形式 15. } 16. $str.= "partner_key=". $partner_key; // 结尾再拼上 partner_key=$partner_key 17. $sign = md5($str); // 计算 md5 值 18. return $sign; 19. } $params = [ 22. "partner_id" => , 23. "title" => " 测试教室 ", 24. "start_time" => , 25. "end_time" => , 26. "type" => 2, 27. "timestamp" => , 28. ] $partner_key = 'rlkipaqjxswrqmc/itnhh8i2rifmmbfivsyw03ssi24zankrad0znb2rctzi2avy7+amnjddlmzu89zkuap3 Xg=='; 31. $sign = getsign($params, $partner_key); API 列表 API 1 : 获取 / 重置 partner_key 初始的 partner_key 和 secret_key 都可登录百家云后台获取此接口可用于重置 partner_key

4 1. 参数类型是否必填默认值参数说明 partner_id int 是合作方账号 ID, 在百家云账号后台可以查询 secret_ke y strin g 是合作方用于更新 partner_key 的密钥 ( 由开放平台提供给合作方 ) regenerat e int 否 0 为 1 时表示强制重新生成 partner_key( 默认情况下返回当前已经存在的 partner_key) timestamp int 是当前 unix 时间戳 ( 秒 ) sign strin g 是签名参数类型示例说明 partner_key string partner_key 长度不超过 128 位请求示例 1. curl -d "partner_id= &secret_key=e10adc3949ba59abbe56e057f20f883e" 返回示例 4. "partner_key": "rlkipaqjxswrqmc/itnhh8i2rifmmbfivsyw03ssi24zankrad0znb2rctzi2avy7+amnjddlmzu89zkuap3 Xg==" 5. }, 6. "msg":"" 7. } API 2 : 创建教室创建教室 1.

5 参数类型是否必填默认值描述 partner_id in t 是合作方 id st title ri n 是直播课标题, 不超过 50 个字符或汉字, 超过部分将进行截取 g start_time in t 是开课时间, unix 时间戳 ( 秒 ) end_time in t 是下课时间, unix 时间戳 ( 秒 ) type in t 是 4: 小班课 ;4: 专业一对一 ;6: 基础班一对一 max_users in t 是台上人数 ; 小班课必须传一个正整数值 ( 取值范围 2-12), 其 max_users 最大支持设置 12; 当 type 为专业一对一与基础班一对一时, 必须传 1 值 max_backu p_users in t 否 0 小班课 1vNvM 班型, 台下学生数量限制, 最大支持 300 auto_on_st age in t 否 0 小班课 1vNvM 班型, 台下学生是否自动上台 ; 0: 不是,1: 是 has_foreign _user in t 否是否有海外用户, 如果有海外用户请传此参数 ; 1: 否,2: 是 pre_enter_t ime in t 否学生可提前进入的时间, 单位为秒 background _attachmen t 文件否小班课教室背景图 ( 文件不参与签名的计算 ), 图片文件 whiteboard _attachmen t 文件否小班课教室白板 ( 文件不参与签名的计算 ), 图片文件 template_ty pe in t 否小班课模板类型可传 1,3;1 为第一套模板 ;3 为一对一模板, 需申请开通 end_delay_ time in t 否课程预设的结束时间后可以拖堂的时间, 到时间会强制下课, 单位 ( 秒 ),0 不强制, 大于 0 生效, 最大不可超过 7200 秒 ( 两小时 ) enable_clo ud_record in t 否专业小班课教室是否展示云端录制,1 展示 2 隐藏, 默认取系统配置 auto_playb ack_record in t 否自动开启云端录制,1: 允许,0: 取账号配置, 如果隐藏了云端录制按钮, 则不会自动开启 enable_pull _audio_onl y in t 否是否允许只拉其它学生音频流 0: 拉音视频流,1: 只拉音频, 默认都拉, 只支持小班课只有 1V2~1V12 的班型才能设置为 1, 其余的默认都拉 ; 对应后台设置 : 是否可见全部成员

6 参数类型是否必填默认值描述 timestamp in t 是当前 unix 时间戳 ( 秒 ) st sign ri n 是签名 g 注意 : 非长期教室, 结束时间与开始时间间隔需小于 24 小时, 开始时间和结束时间范围必须在当前时间一年以内在小班课中, 会有两种班型 1vNvM 1vN max_users 指的是 N, 台上人数 ; max_backup_users, 指的是 1vNvM 中的 M, 台下人数参数类型示例描述 room_id string 教室 ID,14 位的数字 admin_code string abdce2 管理员 ( 助教 ) 进入教室的参加码 teacher_code string 13rlkk 老师进入教室的参加码 student_code string abc213 学生公共参加码, 该参加码可以进多个学生, 不互踢注意 : 参加码是一种快速进入教室的形式, 合作方把参加码发给用户, 他们就可以通过参加码和昵称直接进入教室参加码为 6 位, 由字母和数字组成请求示例 1. curl -d "title=test&start_time= &end_time= &type=4&max_users=6&pre_enter_time=30&is_l ong_term=1&partner_id= tamp= &sign=68c1147e61d831e09be784acc438dc36" 返回示例 4. "room_id": " ", 5. "student_code": "kgqjbf", 6. "admin_code": "a7ygsz", 7. "teacher_code": "3uhfu5" 8. }, 9. "msg": "", 10. "ts": } API 3 : 更新教室信息

7 更新教室信息 1. 参数类型是否必填默认值描述 partner_id in t 是合作方 id room_id in t 是教室 ID,14 位 st title ri n 否教室标题 g start_time in t 否开课时间, unix 时间戳 ( 秒 ) end_time in t 否结束时间, unix 时间戳 ( 秒 ) max_users in t 否当为小班课时候必须传一个正整数值 ( 取值范围 1-12), 其 max_users 最大支持设置 12, 作为台上人数 max_backup_ users in t 否 0 小班课 1vNvM 班型, 台下学生数量限制 pre_enter_tim e in t 否学生可提前进入的时间, 单位为秒 background_at tachment 文件否小班课教室背景图 ( 文件不参与签名的计算 ), 图片文件 whiteboard_att achment 文件否小班课教室白板 ( 文件不参与签名的计算 ), 图片文件 template_type in t 否专业小班课模板类型可传 1,2,3;1 为第一套模板 ;2 为第二套模板 ;3 为一对一模板, 需申请开通 auto_playback _record in t 否自动开启云端录制,1: 允许,0: 取账号配置, 如果隐藏了云端录制按钮, 则不会自动开启 enable_pull_a udio_only in t 否是否允许只拉其它学生音频流 0: 拉音视频流,1: 只拉音频, 默认都拉, 只支持小班课只有 1V2~1V12 的班型才能设置为 1, 其余的默认都拉 timestamp in t 是当前时间,unix 时间戳 ( 秒 )

8 参数类型是否必填默认值描述 st sign ri n 是请求接口参数签名 g 返回 code 为 0 时表示更新成功, 返回 code 非 0 表示更新失败, 失败原因在 msg 中返回返回示例成功情况下 : 3. "data": null, 4. "msg": "" 5. } API 4 : 删除教室删除一个教室 1. 接口参数 partner_id int 是合作方 id room_id int 是教室 id 返回 code 为 0 时表示删除成功, 返回 code 非 0 表示删除失败, 失败原因在 msg 中返回返回示例 3. "data": null, 4. "msg": "" 5. } API 5 : 获取教室信息获取教室信息

9 1. partner_id int 是合作方 id room_id int 是教室 id 参数类型示例描述 room_id int 教室 id title string 英语语法在线直播课标题 start_time datetime :00:00 开课时间, 格式如 : :00:00 end_time datetime :00:00 结束时间, 格式如 : :00:00 type int 2 4: 小班课 max_users int 6 直播间允许的最大台上人数 max_backup_users int 0 小班课允许的最大台下人数 admin_code string abc123 管理员 ( 助教 ) 进入直播间的参加码 teacher_code string 123abc 老师进入直播间的参加码返回示例 4. "room_id": , 5. "title": " 小班课 ", 6. "start_time": " :03:51", 7. "end_time": " :04:37", 8. "type": "4", 9. "max_users": "6", 10. "admin_code": "a7ygsz", 11. "teacher_code": "3uhfu5", 12. "max_backup_users": "0" 13. }, 14. "msg": "", 15. "ts": } API 6 : 生成用户参加码为了方便学生进入教室, 我们可以根据学生的 user_number 生成学生参加码学生可以凭参加码直接进入教室

10 1. partner_id int 是合作方 ID room_id int 是教室 ID user_number int 是合作方账号体系下的用户 ID 号, 必须是 int 类型数字 user_avatar string 否用户头像, 需要完整的 url 地址 timestamp int 是当前时间, unix 时间戳参数类型示例描述 student_code string h3h7bk 学生参加码说明 : 参加码不会重复, 长度为 6 位一个学生参加码唯一对应了一个 room_id 和 user_number user_number 为 0 时, 生成的是学生用户的通用邀请码, 所有学生可使用该通用邀请码同时进入教室 ( 免费课场景 ) user_number 非 0 时, 同一个学生邀请码只支持一人同时在线 ( 收费课场景 ) 后进教室的学员会将之前进的人挤下线返回示例 4. "student_code": "h3h7bk" 5. }, 6. "msg": "", 7. "ts": } API 7 : 获取用户参加码信息获取用户参加码信息 1.

11 partner_id int 是合作方 ID code string 是学生参加码 timestamp int 是当前时间, unix 时间戳 exist bool 是参加码是否存在, 为 true 进 code_info 才有值 code_info.code string 是参加码 code_info.room_id int 是教室 ID code_info.user_number int 是合作方账号体系下的用户 ID 号, 为 int 类型正整数 code_info.user_role int 是用户角色 0: 学生 1: 老师 2: 助教 code_info.user_name string 是用户昵称 code_info.create_time datetime 是参加码生成时间返回示例 4. "exist": true, 5. "code_info": { 6. "code": "uvrv4c", 7. "room_id": , 8. "user_number": , 9. "user_role": 1, 10. "create_time": " :12:32" 11. } 12. }, 13. "msg": "", 14. "ts": } API 8 : 获取已生成的参加码列表获取已经生成的学生参加码列表 1.

12 partner_id int 是合作方 ID room_id int 是教室 ID page int 否 1 页数, 参加码数量过多时, 可以分多页来获取, 每页取 limit 条默认值为 1 limit int 否 100 每页获取的条数, 默认值 100, 最大值不能超过 1000 timestamp int 是当前时间, unix 时间戳参数类型示例描述 total int 101 该教室总共的学生参加码数 student_code string 12ed45 学生参加码 user_number int 参加码对应的用户 ID 号 user_avatar string 生成参加码时传的 user_avatar 返回示例 4. "total": 3, 5. "list": [ 6. { 7. "code": "kbvt9t", 8. "user_number": "11", 9. "user_avatar": "" 10. }, "code": "xvxavp", 13. "user_number": "10", 14. "user_avatar": "" 15. }, 16. { 17. "code": "2crrly", 18. "user_number": "0", 19. "user_avatar": "" 20. } 21. ] 22. }, 23. "msg": " 24. } API 9 : 获取教室列表获取已经创建的教室列表

13 1. partner_id int 是合作方 ID page int 否 1 页数, 参加码数量过多时, 可以分多页来获取, 每页取 limit 条默认值为 1 limit int 否 100 每页获取的条数, 默认值 100, 最大值不能超过 1000 product_type int 否 0 2: 小班课 timestamp int 是当前时间, unix 时间戳参数类型示例描述 room_id int 教室 ID title string 英语语法在线直播课标题 start_time int 开始时间, unix 时间戳 end_time int 结束时间, unix 时间戳 create_time int 创建时间, unix 时间戳 type int 2 4: 小班课 max_users int 20 教室最大台上人数 admin_code string abc123 助教进入教室的参加码 teacher_code string 123abc 老师进入教室的参加码 student_code string 321abc 学生进入教室的参加码 industry_type int 0 0: 表示教育返回示例

14 4. "total": 2, 5. "list": [ 6. { 7. "room_id": " ", 8. "title": " 测试 ", 9. "type": "4", 10. "max_users": "6", 11. "start_time": , 12. "end_time": , 13. "create_time": , 14. "teacher_code": "zu6fca", 15. "admin_code": "yk2tm9", 16. "student_code": "5e68dn", 17. "industry_type": }, 19. { 20. "room_id": " ", 21. "title": " 小班课 ", 22. "type": "4", 23. "max_users": "6", 24. "start_time": , 25. "end_time": , 26. "create_time": , 27. "teacher_code": "58ah5q", 28. "admin_code": "8x29n5", 29. "student_code": "w6zkwm", 30. "industry_type": } 32. ] 33. }, 34. "msg": "", 35. "ts": } API 10 : 直播课件文档上传上传图片或文档, 可指定关联到某教室支持的文档类型有 : '.doc', '.ppt', '.pdf', '.pptx', '.docx','.jpg', '.jpeg', '.png', '.gif','.zip' 1. partner_id int 是合作方用户名

15 room_id int 否教室号, 如果传了教室号则文档自动绑定到该教室, 不传则不绑定 ppt_animation int 否 0 是否使用动效 PPT, 只针对 PPT 有效,1 为动效 attachment 文件是要上传的文件 ( 文件不参与签名的计算 ) 参数说明注意 : 只有小班课才支持 h5 课件, 且需要配置权限上传 h5 课件有以下两种方法 : 1.attachment 参数上传.zip 文件 2.openapi 通过 url 上传 h5 课件. 参数类型示例描述 fid int 文档 ID name string 文件名上传的文档名 bind_id int 123 只有绑定到教室才会返回绑定 ID 返回示例 4. "fid": , 5. "name": "fb05686be68a856fac623f2669f5ef2f.jpeg", 6. "bind_id": }, 8. "msg": "", 9. "ts": } PHP 代码示例

16 1. <?php $url = ' 4. $partner_key = 'xxx'; 5. $data = [ 6. 'partner_id' => , 7. 'room_id' => , 8. 'timestamp' => , 9. ]; // 计算签名,getSign 函数参数 ` 签名规则 `, 文件不参与签名的计算 12. $data['sign'] = getsign($data, $partner_key); 13. $data['attachment'] = curl_file_create('/tmp/a.docx') $ch = curl_init(); 16. curl_setopt($ch, CURLOPT_URL, $url); 17. curl_setopt($ch, CURLOPT_, 1); 18. curl_setopt($ch, CURLOPT_FIELDS, $data); 19. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 20. $result = curl_exec($ch); 21. $info = curl_getinfo($ch); 22. $last_error = curl_error($ch); 23. curl_close($ch); print_r($last_error); 26. print_r($info); 27. print_r($result); API 11 : 关联文档到教室将指定文档关联到指定教室 1. partner_id int 是合作方用户名 room_id int 是教室号 fid int 是文档资源号参数类型示例描述

17 参数类型示例描述 fid int 文档 ID room_id string 教室号 bind_id int 123 绑定 ID 返回示例 4. "fid": , 5. "room_id": " ", 6. "bind_id": }, 8. "msg": "", 9. "ts": } API 12 : 获取指定教室内已上传的文档列表获取教室内已上传的文档 1. partner_id int 是合作方用户名 room_id int 是教室号参数类型示例描述 fid int 1 文档 ID name string 文件名上传的文档名返回示例

18 4. "room_id": " ", 5. "list": [ 6. { 7. "fid": , 8. "name": "fb05686be68a856fac623f2669f5ef2f.jpeg", 9. "create_time": " :03:46" 10. }, "fid": , 13. "name": "878488c7f153c5efccc9f0308a4baf89.jpg", 14. "create_time": " :31:58" 15. }, 16. { 17. "fid": , 18. "name": " 百家云 API 使用文档.pdf", 19. "create_time": " :31:17" 20. } 21. ] 22. }, 23. "msg": "", 24. "ts": } API 13 : 获取账号下上传的所有文档获取账号下已上传的所有文档 1. 参数类型是否必填默认值描述 partner _id int 是合作方用户名 type stri ng 是可选值 all: 所有文档 room: 教室里上传的文件 api: 从 api 接口上传的文档 management: 从后台文件管理上传的文档 page int 否 1 分页参数 page_s ize int 否 10 每页返回条数 timesta mp int 是当前时间,unix 时间戳

19 参数类型是否必填默认值描述 sign stri ng 是签名参数类型示例描述 fid int 1 文档 ID name string 文件名上传的文档名 upload_source string 上传来源 api: 通过 API 接口上传的 room: 在教室里上传的 create_time datetime 上传时间 upload_source string 上传来源 url string 文档地址 file_type string 文档类型 size int 文档大小, 单位字节返回示例 4. "total": 235, 5. "list": [ 6. { 7. "fid": " ", 8. "name": "audi.jpg", 9. "create_time": " :27:53", 10. "upload_source": "room", 11. "url": " &Signature=7QPEnP%2FQKlcnoCL6%2FhyXDuLlu4o%3D", 12. "file_type": " 普通文件 ", 13. "size": " " 14. } 15. ] 16. }, 17. "msg": "", 18. "ts": } API 14 : 移除教室内文档移除教室内已上传的文档

20 1. partner_id int 是合作方用户名 room_id int 是教室号 fid int 是文档 ID 返回 code=0 表示删除成功返回示例 4. "fid": "832418" 5. }, 6. "msg": "", 7. "ts": } API 15 : 获取直播教室当前上课状态获取直播教室当前的上下课状态 /GET 1. partner_id int 是合作方用户名 room_id int 是教室号参数类型示例描述 status int 0 1: 上课中 0: 不在上课中返回示例

21 4. "status": 1 5. }, 6. "msg": "", 7. "ts": } API 16 : 获取老师是否在教室状态获取当前老师是否在教室的状态 /GET 1. partner_id int 是合作方用户名 room_id int 是教室号参数类型示例描述 status int 0 1: 在教室 0: 不在教室返回示例 4. "status": 0 5. }, 6. "msg": "", 7. "ts": } API 17 : 获取当前时间教室人数获取当前时间教室人数 /GET 1.

22 partner_id int 是合作方用户名 room_id int 是教室号参数类型示例描述 user_count int 3 教室当前人数 display_user_count int 3 显示出来教室人数返回示例 4. "user_count": 2, 5. "display_user_count":2 6. }, 7. "msg": "", 8. "ts": } API 18 : 获取教室答题器数据接口描述该接口用于获取教室内学生答题器数据 1. room_id int 是教室号 partner_id int 是合作方用户名 date string 长期教室需要填写, 短期教室不需要日期响应参数参数类型示例描述 question_id int question_id description string 描述

23 参数类型示例描述 right_option string 正确选项 option_list array 选项列表 student_answer array 学生答案 4. "list": [ 5. { 6. "question_id": 1692, 7. "description": "", 8. "right_option": "B", 9. "option_list": [ 10. { 11. "option": "A", 12. "is_right": false 13. }, 14. { 15. "option": "B", 16. "is_right": true 17. }, 18. { 19. "option": "C", 20. "is_right": false 21. }, 22. { 23. "option": "D", 24. "is_right": false 25. } 26. ], 27. "student_answer": [ 28. { 29. "user_number": , 30. "user_name": " 分组 1 学员 ", 31. "question_id": 1692, 32. "select_option": "B", 33. "is_right": true 34. } 35. ] 36. }, 37. { 38. "question_id": 1693, 39. "description": "", 40. "right_option": "B,D", 41. "option_list": [ 42. { 43. "option": "A", 44. "is_right": false 45. },

24 46. { 47. "option": "B", 48. "is_right": true 49. }, 50. { 51. "option": "C", 52. "is_right": false 53. }, 54. { 55. "option": "D", 56. "is_right": true 57. } 58. ], 59. "student_answer": [ 60. { 61. "user_number": , 62. "user_name": " 分组 1 学员 ", 63. "question_id": 1693, 64. "select_option": "B,D", 65. "is_right": true 66. } 67. ] 68. }, 69. ], 70. "total": }, 72. "msg": "", 73. "ts": } API 19 : 导出教室聊天记录导出教室内的聊天记录只能导出最近 2 周的直播的聊天记录 GET/ 1. 参数类型是否必填默认值描述 partner_i d int 是合作方用户名 room_id int 是教室号 date strin g 是没传递时, 长期教室是最近上课的一天, 短期教室默认是这次课的所有聊天信息导出日期 timestam p int 是当前时间,unix 时间戳

25 参数类型是否必填默认值描述 sign strin g 是签名参数类型示例描述 time string :15:01 消息发送时间 user_number int 用户 ID user_role int 1 用户角色 0: 学生 1: 老师 2: 助教 user_name string 张三用户昵称 content string hello world 消息类容返回示例 4. "list": [ 5. { 6. "time": " :15:01", 7. "user_number": 12345, 8. "user_role": 1, 9. "user_name": " 张三 ", 10. "content": "hello world" 11. }, 12. { 13. "time": " :15:39", 14. "user_number": 123, 15. "user_role": 0, 16. "user_name": " 李 4", 17. "content": "[wx]" 18. }, 19. { 20. "time": " :40:28", 21. "user_number": 123, 22. "user_role": 0, 23. "user_name": " 李 4", 24. "content": "aaa" 25. } 26. ] 27. }, 28. "msg": "", 29. "ts": } API 20 : 导出直播教室学员观看记录导出直播教室学员观看记录

26 1. GET/ 参数类型是否必填默认值描述 partner_i d int 是合作方用户名 room_id int 是教室号 type strin g 否 studen t 可选值 all: 所有用户 student: 学员 teacher: 老师 admin: 助教, 默认只导出学员观看记录 page int 否 1 分页参数 page_siz e int 否 0 每页返回条数, 如果不传则返回所有的 date strin g 否 0 查询日期, 格式如 : detail int 否是否返回进出明细, 传 1 则返回 timestam p int 是当前时间,unix 时间戳 sign strin g 是签名参数类型示例描述 date string 日期 user_number int 用户的 ID 号 user_name string 昵称 user_role int 用户角色 0: 学生 1: 老师 2: 助教 first_time dateti me 最早进入教室时间 last_time dateti me 最晚离开教室时间 first_heartbeat_ti me dateti me 上课状态下, 最早在教室的时间 last_heartbeat_ti me dateti me 上课状态下, 最晚在教室的时间 actual_listen_tim e int 实际听课时长, 指上课状态下, 学生在教室的时间, 多次进出教室情况是把每一小段时间累加 ( 单位秒 )

27 参数类型示例描述 user_ip string 用户 IP area string 用户所属省份 city string 用户所属城市 network_operato r string 使用的网络运营商 group_id int 在教室中的分组 client_type int 0:PC 网页 1:pc 客户端 2:m 站 3:ios 4:android 5:mac 客户端 6: 微信小程序返回示例

28 4. "total": 2, 5. "room_user_info": [ 6. { 7. "date": " ", 8. "user_number": , 9. "user_name": "ios", 10. "user_role": 0, 11. "first_time": " :47:09", 12. "last_time": " :47:15", 13. "first_heartbeat_time": "", 14. "last_heartbeat_time": "", 15. "actual_listen_time": 0, 16. "user_ip": " ", 17. "network_operator": " 联通 ", 18. "client_type": 3, 19. "area": " 北京 ", 20. "city": " 北京 ", 21. "group_id": }, 23. { 24. "date": " ", 25. "user_number": , 26. "user_name": " 晨晨 ", 27. "user_role": 1, 28. "first_time": " :48:07", 29. "last_time": " :35:42", 30. "first_heartbeat_time": "", 31. "last_heartbeat_time": "", 32. "actual_listen_time": 0, 33. "user_ip": " ", 34. "network_operator": " 联通 ", 35. "client_type": 1, 36. "area": " 北京 ", 37. "city": " 北京 ", 38. "group_id": } 40. ] 41. }, 42. "msg": "", 43. "ts": } API 21 : 获取指定日期所有的直播间人次和最高并发量 1.

29 partner_id int 是合作方 id product_type int 是 2: 小班课 date string 是格式如 : 响应参数参数类型示例 / 默认值描述 room_id int 教室号 total_user_count int 总人次 ( 包括学生老师助教 ) student_count int 学生人次 peak_user int 峰值人数 ( 包含老师和助教 ) 响应示例 1. { 4. "room_user_stat": { 5. " ": { 6. "room_id": , 7. "student_count": 1, 8. "total_user_count": 1, 9. "peak_user": }, 11. " ": { 12. "room_id": , 13. "student_count": 2, 14. "total_user_count": 2, 15. "peak_user": }, 17. " ": { 18. "room_id": , 19. "student_count": 0, 20. "total_user_count": 7, 21. "peak_user": } 23. } 24. }, 25. "msg": "", 26. "ts": } API 22 : 获取指定教室一段时间内的并发量

30 接口描述该接口用于获取一段时间内教室的并发人数变化图由于数据量较大, 本接口每 10 分钟取一个最大值如果 : 15:10:00 => 3 表示的是 15:10:00~15:19:59 这段时间内的最高并发数为 partner_id int 是合作方 id room_id int 是教室号 start_time string 是格式如 : :00:00 end_time string 是格式如 : :00:00, 查询时间范围不能跨天响应参数参数类型示例 / 默认值描述 date date 日期 peak_user dict key 是时间,value 是峰值人数响应示例 4. "date": " ", 5. "peak_user": { 6. "15:00:00": 3, 7. "15:10:00": 3, 8. "15:20:00": 1, 9. "15:30:00": 1, 10. "15:40:00": 1, 11. "15:50:00": 1, 12. "16:00:00": 1, 13. "16:10:00": 1, 14. "16:20:00": 1, 15. "16:30:00": 1, 16. "16:40:00": 1, 17. "16:50:00": 1, 18. "17:00:00": } 20. }, 21. "msg": "", 22. "ts": } API 23 : 获取账号一天中每小时最高并发量

31 接口描述该接口用于获取账号一天中每小时的并发量 1. partner_id int 是合作方 id product_type int 否 0 2: 小班课 date string 是查询日期, 格式如 : sign string 是签名响应参数参数类型示例 / 默认值描述 peak_user dict key 是小时,value 是峰值人数响应示例

32 1. { 4. "peak_user": { 5. "00": 0, 6. "01": 0, 7. "02": 0, 8. "03": 0, 9. "04": 0, 10. "05": 0, 11. "06": 0, 12. "07": 0, 13. "08": 0, 14. "09": 0, 15. "10": 0, 16. "11": 1, 17. "12": 1, 18. "13": 1, 19. "14": 3, 20. "15": 3, 21. "16": 2, 22. "17": 0, 23. "18": 0, 24. "19": 0, 25. "20": 1, 26. "21": 1, 27. "22": 0, 28. "23": } 30. }, 31. "msg": "", 32. "ts": } API 24 : 查询账号一段时间内每天的最高并发量接口描述该接口用于获取账号一段时间内每天的最高并发量 1. partner_id int 是合作方 id product_type int 否 0 2: 小班课 start_date string 是查询起始日期, 格式如 : end_date string 是查询结束日期, 格式如 :

33 响应参数参数类型示例 / 默认值描述 peak_user dict key 是日期,value 是峰值人数响应示例 4. "peak_user": { 5. " ": 3, 6. " ": 1, 7. " ": 0, 8. " ": 0, 9. " ": 0, 10. " ": 0, 11. " ": 0, 12. " ": 0, 13. " ": 0, 14. " ": 0, 15. " ": 1, 16. " ": 0, 17. " ": 0, 18. " ": 1, 19. " ": 0, 20. " ": 0, 21. " ": } 23. }, 24. "msg": "", 25. "ts": } API 25 : 获取小班课账号每天消费记录接口描述获取一段时间内小班课账号每天消费记录 1. partner_id int 是合作方用户名

34 product_type int 是产品线类型 ( 老账号填 0 新账号填 2) start_date string 是开始日期 end_date string 是结束日期返回示例 4. "cost": { 5. " ": 0.84,// 日期 : 消费金额 ( 元 ) 6. " ": 0.12, 7. " ": 0.04, 8. " ": } 10. }, 11. "msg": "", 12. "ts": } API 26 : 获取小班课指定日期各教室消费记录接口描述获取小班课指定日期各教室消费记录 1. partner_id int 是合作方用户名 product_type int 是产品线类型 ( 老账号填 0 新账号填 2) date string 是日期返回示例

35 4. "room_cost": { 5. " ": 0.56,// 直播间 id : 消费金额 ( 元 ) 6. " ": 0.24, 7. " ": } 9. }, 10. "msg": "", 11. "ts": } API 27 : 获取小班课指定教室各学员消费详情接口描述获取小班课指定教室各学员消费详情 1. partner_id int 是合作方用户名 product_type int 是产品线类型 ( 老账号填 0 新账号填 2) date string 是日期 room_id string 是直播间 id 参数描述 user_number 用户 number 号 user_name 用户昵称 user_role 用户角色 (0: 学生 1: 老师 2: 管理员 3: 游客 ) actual_listen_time 真实听课时长 ( 秒 ) rate 费率 ( 元 ) cost 消耗金额 ( 元 ) teacher_ext_camera 老师是否用了双摄 (0: 没有 1: 有 ) 返回示例

36 4. "teacher_ext_camera" : 0, 5. "list": [ 6. { 7. "user_number": " ", 8. "user_name": "chen", 9. "user_role": "1", 10. "actual_listen_time": "193", 11. "rate": 0.08, 12. "cost": }, 14. { 15. "user_number": " ", 16. "user_name": "stu", 17. "user_role": "0", 18. "actual_listen_time": "162", 19. "rate": 0.08, 20. "cost": } 22. ] 23. }, 24. "msg": "", 25. "ts": } API 28 : 获取直播教室的点赞数据接口描述该接口用于获取直播教室的点赞数据 1. room_id int 是教室号 partner_id int 是合作方用户名响应参数

37 4. "room_id": " ", 5. "list": [ 6. { 7. "user_number": , 8. "user_name": "zhangsan", 9. "count": 10, 10. }, "user_number": , 13. "user_name": "zhangsan", 14. "count": 10, 15. }, 16. { 17. "user_number": , 18. "user_name": "zhangsan", 19. "count": 10, 20. } 21. ] 22. }, 23. "msg": "", 24. "ts": } API 29 : 获取直播教室测验的试题信息接口描述该接口用于获取直播教室测验的试题信息 1. partner_id int 是 partner_id room_id int 是教室号响应参数参数类型示例描述 quiz_list arr ay 试卷列表 quiz_list[].quiz_id int 试卷 id quiz_list[].force_join int 是否强制参加

38 参数类型示例描述 quiz_list[].title stri ng 试卷标题 question_list arr ay 题目列表 question_list[].type stri ng 题目类型 (judge_question= 判断题 single_select= 单选题 multi_select= 多选题 question_answer= 问答题 ) question_list[].question_id int 题目 ID question_list[].title int 题目名称 question_list[].suggested_ solution stri ng 参考答案 ( 问答题才有该项 ) option_list arr ay 选项列表 ( 判断题单选题多选题才有该项 ) option_list[].option_id int 选项 ID option_list[].value stri ng 选项值 option_list[].is_right 响应示例 stri ng 该选项是否是正确答案 4. "quiz_list": [ 5. { 6. "quiz_id": 2095, 7. "title": " 随堂考试 ", 8. "force_join": 0, 9. "question_list": [ 10. { 11. "question_id": 4887, 12. "type": "judge_question", 13. "title": "1+1=2?", 14. "option_list": [ 15. { 16. "option_id": 15355, 17. "value": " 对 ", 18. "is_right": }, 20. { 21. "option_id": 15356, 22. "value": " 错 ", 23. "is_right": } 25. ] 26. },

39 26. }, 27. { 28. "question_id": 4888, 29. "type": "single_select", 30. "title": " 以下数字最大的是?", 31. "option_list": [ 32. { 33. "option_id": 15357, 34. "value": "1", 35. "is_right": }, 37. { 38. "option_id": 15358, 39. "value": "2", 40. "is_right": }, 42. { 43. "option_id": 15359, 44. "value": "34", 45. "is_right": }, 47. { 48. "option_id": 15360, 49. "value": "4", 50. "is_right": } 52. ] 53. }, 54. { 55. "question_id": 4889, 56. "type": "multi_select", 57. "title": " 以下属于四大名著的有 ", 58. "option_list": [ 59. { 60. "option_id": 15361, 61. "value": " 西游记 ", 62. "is_right": }, 64. { 65. "option_id": 15362, 66. "value": " 水浒传 ", 67. "is_right": }, 69. { 70. "option_id": 15363, 71. "value": " 三国演义 ", 72. "is_right": }, 74. { 75. "option_id": 15364, 76. "value": " 红楼梦 ", 77. "is_right": }

40 78. } 79. ] 80. }, "question_id": 4890, 83. "type": "question_answer", 84. "title": " 挖掘机技术哪家强?", 85. "suggested_solution": " 中国山东找蓝翔 " 86. } 87. ] 88. } 89. ] 90. }, 91. "msg": "", 92. "ts": } 94. API 30 : 获取直播教室测验题目的学员答案信息接口描述该接口用于获取某个教室测验试题学员答案信息 1. partner_id int 是合作方 id room_id int 是教室号 quiz_id int 是试卷的 id 响应参数参数类型示例描述 student_answer_list arr ay 参与测验的学生列表 student_answer_list[].us er_number int 学生 ID student_answer_list[].us er_name str in g 学生姓名 answer_list arr ay 该学生每个题目的答案列表 answer_list[].question_i d int 回答的题目 ID

41 参数类型示例描述 answer_list[].answer str in g 学生回答的答案, 判断题 & 单选题是选项的 option_id, 多选题是多个选项的 option_id 用英文逗号分隔, 简答题则是学生的答案 4. "student_answer_list": [ 5. { 6. "user_number": 1, 7. "user_name": " 张三 ", 8. "answer_list": [ 9. { 10. "question_id": 9, 11. "answer": "16" 12. }, 13. { 14. "question_id": 6, 15. "answer": "10,11" 16. }, 17. { 18. "question_id": 7, 19. "answer": " 百家云 " 20. } 21. ] 22. } 23. ] 24. }, 25. "msg": "", 26. "ts": } API 31 : 获取教室答题器数据接口描述该接口用于获取教室内学生答题器数据 1. room_id int 是教室号 partner_id int 是合作方用户名 date string 长期房间需要填写, 短期房间不需要

42 响应参数参数类型示例描述 question_id int question_id description string 描述 right_option string 正确选项 option_list array 选项列表 student_answer array 学生答案 4. "list": [ 5. { 6. "question_id": 1692, 7. "description": "", 8. "right_option": "B", 9. "option_list": [ 10. { 11. "option": "A", 12. "is_right": false 13. }, 14. { 15. "option": "B", 16. "is_right": true 17. }, 18. { 19. "option": "C", 20. "is_right": false 21. }, 22. { 23. "option": "D", 24. "is_right": false 25. } 26. ], 27. "student_answer": [ 28. { 29. "user_number": , 30. "user_name": " 分组 1 学员 ", 31. "question_id": 1692, 32. "select_option": "B", 33. "is_right": true 34. } 35. ] 36. },

43 36. }, 37. { 38. "question_id": 1693, 39. "description": "", 40. "right_option": "B,D", 41. "option_list": [ 42. { 43. "option": "A", 44. "is_right": false 45. }, 46. { 47. "option": "B", 48. "is_right": true 49. }, 50. { 51. "option": "C", 52. "is_right": false 53. }, 54. { 55. "option": "D", 56. "is_right": true 57. } 58. ], 59. "student_answer": [ 60. { 61. "user_number": , 62. "user_name": " 分组 1 学员 ", 63. "question_id": 1693, 64. "select_option": "B,D", 65. "is_right": true 66. } 67. ] 68. }, 69. ], 70. "total": }, 72. "msg": "", 73. "ts": } API 32 : 直播教室的点赞数据接口描述该接口用于获取直播教室的点赞数据 1.

44 room_id int 是教室号 partner_id int 是合作方用户名响应参数 4. "room_id": " ", 5. "list": [ 6. { 7. "user_number": , 8. "user_name": "zhangsan", 9. "count": 10, 10. }, "user_number": , 13. "user_name": "zhangsan", 14. "count": 10, 15. }, 16. { 17. "user_number": , 18. "user_name": "zhangsan", 19. "count": 10, 20. } 21. ] 22. }, 23. "msg": "", 24. "ts": } API 33 : 获取表情报告截取的表情图片接口 1. 请求参数字段名类型必选描述 room_id int 是教室号 partner_id int 是合作方用户名返回参数

45 4. "title": "xxxxxxx", 5. "room_id": , 6. "list": [ 7. { 8. "user_name": " 张三 ", 9. "user_number": 1234, 10. "user_role": 0, 11. "exp_list": [ 12. { 13. "exp_desc": "xxxx xxxxx", 14. "exp_type": "sad", 15. "exp_url": "test-img.baijiayun.com/x/x/x.jpg", 16. }, 17. { 18. "exp_desc": "xxxx xxxxx", 19. "exp_type": "happy", 20. "exp_url": "test-img.baijiayun.com/x/x/x.jpg", 21. } 22. ] 23. }, 24. ] 25. } 26. } API 34 : 生成用户试听参加码为了方便使用学生身份进入教室, 我们可以根据学生的 user_number 生成学生试听参加码学生可以凭参加码直接进入教室说明 : 进入教室为隐身进入, 可用于隐身监课 1. partner_id int 是合作方 ID room_id int 是房间 ID user_numbers string 是合作方账号体系下的用户 ID 号, 必须是数字且要大于 0, 多个的话用逗号分隔 user_avatar string 否用户头像, 需要完整的 url 地址 audition_length int 否指的是具体试听时长 ; 必须大于 0, 且不能超过 10800(3 小时 ), 单位是秒数 timestamp int 是当前时间, unix 时间戳

46 参数类型示例描述 code string 12ed45 学生试听参加码 user_number int 1234 user_number 说明 : 参加码不会重复, 长度为 6 位一个学生参加码唯一对应了一个 room_id 和 user_number 同一个学生的试听参加码只支持一人同时在线后进教室的学员会将之前进的人挤下线返回示例 4. "total": 2, 5. "list": [ 6. { 7. "student_code": "abc123", 8. "user_number": , 9. }, 10. { 11. "student_code": "abc456", 12. "user_number": , 13. } 14. ] }, 17. "msg":"" 18. } API 35 : 使用 url 上传 h5 课件上传一个 h5 课件的 url, 可以选择绑定教室 1. partner_id int 是合作方用户名 room_id int 否教室号, 如果传了教室号则文档自动绑定到该教室, 不传则不绑定 h5_doc_url string 是 h5 课件的地址 ( 请使用开头的地址 ) name string 否可选 : 课件名称

47 参数类型示例描述 fid int 文档 ID name string 上传的地址 bind_id int 123 只有绑定到教室才会返回绑定 ID 返回示例 4. "fid": , 5. "name": " 6. "bind_id": }, 8. "msg": "", 9. "ts": } API 36: 获取教室设备自检的信息通过 room_id 获取该教室设备自检的信息 1. 参数类型是否必填示例描述 partner_id int 是账号 ID room_id int 是教室 ID page int 否默认 1 页数 page_size int 否默认 10 每一页的大小 timestamp int 是当前时间,unix 时间戳参数类型示例描述 id string 11 一次检测的 id room_id string 教室号 partner_id string partner_id user_number string 用户编号 user_name string test 用户名

48 参数类型示例描述 user_role string 0 角色 (0: 学生 1: 老师 2: 助教 ) camera_status string 0 摄像头状态 0: 不正常 1: 正常 mic_status string 0 麦克风状态 0: 不正常 1: 正常 speaker_status string 0 扬声器状态 0: 不正常 1: 正常 os string mac os 操作系统 client string chrome 浏览器 or 客户端信息 ip string ip create_time string :10:01 检测时间返回示例 4. "list": [ 5. { 6. "id": "11", 7. "room_id": " ", 8. "partner_id": " ", 9. "user_number": "123456", 10. "user_name": "test", 11. "user_role": "0", 12. "camera_status": "1", 13. "mic_status": "0", 14. "speaker_status": "1", 15. "os": "mac os", 16. "client": "chrome", 17. "ip": " ", 18. "create_time": " :10:01" 19. } 20. ], 21. "total": }, 23. "msg": "", 24. "ts": } API 37: 批量获取课后评价按天获取账号下所有的课后评价信息 1. 参数类型是否必填示例描述

49 参数类型是否必填示例描述 partner_id int 是账号 ID date string 是日期 timestamp int 是当前时间,unix 时间戳 page int 否默认 1 当前页数 page_size int 否默认 100 每一页返回数据量参数类型示例描述 room_id int 教室号 partner_id int 合作方 id question string 问题 answer string 回答 user_number int 学生号 user_name string 学生名 commit_id int 一次提交的 id create_time string 提交时间返回示例 4. "list": [ 5. { 6. "room_id": , 7. "partner_id": , 8. "question": " 您对本次课程的总体评价 :", 9. "answer": " 一般 ", 10. "user_number": , 11. "user_name": "test", 12. "commit_id": , 13. "create_time": " :48:05" 14. } 15. ], 16. "total": }, 18. "msg": "", 19. "ts": }

50 API 38: 关联文档到多个教室将指定文档关联到多个教室 1. 参数类型是否必填示例描述 partner_id int 是账号 ID room_ids string 是教室 ID 数组, 逗号分割数组 fid int 是文件资源 ID timestamp int 是当前时间,unix 时间戳请求示例 1. partner_id: timestamp: sign:51042a67bec1f4f150057b0ad13b room_ids:' , ' 5. fid: 参数类型示例描述 fid int 资源 ID room_ids array 绑定得教室 id 数组 bind_id array 绑定 ID 返回示例 4. "bind_ids": [ , ], 8. "room_ids": [ 9. " ", 10. " " 11. ], 12. "fid": " " 13. }, 14. "msg": "", 15. "ts": }

51 API 39 : 获取教室举手连麦数据接口描述该接口用于获取教室内学生举手连麦数据 1. room_id int 是教室号 partner_id int 是合作方用户名 start_time string 是开始时间 end_time string 是结束时间响应参数参数类型示例描述 room_id int 教室号 user_number int 用户 ID user_name string 用户昵称 raise_time string :00:29 举手时间 raise_success_time string 举手连麦成功时间 raise_end_time string 举手结束时间 speak_time string 00:00:00 发言时间

52 3. "data": [ 4. { 5. "room_id": , 6. "user_number": , 7. "user_name": " 学生姓名 ", 8. "raise_time": " :00:29", 9. "raise_success_time": "", 10. "raise_end_time": "", 11. "speak_time": "00:00:00" 12. }, 13. { 14. "room_id": , 15. "user_number": , 16. "user_name": " 学生姓名 ", 17. "raise_time": " :00:29", 18. "raise_success_time": "", 19. "raise_end_time": "", 20. "speak_time": "00:00:00" 21. }, 22. ], 23. "msg": "", 24. "ts": } API 40: 监课接口获取正在上课的教室列表, 以及教室中的监课图片和监课进教室地址 ( 监课需要开启配置项 ) ( 截图需要开启云端录制 or 前端截图仅支持客户端 ) 1. 参数类型是否必填示例描述 partner_id int 是账号 ID timestamp int 是当前时间,unix 时间戳 page int 否 1 页数, 默认 1 page_size int 否 20 每页大小, 默认 20 参数类型描述 room_id string 教室号 title string 教室名称

53 参数类型描述 start_time string 老师点上课的时间 monitor_img array 监课截图数据 enter_url string 监课进教室链接返回示例 3. "data": [ 4. { 5. "room_id": " ", 6. "title": " 监课 ", 7. "start_time": " :57:24", 8. "monitor_img": [ 9. { 10. "img_url": " 11. "create_time": " :00:35" 12. } 13. ], 14. "enter_url": " code=hryhh4&user_name=%e9%9a%90%e8%ba%abadmin&user_status=1" 15. } 16. ], 17. "msg": "", 18. "ts": } API 41 : 批量添加插播接口描述此接口批量添加插播 1. partner_id int 是合作方用户名 room_id int 是 room_id video_ids int 是视频 id, 多个视频用逗号分隔

54 返回 code=0 表示添加成功响应参数 3. "data": null, 4. "msg": "", 5. "ts": } API 42 : 获取教室设置的插播点播接口描述该接口用于获取小班课里插播点播的视频 1. room_id int 是教室号响应参数参数类型示例描述 video_id int 设置的插播列表 playback_room_id int 固定值 0 playback_session_id int 固定值 0 create_time datetime 添加时间 4. "list": [ 5. { 6. "video_id": , 7. "playback_room_id": 0, 8. "playback_session_id": 0, 9. "create_time": " :58:02" 10. } 11. ] 12. }, 13. "msg": "", 14. "ts": }

55 API 43 : 批量移除小班课中的插播接口描述此接口批量移除插播 1. partner_id int 是合作方用户名 room_id int 是 room_id video_ids int 是视频 id, 多个视频用逗号分隔返回 code=0 表示删除成功响应参数 3. "data": null, 4. "msg": "", 5. "ts": } API 44 : 获取小班课学情报告数据该接口用于获取一个小班课教室中, 学生学情报告地址 /GET 1. partner_id int 是合作方 id room_id int 是房间 id 返回示例

56 3. "data": [ 4. { 5. "index": 1,// 序号 6. "room_id": " ",// 教室号 7. "user_name": " zhangsan",// 学员姓名 8. "user_number": " ",// 学员 id 9. "study_report_url": " room_id= &user_number= &end_type=3"// 学情报告地址 10. } 11. ], 12. "msg": "", 13. "ts": } API 45 : 小班课课件预览接口返回课件的预览地址 1. room_id string 是直播间 id partner_id string 是合作方 id sign string 是签名参数类型示例描述 fid int 文件 id doc_format string h5:h5 格式 animation_ppt : 动效 PPT doc: 静态文档 image: 图片 image_list array 普通文档的图片列表 (doc_format 为 doc 时读取 ) image string 图片 (doc_format 为 image 时读取 ) html string h5 动效 PPT 静态课件返回的 html(doc_format 为 h5 animation_ppt doc 时读取 ) 响应示例

57 4. "list": [ 5. { 6. "fid": , 7. "fname": " 哈哈哈.png", 8. "image_list": [], 9. "image": " 10. "html": "", 11. "doc_format": "image" 12. }, 13. { 14. "fid": , 15. "fname": " 可爱手绘风教学课件 PPT 模板 ( 有备注的 ).pptx", 16. "image_list": [], 17. "image": "", 18. "html": " 19. "doc_format": "animation_ppt" 20. }, "fid": , 23. "fname": " 卜算子.pptx", 24. "image_list": [ 25. " 26. " 27. " 28. ], 29. "image": "", 30. "html": " fid= &token=6ufqal5azrapmd2frp4l7w", 31. "doc_format": "doc" 32. }, 33. { 34. "fid": , 35. "fname": "test-h5-doc.zip", 36. "image_list": [], 37. "image": "", 38. "html": " 39. "doc_format": "h5" 40. } 41. ] 42. }, 43. "msg": "", 44. "ts": } API 46 : 创建课后评价模板创建课后评价模板

58 1. partner_id int 是合作方 id title string 是模板标题 guide_info string 否提示信息 product_type int 否产品线类型 :1 大班课,2 小班课, 默认为 1 questions json 是模板中的问题列表请求示例

59 1. title: 测试评价 2. guide_info: 测试提示信息 3. questions:[ 4. { 5. "title":" 问题 1", // 问题的标题, 必填参数, 类型 string 6. "type":"1", // 回答问题的形式, 2 => 单选 3=> 多选, 4 => 填空, 1 => 下拉框, 必填参数. 类型 int 7. "is_force":"1", // 是否是必填项, 0 非必填,1 必填, 必填参数, 类型 int 8. "options":[ // 问题的选项, 类型 array 9. " 好 ", // 选项 " 不好 ", // 选项 " 不好说 " // 选项 ] 13. }, 14. { 15. "title":" 问题 2", 16. "type":"2", 17. "is_force":"0", 18. "options":[ 19. " 好 ", 20. " 不好 ", 21. " 不好说 " 22. ] 23. }, 24. { 25. "title":" 问题 3", 26. "type":"3", 27. "is_force":"1", 28. "options":[ 29. " 好 ", 30. " 不好 ", 31. " 不好说 " 32. ] 33. }, 34. { 35. "title":" 您对本次课程有何建议 ", 36. "type":"4", 37. "is_force":"1" 38. } 39. ] 参数类型示例描述 id int 评价模板 id 响应事例

60 4. "id": }, 6. "msg": "", 7. "ts": } API 47 : 直播音视频课件上传该接口支持上传音视频文件, 上传成功后会显示在百家云后台的文件管理列表中如果指定了 room_id, 那么会将文件与该教室绑定, 同时显示在教室文件中音频文件支持类型 :mp3 wav wma aac flac m4a oga opus 视频文件支持类型 :mp4 3gp mpg mpeg 3g2 avi flv wmv h264 m4v mj2 mov ogg ogv rm rmvb qt webm 音视频文件大小限制最大为 50M 只有 webrtc 底层的教室才支持播放音视频课件 1. partner_id int 是合作方 id attachment binary 是音视频文件 room_id int 否不传则不会绑定到教室, 传了绑定到指定教室教室 ID 参数类型示例描述 fid int 音视频文件的 fid 响应事例 4. "fid": }, 6. "msg": "", 7. "ts": } API 48 : 获取小班课奖励数据

61 该接口用于获取一个小班课教室中, 直播间奖励的数据注意 : 如后台配置某种奖励类型为不显示, 那么接口不会返回该类型数据 /GET 1. partner_id int 是合作方 id room_id int 是房间 id 返回示例 3. "data": [ 4. { 5. "user_number": "123456", 6. "user_name": "zhangsan", 7. "award": [ 8. { 9. "name": " 点赞 ", 10. "count": "11" 11. }, 12. { 13. "name": " 花花 ", 14. "count": "12" 15. }, 16. { 17. "name": " 奖杯 ", 18. "count": "30" 19. } 20. ] 21. } 22. ], 23. "msg": "", 24. "ts": } API 49 : 通过文档 ID 获取文档课件预览接口通过文档 ID 获取文档课件预览

62 1. partner_id int 是合作方 id fid string 是文档 ID 参数类型示例描述 fid int 文件 id doc_format string h5:h5 格式 animation_ppt : 动效 PPT doc: 静态文档 image: 图片 image_list array 普通文档的图片列表 (doc_format 为 doc 时读取 ) image string 图片 (doc_format 为 image 时读取 ) html string h5 动效 PPT 静态课件返回的 html(doc_format 为 h5 animation_ppt doc 时读取 ) 响应事例

63 4. "list": [ 5. { 6. "fid": , 7. "fname": " 哈哈哈.png", 8. "image_list": [], 9. "image": " 10. "html": "", 11. "doc_format": "image" 12. }, 13. { 14. "fid": , 15. "fname": " 可爱手绘风教学课件 PPT 模板 ( 有备注的 ).pptx", 16. "image_list": [], 17. "image": "", 18. "html": " 19. "doc_format": "animation_ppt" 20. }, "fid": , 23. "fname": " 卜算子.pptx", 24. "image_list": [ 25. " 26. " 27. " 28. ], 29. "image": "", 30. "html": " fid= &token=6ufqal5azrapmd2frp4l7w", 31. "doc_format": "doc" 32. }, 33. { 34. "fid": , 35. "fname": "test-h5-doc.zip", 36. "image_list": [], 37. "image": "", 38. "html": " 39. "doc_format": "h5" 40. } 41. ] 42. }, 43. "msg": "", 44. "ts": } API 50 : 获取账号下已上传的所有音视频课件接口获取账号下已上传的所有音视频课件

64 1. partner_id int 是合作方 id type string 否上传类型,api 表示通过 API 上传的,management 表示通过后台上传的 page int 否页码 page_size int 否每页条目数量参数类型示例描述 fid int 文件 id name string 文件名 upload_source string 上传来源,api 表示通过 API 上传的,management 表示通过后台上传的 create_time datetime 上传时间 size int 音视频课件原始大小响应事例 4. "total": 1, 5. "list": [ 6. { 7. "fid": "928445", 8. "name": " 测试文件.doc", 9. "upload_source": "api", 10. "create_time": " :12:29", 11. size : } 13. ] 14. }, 15. "msg": "", 16. "ts": } API 51 : 重命名课件接口重命名课件

65 1. partner_id int 是合作方 id fid string 是文档 ID name string 是文档名称参数类型示例描述 fid int 文档 id name string 文档名称响应事例 4. "fid": , 5. "name": " 文档名称 ", 6. }, 7. "msg": "", 8. "ts": } API 52 : 删除课件接口删除课件 1. partner_id int 是合作方 id fid string 是文档 ID

66 响应事例 3. "data": null, 4. "msg": "", 5. "ts": } API 53 : 关联音视频文档到教室接口关联音视频文档到教室 1. partner_id int 是合作方 id fid int 是文档 ID room_id int 是教室 ID 响应事例 3. "data": null, 4. "msg": "", 5. "ts": } 后台用户管理与白名单 API 1 : 添加用户添加学员或老师当添加老师角色时候,user_sn 可以不传, 因为系统会统一将 user_sn 和 phone_number 参数一致 1.

67 partner_id int 是合作方 id timestamp string 是当前时间,unix 时间戳 role int 是角色 id 0: 学生 1: 老师 2: 管理员 name string 是用户名 phone_number string 是手机号 string 否邮箱 user_sn string 是学号 remark string 否备注 password string 是用户密码请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. role : 0 5. name : 测试甲 6. phone_number : mobile : @qq.com 9. remark : password : 参数类型示例描述 id int 用户 id name string 用户名 role int 用户角色 id 0: 学生 1: 老师 2: 管理员响应事例 4. "id": , 5. "name": "ceshi", 6. "role": 0 7. }, 8. "msg": "", 9. "ts": }

68 API 2 : 获取用户列表获取学员 / 老师列表 1. partner_id int 是合作方 id timestamp string 是当前时间,unix 时间戳 role int 是角色 id 0: 学生 1: 老师 2: 管理员 page int 否 1 页码 page_size int 否 50 页面大小请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. role : 0 5. page : 1 6. page_size : 20 参数类型示例描述 total int 返回数据的条数 user_id int 用户 ID role int 角色 0: 学生 1: 老师 2: 管理员 name string 用户昵称 user_sn string 学号 string 邮箱 remark string 备注 create_time timestamp 创建时间 phone_number string 手机号码响应事例

69 4. "total": 7, 5. "list": [ 6. { 7. "user_id": , 8. "role": 0, 9. "name": " 学员丁 ", 10. "user_sn": "123459", 11. " ": "4@qq.com", 12. "remark": "", 13. "create_time": " :54:19", 14. "phone_number": " " 15. }, 16. { 17. "user_id": 99908, 18. "role": 2, 19. "name": "gly1", 20. "user_sn": " ", 21. " ": "gly1@qq.com", 22. "remark": "gly1", 23. "create_time": " :36:06", 24. "phone_number": " " 25. }, 26. { 27. "user_id": 99907, 28. "role": 1, 29. "name": "2", 30. "user_sn": " ", 31. " ": "ls00@qq.com", 32. "remark": "0", 33. "create_time": " :34:04", 34. "phone_number": " " 35. }, 36. { 37. "user_id": 99906, 38. "role": 0, 39. "name": " 学员丙 ", 40. "user_sn": "123458", 41. " ": "3@qq.com", 42. "remark": "", 43. "create_time": " :32:42", 44. "phone_number": " " 45. }, 46. { 47. "user_id": 99905, 48. "role": 0, 49. "name": " 学员乙 ", 50. "user_sn": "123457", 51. " ": "2@qq.com", 52. "remark": "", 53. "create_time": " :29:16", 54. "phone_number": " " 55. }, 56. {

70 56. { 57. "user_id": 99904, 58. "role": 0, 59. "name": " 学员甲 ", 60. "user_sn": "123456", 61. " ": "1@qq.com", 62. "remark": "", 63. "create_time": " :28:27", 64. "phone_number": " " 65. }, 66. { 67. "user_id": 99732, 68. "role": 1, 69. "name": "1", 70. "user_sn": " ", 71. " ": "ls1@qq.com", 72. "remark": "1", 73. "create_time": " :41:52", 74. "phone_number": " " 75. } 76. ] 77. }, 78. "msg": "", 79. "ts": } API 3 : 批量删除用户批量删除学员或老师 1. partner_id int 是合作方 id user_ids string 是用户 ID role int 是角色 id 0: 学生 1: 老师 2: 管理员请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. user_ids : "99904,99905,99906,100086" 5. role : 0

71 参数类型示例描述响应事例 4. "null 5. }, 6. "msg": "", 7. "ts": } API 4 : 给教室批量关联学员给教室批量关联学员 1. partner_id int 是合作方 id user_ids string 是用户 ID room_id int 是教室 ID 请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. user_ids : "99904,99905,99906,100086" 5. room_id : 参数类型示例描述响应事例

72 3. "data": null, 4. "msg": "", 5. "ts": } API 5 : 给教室关联老师 / 助教给教室批量关联老师 / 助教 1. partner_id int 是合作方 id role int 是角色 id 1: 老师 2: 助教 user_id int 是用户 ID room_id int 是教室 ID 请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. role : 1 5. user_id : room_id : 参数类型示例描述 id int 教室与老师 / 助教绑定的 id 响应事例 4. "id": "254163" 5. }, 6. "msg": "", 7. "ts": }

73 API 6 : 获取教室关联的学员列表获取教室关联的学员列表 1. partner_id int 是合作方 id room_id int 是教室 id page int 否 1 页码 page_size int 否 20 页面大小请求示例 1. partner_id : timestamp : 1 3. sign : 8e a3f a6b34d97c 4. room_id : page : 1 6. page_size : 10 参数类型示例描述 total int 返回数据的条数 user_id int 用户 ID assign_role int 角色 0: 学生 1: 老师 2: 助教 name string 用户昵称 user_sn string 学号 string 邮箱 remark string 备注 create_time timestamp 添加时间 phone_number string 手机号码响应事例

74 4. "total": 4, 5. "list": [ 6. { 7. "user_id": 99904, 8. "assign_role": 0, 9. "name": " 学员甲 ", 10. "create_time": " :49:52", 11. " ": "1@qq.com", 12. "user_sn": "123456", 13. "phone_number": " ", 14. "remark": "" 15. }, 16. { 17. "user_id": 99905, 18. "assign_role": 0, 19. "name": " 学员乙 ", 20. "create_time": " :49:52", 21. " ": "2@qq.com", 22. "user_sn": "123457", 23. "phone_number": " ", 24. "remark": "" 25. }, 26. { 27. "user_id": 99906, 28. "assign_role": 0, 29. "name": " 学员丙 ", 30. "create_time": " :49:52", 31. " ": "3@qq.com", 32. "user_sn": "123458", 33. "phone_number": " ", 34. "remark": "" 35. }, 36. { 37. "user_id": , 38. "assign_role": 0, 39. "name": " 学员丁 ", 40. "create_time": " :49:52", 41. " ": "4@qq.com", 42. "user_sn": "123459", 43. "phone_number": " ", 44. "remark": "" 45. } 46. ] 47. }, 48. "msg": "", 49. "ts": } API 7 : 获取教室关联的老师和助教

展开

获取 Access Token access_token 是接口的全局唯一票据, 接入方调用各接口时都需使用 access_token 开发者需要进行妥善保存 access_token 的存储至少要保留 512 个字符空间 access_token 的有效期目前为 2 个小时, 需定时刷新, 重复

获取 Access Token access_token 是接口的全局唯一票据, 接入方调用各接口时都需使用 access_token 开发者需要进行妥善保存 access_token 的存储至少要保留 512 个字符空间 access_token 的有效期目前为 2 个小时, 需定时刷新, 重复获取将导致上次获取的 access_token 失效接入方可以使用 AppID 和 AppSecret

百家云 - 开发者中心 在线教育网校系统,视频直播朊务,在线培训平台,视频教育软件

百家云 - 开发者中心在线教育网校系统,视频直播朊务,在线培训平台,视频教育软件