获取直播间用户列表API接口文档

公共信息

版本：v.1.0.1

最后修改日期：2021-06-26

API系统加密方式：THQS加密

如果请求失败，将返回错误信息，其中错误码可以快速定位问题，建议提供错误码排查问题。

其中常见的错误码如下：

错误码	描述	备注
1001	参数错误	检查传入参数是否正确
1002	加密错误	THQS加密错误
10000	直播间状态错误	确认直播间状态是否正常
其他值	系统错误	联系客服解决

API接口

搜索在线用户信息

基本信息

接口地址： http://api.csslcloud.net/api/room/search/user

Method： GET

接口描述：

搜索结果最多返回300条，超过300条，随机返回300条。

---

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		用户id
roomId	是		直播间id
type	是	1,2	1---根据用户id查询，2---根据用户名查询
value	是		用户id或则用户名值

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	string	非必须		ok
roomId	string	非必须		直播间id 例如：65D7B4A31BCE76049C33DC5901307461
userNum	number	非必须		获取查询结果总数 例如：10
onlineUsers	object []	非必须		在线用户信息	item 类型: object
├─ id	string	必须		用户idf29d00aeda445a795123013b2c0b1e7
├─ name	string	必须		用户姓名：liuyang
├─ role	string	必须		角色：teacher
├─ ip	string	必须		客户端ip：192.168.2.232
├─ platform	string	必须		平台1.
├─ terminal	string	必须
├─ groupId	string	必须

直播间在线用户列表

基本信息

接口地址： http://api.csslcloud.net/api/room/userslist

Method： GET

接口描述：

获取当前直播间用户列表，最多返回300人，在线人数超过300人，随机返回300人。

---

请求参数

Query

参数名称	是否必须	示例	备注
accountId	是		帐号id
roomId	是		直播间id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
result	string	非必须		ok
roomId	string	非必须		直播间id
userNum	number	非必须		获取当前直播间用户个数
onlineUsers	object []	非必须		在线用户信息	item 类型: object
├─ id	string	必须		学员id
├─ name	string	必须		学员姓名
├─ role	string	必须		角色
├─ ip	string	必须		ip地址
├─ platform	string	必须
├─ terminal	string	必须
├─ groupId	string	必须