查询直播间详情列表
更新时间:2022-12-28
接口描述
根据开发者账号、直播间名称、直播间状态分页查询直播间详情列表
请求地址
https://ccapi.csslcloud.net/openapi/room/list
请求方式
GET
请求参数
接口统一权限认证请参考THQS认证方式。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
accountId | String | 是 | 开发者账号ID |
name | String | 否 | 直播间名称,取值范围:1~200字符 |
roomStatus | Integer | 否 | 直播间状态:10为正常,20为关闭,默认不传查询全部状态,取值范围:[10,20] |
roomId | String | 否 | 直播间ID |
liveStatus | String | 否 | 直播状态:1为直播中,0为未直播,如查询直播间信息列表需要根据直播状态过滤可使用此参数,说明:查询状态为未直播时未开启过直播过的直播间不会查出来,取值范围:[0,1] |
page | Integer | 否 | 第几页,默认1,取值范围:大于1的整数 |
lines | Integer | 否 | 每页记录条数,默认50,取值范围:1~500整数 |
请求示例
GET https://ccapi.csslcloud.net/openapi/room/list?accountId=41E8063FC799ACE&roomStatus=10&time=1670412086&hash={hash}
返回数据
名称 | 类型 | 描述 |
---|---|---|
result | String | 返回状态,"OK":成功,"FAIL":失败 |
current | Integer | 当前第几页 |
total | Integer | 总的记录条数 |
rooms | Array | 直播间详情列表 |
rooms说明
rooms字段说明详见 直播间通用字段说明
返回示例
{
"result": "OK",
"rooms": [
{
"schedule_switch": 0,
"third_page_auth": 0,
"classover_tips": "下课时间要到啦,请注意授课节奏。",
"translate": 0,
"support_camera": 0,
"roomid": "9BCB274153BAA9F29C33DC5901307461",
"createtime": "2022-12-07 10:45:21",
"live_roomid": "9BCB274153BAA9F29C33DC5901307461",
"talker_authtype": 1,
"userid": "119FA1480CB3EBAF",
"manual_record": 0,
"allow_chat": true,
"auto_up": 1,
"class_no": 10199339,
"assist_pass": "454516",
"presenter_url": "https://class.csslcloud.net/index/presenter/?roomid=9BCB274153BAA9F29C33DC5901307461&userid=119FA1480CB3EBAF&role=presenter&template=32",
"live_status": 0,
"schedule_live_start": null,
"talker_url": "https://class.csslcloud.net/index/aul/?roomid=9BCB274153BAA9F29C33DC5901307461&userid=119FA1480CB3EBAF&role=aul&template=32",
"third_page_url": null,
"presenter_client_url": "",
"assist_switch": 1,
"assist_url": "https://class.csslcloud.net/index/assistant/?roomid=9BCB274153BAA9F29C33DC5901307461&userid=119FA1480CB3EBAF&role=assistant&template=32",
"inspector_pass": "572226",
"closetime": null,
"classover_time": 5,
"if_main": 1,
"allow_all_presenter_role": 0,
"layout_mode": 0,
"toolbox_switch": "1,2,3,4,5,6,7,8,9",
"third_page_name": null,
"templatetype": 32,
"desc": "",
"allow_speak": true,
"audience_authtype": 1,
"calltimeout": 10,
"name": "大直播间测试003",
"publisher_authtype": 1,
"room_source": 1,
"version_control_id": "90221d2b05a74be0b4d1",
"talker_pass": "249095",
"version_control_type": 1,
"assist_authtype": 1,
"create_user_id": "119FA1480CB3EBAF",
"inspector_authtype": 1,
"viewer_authtype": 1,
"classtype": 3,
"classover_time_open": 0,
"record_switch": 0,
"local_record_resolution": 480,
"schedule_live_end": null,
"room_mode": 1,
"big_room": 2,
"room_type": 2,
"max_resolution": 240,
"show_exit": 1,
"share_desktop_display": 1,
"presenter_out": false,
"ppt_display": 0,
"light_mark": 0,
"ppt_support": true,
"max_streams": 4,
"mergetype": 2,
"white_list": null,
"status": 10,
"background_id": 1,
"inspector_url": "https://class.csslcloud.net/index/inspector/?roomid=9BCB274153BAA9F29C33DC5901307461&userid=119FA1480CB3EBAF&role=inspector&template=32",
"allow_audio": true,
"brush_save_display": 1,
"recordstudent": 1,
"publisherpass": "123",
"max_users": 700,
"warm_open": "0",
"audience_pass": "834994",
"video_mode": 1,
"talker_audio": 1,
"stream_merge_type": 1,
}
],
"current": 1,
"total": 1
}