产品文档 直播技术文档 双师直播服务端API接口

双师直播服务端API接口

概述

本文档为百家云双师课堂直播服务端的API文档,用户可以通过文档中提供的API接口创建及管理直播间,导出直播数据信息等。

注:百家云双师课堂API仅提供基础数据,客户须将数据同步到自己数据库(DB)后,通过自己的数据库(DB)来实现业务需求。

基本约定

常见基本约定以及平台术语见下表:

内容 约定
请求协议 HTTPS
请求类型 GET/POST
参数提交方式 application/x-www-form-urlencodedmultipart/form-data
返回数据格式 json
字符编码 UTF8
接口域名 https://${private_domain}.at.baijiayun.com/
${private_domain} 个性域名
partner_id 账号的ID, 由百家云平台分配,用户可以登录百家云网站后台查看
partner_key 账号的密钥,由百家云平台分配,用于计算服务端API接口的签名,用户可以登录百家云网站后台获取

说明:文档中的数字统一用int表示,即无符号的64位整数,取值范围是2^0~2^63;

使用流程

合作方接入百家云开放平台直播有如下几个步骤:

  1. 注册账号
    • 注册后可以登录百家云后台获取partner_idpartner_key
  2. 创建房间
    • 根据百家云提供的API接口创建和管理房间
  3. 进入房间
    • 根据百家云提供的地址或接入百家云SDK进入教室
  4. 获取统计数据
    • 使用数据统计相关的接口可以导出直播用户的统计数据

接口规范

公共请求参数:

参数 类型 示例 参数说明
partner_id int 12345678 合作方账号ID
timestamp int 1505372499 unix时间戳,当前的秒数,10位长的数字(注:不是毫秒)
sign string e10adc3949ba59abbe56e057f20f883e 根据partner_key和请求参数计算的签名,32位的小写字母或数字

公共返回参数如下:

参数 类型 示例 参数说明
code int 1001 错误码,对应的错误原因参见错误码表
msg string 签名错误 错误原因描述
data json 返回的数据,出错时返回的data为null

个性域名

百家云给每个账号都分配了一个个性域名,客户调用服务端API接口、对接客户端SDK的时候,都需要用到这个个性域名。

个性域名可以登录百家云后台,在账号信息页面查看。

成为付费客户后,可以申请修改该个性域名(只能个性一次,修改后不可再更改)。

以下服务端的接口,都是调自己个性域名下的接口。

例如:个性域名是demo123,则所有的服务端API请求的域名为:https://demo123.at.baijiayun.com/

