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

获取房间人数

更新时间:2022-11-25 15:44

1 描述

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

2 接口原型

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

3 请求参数

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

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

4 请求示例

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

5 响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。
Data
Object
响应数据。
UserCountList
Array of Object
房间及人数列表。
RoomId
String
房间 ID。
UserCount
Number
房间人数。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "7840039829955402142",
    "Data": {
        "UserCountList": [
            {
                "RoomId": "123",
                "UserCount": 2
            },
            {
                "RoomId": "456",
                "UserCount": 0
            }
        ]
    }
}

7 返回码

请参考 全局返回码