产品文档 双师技术文档 双师课堂创建互动成员接口

概述

本文档用于描述百家云双师课堂创建互动成员接口

API 1:双师人员数据保存

【接口描述】

客户使用的新排课系统,数据接入到双师系统中

【接口链接】

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

【请求参数】

参数 类型 是否必填 实例 解释
assist_teacher_id int 客户助教id
assist_teacher_name string 助教姓名
assist_teacher_mobile string 助教电话
class_id int 客户班级 id
class_name string 班级名称
student_list string [{'student_id' : 1, 'student_name' : 'test', 'student_mobile' : 1233443, 'student_sex' : 1, 'student_sn' : ‘1’, 'student_type' : 1}] 学生明细内容
origin string huatu
partner_id int partner_id
timestamp int
sign int

【student_list字段描述】

[
    {
        "student_id":1,
        "student_name":"test",
        "student_mobile":"1242342",
        "student_sex":1,
        "student_sn":'12',
        "student_type":1
    },
    {
        "student_id":2,
        "student_name":"test",
        "student_mobile":"1242342",
        "student_sex":1,   1:男 2:女
        "student_sn":'12',
        "student_type":1   0:正式 1:试听
    }
]

【返回参数】

参数 类型 注释
assist_teacher_list json 对应管学师信息
class_list json 对应班级信息
student_list json 对应学生信息

【返回示例】

{
    "code": 0,
    "data": {
        "assist_teacher_list": {
            "assist_teacher_id": 2, 传过来的 assist_teacher_id
            "id": 87          返回 assist_teacher_id
        },
        "class_list": {
            "class_id": 3,          传过来的 class_id
            "id": 87    返回 class_id
        },
        "student_list": [
            {
                "student_id": 1, 传过来的 student_id
                "id": 1074  返回 student_id
            },
            {
                "student_id": 2,
                "id": 1075
            }
        ]
    },
    "msg": "",
    "ts": 1560853723
}

API 2:根据签到id,获取签到信息

【接口描述】

根据checkin_id,获取签到明细数据

【接口链接】

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

【请求参数】

参数 类型 是否必填 实例 解释
checkin_id int 签到id
partner_id int partner_id
timestamp int
sign int

【返回参数】

参数 类型 注释
op_user_mobile string 发起签到手机号
sign_time string 签到时间
room_id int 对应班级信息
begin_time string 开始时间
class_name string 班级名称
class_id int 教室 id
student_list json 学生列表

【student_list字段描述】

 [
    {
        "mobile": "19900000001", 学生手机号
        "name": "后羿", 学生姓名
         "student_id": 0,  学生第三方 id
         "id": 953,   学生 id                    
        "is_checkin": 1 是否签到 0:未签到 1 已签到
    },
    {
         "mobile": "19900000002",        
         "name": "蔡文姬",
         "student_id": 0,
         "id": 959,
          "is_checkin": 0            
     }
]

【返回示例】

{
    "code": 0,
    "data": {
        "op_user_mobile": "15910961087",
        "sign_time": "2019-06-18 15:21:37",
        "room_id": 19061341311888,
        "begin_time": "2019-06-13 18:15:00",
        "class_name": "试听班级北京四中辽宁省编辑班级ajnjs",
        "class_id": 0,
        "student_list": [
            {
                "mobile": "19900000001",
                "name": "后羿",
                "student_id": 0,
                "id": 953,
                "is_checkin": 1
            },
            {
                "mobile": "19900000002",
                "name": "蔡文姬",
                "student_id": 0,
                "id": 959,
                "is_checkin": 0
            }
        ]
    },
    "msg": "",
    "ts": 1560923164
}

API 3:删除班级、助教、学生信息

【接口描述】

根据 class_id,可以删除跟班级关联的学生、老师和班级信息

【接口链接】

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

【请求参数】

参数 类型 是否必填 实例 解释
class_ids string 1,2,3 班级 id
partner_id int
sign string
timestamp int

【返回参数】

参数 类型 是否必填 实例 解释
result bool 删除结果

【返回示例】

{
    "code": 0,
    "data": {
        "result": true
    },
    "msg": "",
    "ts": 1561358373
}

API 4:获取班级、助教、学生信息列表

【接口描述】

根据class_id, 获取班级,和关联班级的学生、老师

【接口链接】

hudong.baijiayun.com/openapi/interact_data/list

【请求参数】

参数 类型 是否必填 实例 解释
class_id int 1 班级 id
partner_id int
sign string
timestamp int

【返回参数】

参数 类型 实例 解释
class_info json 班级信息
student_info json 学生信息
teacher_info json 老师信息

【返回示例】

