服务端 API v2
  • API概览
  • 快速开始
  • 调用方式
  • 房间信令接口
  • 混流转码接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 场景服务接口
  • 回调说明
  • 全局返回码
  • 使用 Postman 调试
  • 文档中心
  • 服务端 API v2
  • 房间信令接口
  • 获取房间人数

获取房间人数

更新时间:2023-07-12 22:00

1 描述

调用本接口获取房间人数。

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=DescribeUserNum
  • 传输协议:HTTPS
  • 调用频率限制(同一个 AppID 下所有房间):10 次/秒(测试环境:1 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
RoomId[]
Array of String
房间 ID 列表,一次调用最大支持 10 个房间。当房间不存在时,人数为 0。
示例:RoomId[]=room1&RoomId[]=room2

4 请求示例

https://rtc-api.zego.im/?Action=DescribeUserNum
&RoomId[]=room1&RoomId[]=room2
&<公共请求参数>

5 响应参数

参数 类型 描述
Code
Int32
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Object
响应数据。
UserCountList
Array of Object
房间及人数列表。
RoomId
String
房间 ID。
UserCount
Int32
房间人数。
AdminUserCount
Int32
房间管理员人数。该参数主要应用于云录制、音视频流审核等场景中;如果房间没有此类用户,请忽略该参数。

请注意,UserCount 中包含了 AdminUserCount 的人数。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "7840039829955402142",
    "Data": {
        "UserCountList": [
            {
                "RoomId": "room1",
                "UserCount": 2,
                "AdminUserCount": 0
            },
            {
                "RoomId": "room2",
                "UserCount": 3,
                "AdminUserCount": 1
            }
        ]
    }
}

7 返回码

请参考 全局返回码

本篇目录