百家云双师课堂
产品文档 双师技术文档 双师课堂互动系统接口

概述

本文档用于描述百家云双师课堂互动数据接口

API 1: 签到汇总数据

【请求地址】

http://hudong.baijiayun.com/openapi/interact_info/getInteractList

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
type string checkin 类型
page int 1 页数
page_size int 20 每页数据条数
begin_time string 开始时间
end_time string 结束时间
timestamp int 当前时间,unix时间戳
sign string 签名

【返回示例】

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 175,
                "create_time": "2019-04-23 10:58:44",
                "type": "签到",
                "name": "",
                "title": "20190416添加的课程",
                "zone_name": "",
                "class_room_name": "武汉",
                "class_name": "1班初试",
                "total_student_count": 13,
                "total_student_type_count": {
                    "正式": 7,
                    "试听": 6
                },
                "join_student_type_count": {
                    "正式": 3
                }
            },
            {
                "id": 176,
                "create_time": "2019-04-23 11:01:04",
                "type": "选择题",
                "name": "",
                "title": "20190416添加的课程",
                "zone_name": "",
                "class_room_name": "武汉",
                "class_name": "1班初试",
                "total_student_count": 13,
                "total_student_type_count": {
                    "正式": 7,
                    "试听": 6
                },
                "join_student_type_count": {
                    "正式": 2
                }
            }
        ],
         "total": 30
    },
    "msg": "",
    "ts": 1559269709
}

API 2: 签到明细数据

【请求地址】

http://hudong.baijiayun.com/openapi/interact_info/getInteractDetail

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
type string checkin 类型
page int 1 页数
page_size int 20 每页数据条数
begin_time string 开始时间
end_time string 结束时间
timestamp int 当前时间,unix时间戳
sign string 签名

【返回示例】

{
    "code": 0,
    "data": {
        "list": [
            {
                "id": 175,
                "create_time": "2019-04-23 10:58:44",
                "interact_type": "签到",
                "live_room": "20190416添加的课程",
                "class_room_name": "武汉",
                "zone_name": "",
                "class_name": "1班初试",
                "teacher_name" : "老师1",
                "student_name": "景神",
                "is_checkin": "已签到",
                "sex": "女",
                "type": "正式",
                "mobile": "18401511514",
                "sn": 1,
                "remark": ""
            }
        ],
         "total": 306
    },
    "msg": "",
    "ts": 1559270077
}

API 3: 获取班级投票数据

【请求地址】

http://hudong.baijiayun.com/openapi/interact_data/getClassVoteData

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
type int 不传代表所有题型 0:投票 1:抢答 题型
sub_type int 0:选择题 1:判断题 2:问答题 题目类型
date string 日期,格式类似于:2019-10-10
page int 1 页数
page_size int 20 每页数据条数
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例/默认值 描述
id int 投票id
name string 题目标题
right_answer string 题目标题
question_type int 题型 0:投票 1:抢答
type int 题目类型 0:选择题 1:判断题 2:问答题
display_range string owner:本班展示 all:全班级展示
device_unique string 发起设备编号
school_zone_name string 出题设备校区名称
school_class_name string 出题设备班级名称
join_device array 加入互动的设备
join_class_student_list array 参加互动的学生班级信息
create_time string 创建时间

【返回示例】

{
    "code":0,
    "data":{
        "total":1,
        "list":[
            {
                "id":2544,
                "name":"投票选班长",
                "right_answer":"a",
                "question_type": 0,
                "type": 1,
                "display_range": "owner",
                "device_unique":"236C5C2F7D7459F2FFD8191D9562F0D8",
                "join_device":[
                    "王荣臣戴尔"
                ],
                "school_zone_name":北京,
                "school_class_name":"北京分校"
                "join_class_student_list": [
                    {
                        "class_info": {
                            "id": 123,
                            "class_name": "试听班级北京四中辽宁省编辑班级ajnjs",
                        },
                        "student_list": [
                            {
                                "name": "张三",
                                "student_number": 1245,
                                "mobile": 1234444444,
                                "answer": "A",
                                "create_time": "2019-11-23 11:11:12",
                                "student_type": 1, //0:正式,1:试听,2:转班,5:试听转正式 6:试听未完成
                            },
                        ]
                    }
                ],
                "create_time":"2019-08-29 11:28:02",
            }
        ]
    },
    "msg":"",
    "ts":1574325942
}

