查询直播场次记录
更新时间:2022-12-28
接口描述
根据开发者账号、直播间ID、时间范围等查询直播场次记录
说明:时间范围查询跨度不要超过1个月,历史数据只能查询近1年的数据
请求地址
https://ccapi.csslcloud.net/api/room/live/query
请求方式
GET
请求参数
接口统一权限认证请参考THQS认证方式。
名称 |
类型 |
必填 |
描述 |
userid |
String |
是 |
开发者账号ID |
roomid |
String |
是 |
直播间ID |
liveid |
String |
否 |
直播ID |
status |
Integer |
否 |
直播状态,取值说明:1为直播中,0为非直播中,该值不传默认查询所有状态,取值范围:[0,1] |
start_time |
String |
否 |
查询直播的开始时间(按开始直播时间),查询结果包含当前输入日期,格式:"yyyy-MM-dd ",示例:"2022-12-01" |
end_time |
String |
否 |
查询直播结束时间(按结束直播时间),查询结果包含当前输入日期,格式:"yyyy-MM-dd",示例:"2022-12-01" |
order |
String |
否 |
排序,按照直播开始时间排序,取值说明:ASC为升序,DESC为降序,默认为DESC |
page |
Integer |
否 |
第几页,默认1。取值范围:大于1的整数 |
lines |
Integer |
否 |
每页记录条数,默认50。取值范围:1~500整数 |
请求示例
GET https://ccapi.csslcloud.net/api/room/live/query?userid=41E8063FC799ACE&roomid=D90DCF5BF6DA3C8C9C33DC5901307461&time=1670412086&hash={hash}
返回数据
名称 |
类型 |
描述 |
result |
String |
返回状态,"OK":成功,"FAIL":失败 |
current |
Integer |
当前第几页 |
total |
Integer |
总的记录条数 |
lives |
Array |
直播列表记录 |
lives说明
名称 |
类型 |
描述 |
start_time |
String |
直播开始时间,格式:"yyyy-MM-dd HH:mm:ss" |
end_time |
String |
直播结束时间,格式:"yyyy-MM-dd HH:mm:ss" |
room_type |
Integer |
直播间类型,2:小班课,直播间类型只有2 |
live_id |
String |
直播ID |
userid |
String |
开发者账号ID |
live_roomid |
String |
直播间ID |
status |
Integer |
直播状态,取值说明:0为非直播中,1为直播中 |
返回示例
{
"result": "OK",
"lives": [
{
"room_type": 2,
"live_id": "EDDCB752CBF6306C",
"userid": "41E8063FC799ACE5",
"live_roomid": "D90DCF5BF6DA3C8C9C33DC5901307461",
"status": 0,
"start_time": "2020-02-26 14:27:58",
"end_time": "2020-02-26 14:37:00"
}
],
"total": 100,
"current": 1
}