DescribeUserNum

GET

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

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

调用频率限制

同一个 AppID 下所有房间：10 次/秒（测试环境：1 次/秒）

Request

Query Parameters

Action stringrequired

Possible values: [DescribeUserNum]

接口原型参数

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

AppId uint32required

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

💡公共参数。随机字符串。

Timestamp int64required

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

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

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

RoomId string[]required

Possible values: >= 1, <= 10

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

Responses

操作成功

application/json

Schema
Example (from schema)
Example

Schema

Code int32

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

Message string

操作结果描述。

RequestId string

请求 ID。

Data object

UserCountList object[]

房间及人数列表。

Array[

RoomId string

房间 ID。

UserCount int32

房间人数。

AdminUserCount int32

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

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "7840039829955402142",
  "Data": {
    "UserCountList": [
      {
        "RoomId": "string",
        "UserCount": 0,
        "AdminUserCount": 0
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "7840039829955402142",
  "Data": {
    "UserCountList": [
      {
        "RoomId": "string",
        "UserCount": 0,
        "AdminUserCount": 0
      }
    ]
  }
}

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

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

CURL

RESPONSEClear

Click the "Send" button above and see the response here!

DescribeUserNum

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

Request

Query Parameters

Responses​

Responses