API 4: 获取班级红包数据

【请求地址】

http://hudong.baijiayun.com/openapi/interact_data/getRedPackageData

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
type int 不传代表所有红包类型 0:普通红包 1:拼手气红包 红包类型
date string 日期 格式类似于:2019-10-10
page int 1 页数
page_size int 20 每页数据条数
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例/默认值 描述
id int 投票id
name string 红包标题
type int 题目类型 0:普通红包 1:拼手气红包
room_id int room_id
total_money int 总金额
count int 红包个数
device_unique string 发起设备编号
school_zone_name string 发红包设备校区名称
school_class_name string 发红包设备班级名称
create_time string 时间
join_device array 加入互动的设备
join_class_student_list array 参加互动的学生班级信息

【返回示例】

{
    "code":0,
    "data":{
        "total":1,
        "list":[
            {
                "id":999,
                "name":"抢红包啦",
                "type":0,
                "room_id": 123467890,
                "total_money": 100,
                "count": 10,
                "device_unique":"B6592F052A22DF7AAC2289C7950E73F3",
                "create_time":"2019-11-06 16:00:45",
                "join_device":[
                    "王荣臣戴尔"
                ],
                "school_zone_name": 北京,
                "school_class_name":"北京分校",
                "join_class_student_list": [
                    {
                        "class_info": {
                            "id": 123,
                            "class_name": "试听班级北京四中辽宁省编辑班级ajnjs",
                        },
                        "student_list": [
                            {
                                "name": "张三",
                                "student_number": 1245,
                                "mobile": 1234444444,
                                "money": 123,
                                "create_time": "2019-11-23 11:11:12",
                                "student_type": 1,
                            },
                        ]
                    }
                ]
            }
        ]
    },
    "msg":"",
    "ts":1574330614
}

API 5: 获取班级随机点名数据

【请求地址】

http://hudong.baijiayun.com/openapi/interact_data/getRandomAskData

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
type int 不传代表所有点名类型,0:随机选班级 1:随机选学生 类型
date string 日期 格式类似于:2019-10-10
page int 1 页数
page_size int 20 每页数据条数
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例/默认值 描述
room_id int room_id
class_name string 教室名称
student_name string 学生名字
type int 0:随机选教室 1:随机选班级 点名类型
status int 0:初始状态 1:完成点名 2:放大视频 3:结束点名 第三方传过来的老师ID
create_time string 时间

【返回示例】

{
    "code":0,
    "data":{
        "total":1,
        "list":[
            {
                "room_id": 1234545345,
                "class_name": "xxxx",
                "student_name": "张三",
                "type": 1,
                "status": 1,
                "create_time": "2019-11-12 12:22:22"
            }
        ]
    },
    "msg":"",
    "ts":1574330614
}

API 6: 获取AI班级数人数列表

【请求地址】

http://hudong.baijiayun.com/openapi/interact_data/getAiUserCountData

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id bigint 教室id
date string 日期 格式类似于:2019-10-10
page int 1 页数
page_size int 20 每页数据条数
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例/默认值 描述
room_id int room_id
user_count int 点名人数
url string 教室截图url
status int 0:不支持 1:支持 状态
desc int 0:通过,1:软件版本不支持,2:硬件不支持,3:使用的不是虚拟摄像头,4:客户端错误 描述
create_time string 时间

【返回示例】

{
    "code":0,
    "data":{
        "total":1,
        "list": [
            {
                'class_img_list': [
                    {
                        "room_id": 1234545345,
                        "user_count": 123,
                        "url": "http://img.baijiayun.com/xx/xx.img",
                        "status": 1,
                        "desc": 1,
                        "create_time": "2019-11-12 12:22:22"
                    }
                ],
                'class_name': "双师教室名字"
            }
        ]
    },
    "msg":"",
    "ts":1574330614
}