查询直播间人员列表

更新时间：2022-12-28

V2版本

接口描述

根据直播间ID查询人员列表

请求地址

 https://ccapi.csslcloud.net/openapi/v1/room/user-list

请求方式

GET

请求参数

接口统一权限认证请参考THQS认证方式。

名称 类型 必填 描述
accountId String 是 开发者账号ID
roomId String 是 直播间ID
type Integer 否 类型：0为连麦列表，1为学员列表(主要用于直播间容量为大直播间使用)，默认为0，取值范围[0,1]
pageNum Integer 否 第几页，默认1，取值范围：大于1的整数
pageSize Integer 否 每页记录条数，默认100，取值范围：1~700整数

请求示例

GET https://ccapi.csslcloud.net/openapi/v1/room/user-list?accountId=41E8063FC799ACE&roomId=9BCB274153BAA9F29C33DC5901307461&time=1670412086&hash={hash}

返回数据

公共返回数据结构请参考 公共返回数据说明。

名称 类型 描述
total Integer 总记录条数
list Array 人员信息列表

list说明

名称 类型 描述
id String 用户ID
ip String 访问ip地址
joinTime String 加入直播间时间
name String 用户名称
platform String 访问终端：2为android，3为ios，5为web，0为未知
role String 角色：presenter为讲师，talker为学员，inspector为隐身者，assistant为助教

返回示例

{
    "result": "OK",
    "error": null,
    "data": {
        "total": 1,
        "list": [
            {
                "id": "3NzmDacOh7damvpg",
                "name": "11",
                "platform": 5,
                "ip": "103.90.191.98",
                "role": "presenter",
                "joinTime": "2022-12-14 15.59.17"
            }
        ]
    },
    "errorMsg": ""
}

V1版本

接口描述

根据直播间ID查询人员列表
说明：该接口不支持查询直播间容量为大直播间类型人员信息

请求地址

 https://ccapi.csslcloud.net/api/v1/room/user/list

请求方式

GET

请求参数

接口统一权限认证请参考THQS认证方式。

名称 类型 必填 描述
userid String 是 开发者账号ID
roomid String 是 直播间ID

请求示例

GET https://ccapi.csslcloud.net/api/v1/room/user/list?userid=41E8063FC799ACE&roomid=9BCB274153BAA9F29C33DC5901307461&time=1670412086&hash={hash}

返回数据

公共返回数据结构请参考 公共返回数据说明。

名称 类型 描述
presenter Integer 讲师人数
assistant Integer 助教人数
total Integer 总人数
users Array 人员信息列表

users说明

名称 类型 描述
avatar String 头像图片，地址扩展字段目前为空
id String 用户ID
ip String 访问ip地址
joinTime String 加入直播间时间
name String 用户名称
platform String 访问终端：2为android，3为ios，5为web，0为未知
role String 角色：presenter为讲师，talker为学员，inspector为隐身者，assistant为助教
status String 连麦状态：0为初始状态，1为排麦中(待确认)，2:为排麦中(已确认)，3为推流中，4为邀请举手，5为助教预上麦
streamId String 流ID
publishTime String 开始推流时间
requestTime String 请求时间

返回示例

{
  "data": {
    "presenter": 1,
    "assistant": 0,
    "users": [
      {
        "streamId": "",
        "name": "test",
        "platform": "5",
        "ip": "103.90.191.98",
        "role": "presenter",
        "avatar": "",
        "publishTime": "",
        "joinTime": "2022-12-14 15.45.17",
        "status": "0",
        "requestTime": "",
        "lock": "false",
        "id": "kbrqzDzwidtQO6O7",
        "uid": "2057469530"
      }
    ],
    "total": 1
  },
  "result": "OK"
}

results matching ""

    No results matching ""