文档中心
RoomKit RoomKit
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • RoomKit
  • 服务端 API
  • RoomKit 服务端 API
  • 房间当前在线人数

房间当前在线人数

更新时间:2022-10-09 18:08

1 描述

获取房间当前在线人数。

2 接口原型

  • 请求方法:POST

  • 请求地址:

    服务环境 调用频率限制 请求地址
    国内正式环境
    10 次/秒
    https://roomkit-api.zego.im/statistic/v2/room/get_current_online
  • 传输协议:HTTPS

3 请求参数

参数 类型 是否必选 示例 描述
secret_id
Int64
是
12580
创建企业时,ZEGO 分配的 secret ID。
access_token
String
是
"CIE7hNPK6Y55DeUJBSDrInP"
调用 获取服务器 AccessToken 接口返回的 access_token。
pid
Int64
是
1
创建项目时,ZEGO 分配的 ProductID。
room_id
String
是
"123"
房间 ID,值需要为 64 位内的整型。

4 请求示例

以下是 get_current_online 接口的请求示例。

{
    "secret_id": 12580,
    "access_token": "access_token",
    "pid": 1,
    "room_id":"123"
}

5 响应参数

参数 类型 示例 描述
ret
Object
-
接口调用结果。
ret.code
Int
0
错误码。
ret.message
String
"succeed"
错误信息。
data
Object
-
接口调用返回数据。
data.online_num
Int64
3
房间当前在线人数。

6 响应示例

以下是 get_current_online 接口的响应示例。

{
    "ret": {
        "code": 0,
        "message": "succeed"
    },
    "data": {
        "online_num":3
    }
}
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