logo
实时音视频
服务端 API
场景服务接口
当前页

DescribeUserNum

GET

https://rtc-api.zego.im/

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

调用频率限制
同一个 AppID 下所有房间:10 次/秒(测试环境:1 次/秒)

Request

Query Parameters

    Action string必填

    可选值: [DescribeUserNum]

    接口原型参数

    https://rtc-api.zego.im?Action=DescribeUserNum

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    RoomId string[]必填

    可选值: >= 1, <= 10

    房间 ID 列表,一次调用最大支持 10 个房间。当房间不存在时,人数为 0。 示例:RoomId[]=room1&RoomId[]=room2

Responses

操作成功
Schema
    Code int32

    返回码。请参考 全局返回码

    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    UserCountList object[]
    房间及人数列表。
  • Array[
  • RoomId string

    房间 ID。

    UserCount int32

    房间人数。

    AdminUserCount int32

    房间管理员人数。该参数主要应用于云录制、音视频流审核等场景中;如果房间没有此类用户,请忽略该参数。请注意,UserCount 中包含了 AdminUserCount 的人数

  • ]

ZEGO 签名生成器
Request
折叠所有
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
query必填
query必填
query必填
query必填
query必填
query必填
query必填
RESPONSE清除

点击上方 “发送” 按钮,在此处查看响应。

Previous

推送自定义消息

Next

查询用户状态

当前页

返回到顶部