{
    "code": 0,
    "data": {
        "class_info": {
            "id": 139,
            "name": "班级62",
            "status": 0,
            "is_delete": 1,
            "create_time": "2019-06-24 11:55:41",
            "update_time": "0000-00-00 00:00:00",
            "class_id": 62
        },
        "student_info_list": [
            {
                "id": 1193,
                "student_id": 1,
                "student_name": "正式1",
                "student_mobile": "13099999999",
                "is_delete": 1,
                "create_time": "2019-06-24 11:55:41",
                "update_time": "2019-06-24 14:17:28",
                "sex": 1,
                "sn": 32432,
                "type": 0
            },
            {
                "id": 1194,
                "student_id": 3,
                "student_name": "正式2",
                "student_mobile": "13099999933",
                "is_delete": 1,
                "create_time": "2019-06-24 11:55:41",
                "update_time": "2019-06-24 14:17:28",
                "sex": 1,
                "sn": 32433,
                "type": 0
            }
        ],
        "teacher_info": {
            "id": 124,
            "teacher_id": 62,
            "teacher_name": "晨管62",
            "teacher_mobile": "15910961388",
            "is_delete": 0,
            "teacher_status": 0,
            "create_time": "2019-06-24 11:52:44",
            "update_time": "2019-06-24 14:40:29",
            "role": 2
        }
    },
    "msg": "",
    "ts": 1561366247
}

API 5:老师添加、修改接口

【接口描述】

增加和修改老师信息

【接口链接】

http://hudong.baijiayun.com/openapi/teacher/save

【请求参数】

参数 类型 是否必填 实例 解释
teacher_id int 客户老师id
teacher_name string 老师姓名
teacher_mobile string 老师电话
role int 1:老师 2:助教 老师角色
partner_id int
sign string
timestamp int

【返回参数】

参数 类型 是否必填 实例 解释
id int bjy老师id
teacher_id int 第三方老师 id
role int 老师角色
teacher_mobile string 老师手机
teacher_name string 老师姓名
status int 老师状态
create_time string 创建时间
update_time string 修改时间

【返回示例】

    {
    "code": 0,
    "data": {
        "id": 125,
        "role": 1,
        "teacher_id": 65,
        "teacher_mobile": "13099999999",
        "teacher_name": "232",
        "status": 0,
        "create_time": "2019-06-24 15:38:11",
        "update_time": "2019-06-24 15:38:11"
    },
    "msg": "",
    "ts": 1561361891
}

API 6:老师删除接口

【接口描述】

根据teacher_id,删除老师信息

【接口链接】

http://hudong.baijiayun.com/openapi/teacher/delete

【请求参数】

参数 类型 是否必填 实例 解释
teacher_id int 第三方老师id
role int 老师角色
partner_id int
sign string
timestamp int

【返回参数】

参数 类型 是否必填 实例 解释
teacher_id int 第三方老师id
id int 老师 id

【返回示例】

{
    "code": 0,
    "data": {
        "id": 122,
        "teacher_id": 60
    },
    "msg": "",
    "ts": 1561362346
}

API 7:获取老师信息接口

【接口描述】

获取老师列表

【接口链接】

http://hudong.baijiayun.com/openapi/teacher/list

【请求参数】

参数 类型 是否必填 实例 解释
role int 老师角色
page int 1 页码
page_size int 10 每页条数
partner_id int
sign string
timestamp int

【返回参数】

参数 类型 是否必填 实例 解释
teacher_id int 第三方老师id
id int bjy 老师 id
teacher_mobile string 老师电话
teacher_name string 老师姓名
role int 老师角色
status int 老师状态
create_time string 老师创建时间
update_time string 老师修改时间

【返回示例】

{
    "code": 0,
    "data": {
        "total": 5,
        "page": 1,
        "page_size": 2,
        "list": [
            {
                "id": 124,
                "teacher_id": 62,
                "teacher_mobile": "15910961388",
                "teacher_name": "晨管62",
                "role": 2,
                "status": 0,
                "create_time": "2019-06-24 11:52:44",
                "update_time": "2019-06-24 14:40:29"
            },
            {
                "id": 123,
                "teacher_id": 61,
                "teacher_mobile": "15910961288",
                "teacher_name": "晨管61",
                "role": 2,
                "status": 0,
                "create_time": "2019-06-24 11:52:28",
                "update_time": "2019-06-24 11:52:28"
            }
        ]
    },
    "msg": "",
    "ts": 1561362748
}

API 8:修改回调地址

【接口描述】

修改回调地址

【接口链接】

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

【请求参数】

参数 类型 是否必填 实例 解释
callback_url string 回调地址
partner_id int
sign string
timestamp int

【返回示例】

{
    "code": 0,
    "data":null,
    "msg": "",
    "ts": 1561441759
}

回调接口

1. 签到回调接口

【接口描述】

如果合作方提供了回调地址,当管学师保存签到后,可以回调通知合作方。

回调机制:每两分钟进行一次回调,当前保存的签到不会立刻回调,在两分钟左右会完成回调

【请求类型】

POST

【回调参数】

参数 类型 必填 示例 描述
check_id int 123 签到id

【返回标准】

合作方接收后应返回一段json,包含一个code,0表示成功,非0表示失败,

【成功示例】

{
    "code": 0,
    "msg":""
}