为方便理解,以下接口中的个性域名,都用${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

例如,创建房间的接口需要以下参数:

partner_id=12345678
title=测试教室
start_time=1501575608
end_time=1501579208
type=5

partner_key=rLkIPaQjxSwRQmC/ITnHh8i2rifmmbFIVsYw03SSi24zAnkrAd0ZNb2rcTzI2avy7+AmNJDdLmzU89zKUAP3Xg==

以上参数排序后的顺序为:

end_time=1501579208
partner_id=12345678
start_time=1501575608
timestamp=1501572288
title=测试教室
type=5

按以上顺序拼接的字符串为:

end_time=1501579208&partner_id=12345678&start_time=1501575608×tamp=1501572288&title=测试教室&type=5

再拼上partner_key后的字符串为:

end_time=1501579208&partner_id=12345678&start_time=1501575608×tamp=1501572288&title=测试教室&type=2&partner_key=rLkIPaQjxSwRQmC/ITnHh8i2rifmmbFIVsYw03SSi24zAnkrAd0ZNb2rcTzI2avy7+AmNJDdLmzU89zKUAP3Xg==

最后算出来32位的小写的md5值为:

70d60aca82bedd5a10a64247c3d464b1

示例代码(php)

<?php

/**
 * 生成签名参数
 * 
 * @param array $params 请求的参数
 * @param string $partner_key 
 * @return string 生成的签名
 */
function getSign($params, $partner_key) {
    ksort($params);//将参数按key进行排序
    $str = '';
    foreach ($params as $k => $val) {
        $str .= "{$k}={$val}&"; //拼接成 key1=value1&key2=value2&...&keyN=valueN& 的形式
    }
    $str .= "partner_key=" . $partner_key; //结尾再拼上 partner_key=$partner_key
    $sign = md5($str); //计算md5值
    return $sign;
}

$params =  [
    "partner_id" => 12345678,
    "title" => "测试教室",
    "start_time" => 1501575608,
    "end_time" => 1501579208,
    "type" => 5,
    "timestamp" => 1501572288,
]

$partner_key = 'rLkIPaQjxSwRQmC/ITnHh8i2rifmmbFIVsYw03SSi24zAnkrAd0ZNb2rcTzI2avy7+AmNJDdLmzU89zKUAP3Xg==';
$sign = getSign($params, $partner_key);

API列表

API 1 : 获取/重置partner_key

【功能描述】

初始的partner_keysecret_key都可登录百家云后台获取。

此接口可用于重置partner_key

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/partner/createkey

【请求参数】

参数 类型 是否必填 默认值 参数说明
partner_id int 合作方账号ID,在百家云账号后台可以查询
secret_key string 合作方用于更新partner_key的密钥(由开放平台提供给合作方)
regenerate int 0 为1时表示强制重新生成partner_key(默认情况下返回当前已经存在的partner_key
timestamp int 当前unix时间戳(秒)
sign string 签名

【返回参数】

参数 类型 示例 说明
partner_key string partner_key长度不超过128位

【请求示例】

curl -d "partner_id=12345678&secret_key=e10adc3949ba59abbe56e057f20f883e" https://${private_domain}.at.baijiayun.com/openapi/partner/createkey

【返回示例】

{
      "code": 0,
      "data": {
          "partner_key": "rLkIPaQjxSwRQmC/ITnHh8i2rifmmbFIVsYw03SSi24zAnkrAd0ZNb2rcTzI2avy7+AmNJDdLmzU89zKUAP3Xg=="
      },
      "msg":""
}

API 2 : 创建房间

【功能描述】

创建房间

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/create

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
title string 直播课标题,不超过50个字符或汉字,超过部分将进行截取
start_time int 开课时间, unix时间戳(秒)
end_time int 下课时间, unix时间戳(秒)
type int 5 双师默认为5
industry_type int 0 0:表示教育
max_users int 0 代表双师班课最大人数, 不传或传0表示不限制
pre_enter_time int 学生班级可提前进入的时间,单位为秒
is_long_term int 0 是否是长期房间,0:普通房间(注:普通房间时长小于24小时) 1:长期房间 默认为普通房间(注:需要给账号开通长期房间权限才可以创建长期房间)
speak_camera_turnon int 1 双师默认为 1
timestamp int 当前unix时间戳(秒)
sign string 签名
is_webrtc_live int 是否是webrtc课程,1:是(需要联系百家云配置webrtc类型才可使用)

注意:

非长期房间,结束时间与开始时间间隔需大于15分钟并小于24小时,开始时间和结束时间范围必须在当前时间一年以内。

【返回参数】

参数 类型 示例 描述
room_id string 12345678901234 房间ID,14位的数字
admin_code string abdce2 管理员进入房间的参加码
teacher_code string 13rlkk 老师进入房间的参加码
student_code string abc213 学生教室公共参加码,该参加码可以进多个学生教室,不互踢

注意:

  1. 参加码是一种快速进入房间的形式,合作方可以通过参加码和昵称直接进入直播间。
  2. 参加码为6位,由字母和数字组成。

【请求示例】

curl -d "end_time=1464343200&partner_id=123456789&start_time=1464314400×tamp=1464313928&title=test&type=2&sign=e10adc3949ba59abbe56e057f20f883e" https://${private_domain}.at.baijiayun.com/openapi/room/create

【返回示例】

{
    "code": 0,
    "data": {
        "room_id": "12345678901234",
        "admin_code": "213rjl",
        "teacher_code": "232kj1",
        "student_code": "abc213"
    },
    "msg":""
}

API 3 : 更新房间信息

【功能描述】

更新房间信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/update

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
room_id int 房间ID,14位
title string 房间标题
start_time int 开课时间, unix时间戳(秒)
end_time int 结束时间, unix时间戳(秒)
max_users int 房间最大班级数, 不传或传0表示不限制。
pre_enter_time int 学生可提前进入的时间,单位为秒
timestamp int 当前时间,unix时间戳(秒)
sign string 请求接口参数签名

【返回参数】

返回code为0时表示更新成功,返回code非0表示更新失败,失败原因在msg中返回。

【返回示例】

成功情况下:

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

API 4 : 删除房间

【功能描述】

删除一个房间

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/delete

【接口参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
room_id int 房间id
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

返回code为0时表示删除成功,返回code非0表示删除失败,失败原因在msg中返回。

【返回示例】

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

API 5 : 获取房间信息

【功能描述】

获取房间信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/info

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
room_id int 房间id
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
room_id int 12345612345699 房间id
title string 英语语法在线 直播课标题
start_time datetime 2017-08-18 14:00:00 开课时间,格式如:2017-08-18 14:00:00
end_time datetime 2017-08-18 15:00:00 结束时间,格式如:2017-08-18 14:00:00
type int 5 双师课堂
max_users int 0 直播间允许的最大班级数
admin_code string abc123 管理员进入直播间的参加码
teacher_code string 123abc 老师进入直播间的参加码

【返回示例】

{
    "code": 0,
    "data": {
        "room_id": 17081862531088,
        "title": "长期课长期课",
        "start_time": "2017-08-18 14:10:00",
        "end_time": "2027-08-18 14:10:00",
        "type": "2",
        "max_users": "0",
        "admin_code": "u9vnnb",
        "teacher_code": "zyh5pa"
    },
    "msg": "",
    "ts": 1505382011
}

API 6 : 生成学生教室参加码

【功能描述】

为了方便学生教室进入房间,我们可以根据学生教室的user_number生成学生教室参加码。

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/getcode

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方ID
room_id int 房间ID
user_number int 合作方账号体系下的用户ID号,必须是数字
user_avatar string 学生教室头像,需要完整的url地址
timestamp int 当前时间, unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
student_code string 12ed45 学生参加码

说明:

  1. 参加码不会重复,长度为6位
  2. 一个学生教室参加码唯一对应了一个room_iduser_number
  3. user_number为0时,所有学生教室可使用该通用邀请码。
  4. user_number非0时,同一个学生教室邀请码只支持一个班级同时在线。后进的教室将之前进的教室挤下线。

【返回示例】

{
    "code": 0,
    "data": {
        "student_code": "abc123"
    },
    "msg":""
}

API 7 : 获取学生教室参加码信息

【功能描述】

获取参加码信息

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/getCodeInfo

【请求参数】

参数 类型 示例 描述
code string 12ed45 学生教室参加码

【返回参数】

参数 类型 是否必填 默认值 描述
exist bool 参加码是否存在,为true进code_info才有值
code_info.code string
code_info.room_id int 房间ID
code_info.user_number int
code_info.user_role int
code_info.user_name string
code_info.create_time datetime 参加码生成时间

【返回示例】

{
    "code": 0,
    "data": {
        "exist": true,
        "code_info": {
            "code": "uvrv4c",
            "room_id": 18121196070275,
            "user_number": 960702751,
            "user_role": 1,
            "create_time": "2018-12-11 16:12:32"
        }
    },
    "msg": "",
    "ts": 1545049343
}

API 8 : 获取已生成的参加码列表

【功能描述】

获取已经生成的学生教室参加码列表

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/listcode

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方ID
room_id int 房间ID
type int 0 0表示普通参加码 1表示试听参加码
page int 1 页数,参加码数量过多时,可以分多页来获取,每页取limit条。默认值为1
limit int 100 每页获取的条数,默认值100,最大值不能超过1000
timestamp int 当前时间, unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
total int 101 该房间总共的学生教室参加码数
student_code string 12ed45 学生教室参加码
user_number int 123456 参加码对应的学生教室ID号
user_avatar string https://xxx.png 生成参加码时传的教室头像

【返回示例】

{
    "code": 0,
    "data": {
        "total": 3,
        "list": [
            {
                "code": "kbvt9t",
                "user_number": "11",
                "user_avatar": ""
            },
            {
                "code": "xvxavp",
                "user_number": "10",
                "user_avatar": ""
            },
            {
                "code": "2crrly",
                "user_number": "0",
                "user_avatar": ""
            }
        ]
    },
    "msg": "
}

API 9 : 获取房间列表

【功能描述】

获取已经创建的房间列表

【请求类型】

POST

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room/list

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方ID
page int 1 页数,参加码数量过多时,可以分多页来获取,每页取limit条。默认值为1
limit int 100 每页获取的条数,默认值100,最大值不能超过1000
product_type int 0 1:教育直播
timestamp int 当前时间, unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
room_id int 12345678901234 房间ID
title string 英语语法在线 直播课标题
start_time int 1460426400 开始时间, unix时间戳
end_time int 1460426400 结束时间, unix时间戳
create_time int 1460426400 创建时间, unix时间戳
type int 5 双师为5
max_users int 20 代表教室内最大班级数
admin_code string abc123 管理员进入房间的参加码
teacher_code string 123abc 老师进入房间的参加码
student_code string 321abc 学生教室进入房间的参加码
industry_type int 0 0:表示教育

【返回示例】

{
    "code": 0,
    "data": {
        "list": [
            {
                "room_id": "17091462522904",
                "title": "直播培训",
                "type": "2",
                "max_users": "1",
                "start_time": 1505361000,
                "end_time": 1505364600,
                "create_time": 1505360825,
                "teacher_code": "7782s9",
                "admin_code": "dkn3wd",
                "student_code": "hfaaqq"
            },
            {
                "room_id": "17091358328329",
                "title": "测试标题",
                "type": "2",
                "max_users": "1",
                "start_time": 1505291100,
                "end_time": 1505294700,
                "create_time": 1505290999,
                "teacher_code": "aca2qv",
                "admin_code": "j5e74u",
                "student_code": "bry9wk"
            }
        ]
    },
    "msg": "",
    "ts": 1505390707
}

API 10 : 获取直播教室当前上课状态

【功能描述】

获取直播教室当前的上下课状态

【请求类型】

POST/GET

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live/getLiveStatus

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id int 教室号
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
status int 0 1:上课中 0:不在上课中

【返回示例】

{
    "code": 0,
    "data": {
        "status": 1
    },
    "msg": "",
    "ts": 1488856764
}

API 11 : 获取老师是否在教室状态

【功能描述】

当前老师是否在教室的状态

【请求类型】

POST/GET

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live/getTeacherOnlineStatus

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id int 教室号
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
status int 0 1:在教室 0:不在教室

【返回示例】

{
    "code": 0,
    "data": {
        "status": 1
    },
    "msg": "",
    "ts": 1488856764
}

API 12 : 获取当前时间教室数

【功能描述】

获取当前时间教室数

【请求类型】

POST/GET

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live/getUserCount

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id int 教室号
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
user_count int 3 房间当前学生教室数
display_user_count int 3 显示出来教室数

【返回示例】

{
    "code": 0,
    "data": {
        "user_count": 2,
        "display_user_count": 2
    },
    "msg": "",
    "ts": 1489753512
}

API 13 : 导出直播间学员教室观看记录

【功能描述】

导出直播间学生教室观看记录。

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room_data/exportLiveReport

【请求类型】

GET/POST

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方用户名
room_id int 教室号
type string student 可选值 all:所有用户 student:学生教室 teacher:老师 admin:助教,默认只导出学员教室观看记录
page int 1 分页参数
page_size int 0 每页返回条数,如果不传则返回所有的
date string 0 查询日期,格式如:2018-03-02
timestamp int 当前时间,unix时间戳
sign string 签名

【返回参数】

参数 类型 示例 描述
date string 日期
user_number int 用户的ID号
user_name string 昵称
user_role int 0:学生 1:老师 2:助教
first_time datetime 最早进入教室时间
last_time datetime 最晚离开教室时间
first_heartbeat_time datetime 上课状态下,最早在教室的时间
last_heartbeat_time datetime 上课状态下,最晚在教室的时间
actual_listen_time int 实际听课时长,指上课状态下,学生教室在直播间的时间,多次进出教室情况是把每一小段时间累加(单位秒)
user_ip string 用户IP
area string 用户所属省份
city string 用户所属城市
network_operator string 使用的网络运营商
group_id int 在教室中的分组
client_type int 0:PC网页 1:pc客户端 2:m站 3:ios 4:android 5:mac客户端 6:微信小程序
is_audition int 0:非试听 1:试听

【返回示例】

{
    "code": 0,
    "data": {
        "total": 2,
        "room_user_info": [
            {
                "date": "2018-03-02",
                "user_number": 151134006392569,
                "user_name": "iOS",
                "user_role": 0,
                "first_time": "2017-11-23 11:47:09",
                "last_time": "2017-11-23 11:47:15",
                "first_heartbeat_time": "",
                "last_heartbeat_time": "",
                "actual_listen_time": 0,
                "user_ip": "61.50.136.186",
                "network_operator": "联通",
                "client_type": 3,
                "area": "北京",
                "city": "北京",
                "group_id": 1,
                "is_audition": 1
            },
            {
                "date": "2018-03-02",
                "user_number": 91170602,
                "user_name": "晨晨",
                "user_role": 1,
                "first_time": "2017-11-23 11:48:07",
                "last_time": "2017-11-23 13:35:42",
                "first_heartbeat_time": "",
                "last_heartbeat_time": "",
                "actual_listen_time": 0,
                "user_ip": "61.50.136.186",
                "network_operator": "联通",
                "client_type": 1,
                "area": "北京",
                "city": "北京",
                "group_id": 2,
                "is_audition": 0
            }
        ]
    },
    "msg": "",
    "ts": 1511427372
}

API 14 : 获取指定日期所有的直播间人次和最高并发量

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room_data/getAllRoomUserStat

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
product_type int 1:教育直播
date string 格式如:2017-11-23
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例/默认值 描述
room_id int 教室号
total_user_count int 总人次(包括学生、老师、助教)
student_count int 学生教室人次
peak_user int 峰值人数(包含老师和助教)

【响应示例】


{ "code": 0, "data": { "room_user_stat": { "17072641561616": { "room_id": 17072641561616, "student_count": 1, "total_user_count": 1, "peak_user": 1 }, "17112279047985": { "room_id": 17112279047985, "student_count": 2, "total_user_count": 2, "peak_user": 1 }, "17112374903200": { "room_id": 17112374903200, "student_count": 0, "total_user_count": 7, "peak_user": 3 } } }, "msg": "", "ts": 1511487411 }

API 15: 获取指定房间一段时间内的并发量

【接口描述】

该接口用于获取一段时间内教室的并发人数变化图。由于数据量较大,本接口每10分钟取一个最大值。

如果:15:10:00 => 3 表示的是 15:10:00~15:19:59 这段时间内的最高并发数为3

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/room_data/getRoomPeakUser

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
room_id int 教室号
start_time string 格式如:2017-11-23 10:00:00
end_time string 格式如:2017-11-23 15:00:00,查询时间范围不能跨天
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例/默认值 描述
date date 日期
peak_user dict key是时间,value是峰值人数。

【响应示例】

{
    "code": 0,
    "data": {
        "date": "2017-12-07",
        "peak_user": {
            "15:00:00": 3,
            "15:10:00": 3,
            "15:20:00": 1,
            "15:30:00": 1,
            "15:40:00": 1,
            "15:50:00": 1,
            "16:00:00": 1,
            "16:10:00": 1,
            "16:20:00": 1,
            "16:30:00": 1,
            "16:40:00": 1,
            "16:50:00": 1,
            "17:00:00": 1
        }
    },
    "msg": "",
    "ts": 1512718993
}

API 16 : 获取账号一天中每小时最高并发量

【接口描述】

该接口用于获取账号一天中每小时的并发量

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_account/getHourPeakUser

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
product_type int 0 1:教育直播
date string 查询日期,格式如:2017-12-12
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例/默认值 描述
peak_user dict key是小时,value是峰值人数。

【响应示例】


{ "code": 0, "data": { "peak_user": { "00": 0, "01": 0, "02": 0, "03": 0, "04": 0, "05": 0, "06": 0, "07": 0, "08": 0, "09": 0, "10": 0, "11": 1, "12": 1, "13": 1, "14": 3, "15": 3, "16": 2, "17": 0, "18": 0, "19": 0, "20": 1, "21": 1, "22": 0, "23": 0 } }, "msg": "", "ts": 1514899076 }

API 17 : 查询账号一段时间内每天的最高并发量

【接口描述】

该接口用于获取账号一段时间内每天的最高并发量

【请求地址】

https://${private_domain}.at.baijiayun.com/openapi/live_account/getDayPeakUser

【请求参数】

参数 类型 是否必填 默认值 描述
partner_id int 合作方id
product_type int 0 1:教育直播
start_date string 查询起始日期,格式如:2017-12-12
end_date string 查询结束日期,格式如:2017-12-28
timestamp int 当前时间,unix时间戳
sign string 签名

【响应参数】

参数 类型 示例/默认值 描述
peak_user dict key是日期,value是峰值人数。

【响应示例】

{
    "code": 0,
    "data": {
        "peak_user": {
            "2017-12-12": 3,
            "2017-12-13": 1,
            "2017-12-14": 0,
            "2017-12-15": 0,
            "2017-12-16": 0,
            "2017-12-17": 0,
            "2017-12-18": 0,
            "2017-12-19": 0,
            "2017-12-20": 0,
            "2017-12-21": 0,
            "2017-12-22": 1,
            "2017-12-23": 0,
            "2017-12-24": 0,
            "2017-12-25": 1,
            "2017-12-26": 0,
            "2017-12-27": 0,
            "2017-12-28": 2
        }
    },
    "msg": "",
    "ts": 1514899332
}