服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

获取房间人数

更新时间:2021-11-24 15:13

1 描述

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

2 接口原型

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

3 请求参数

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

参数 类型 是否必选 描述
RoomId[] Array of String 房间 ID 列表,一次调用最大支持 10 个房间。
示例: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 Array of Object 响应数据。
└ RoomId String 房间 ID。
└ UserCount Number 房间人数。

6 响应示例

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

7 返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明
50001 房间不存在。
  • 当房间内没有用户时,房间会被 SDK 自动销毁。
  • 当房间内只有一个用户时,该用户退出房间或被踢出房间,房间会被 SDK 自动销毁。
  • 当房间心跳请求超时 100 秒后,房间会被 SDK 自动销毁。
50002 用户账号不存在。
50003 查找用户在线信息失败。
50004 读取用户信息失败。
50009 审核失败。
50011 推送自定义消息目的用户个数超过限制。
50012 推送自定义消息长度超过限制。
50013 发送自定义消息失败。