RoomKit
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • React Native
  • 产品简介
    • 概述
    • 发布日志
  • 开通 RoomKit 服务
  • 下载
  • 体验 App
  • 快速开始
  • 进阶功能
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • RoomKit
  • 服务端 API
  • 教育云服务端 API
  • 获取指定用户房间列表

获取指定用户房间列表

更新时间:2022-06-17 19:25

1 描述

获取指定用户参与的房间列表。

2 接口原型

  • 请求方法:POST

  • 请求地址:

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

3 请求参数

参数 类型 是否必选 示例 描述
uid
Int64
99900000
用户 uid。
secret_id
Int64
12580
创建企业时,ZEGO 分配的 secret ID。
access_token
String
"CIE7hNPK6Y55DeUJBSDrInP"
调用 获取服务器 AccessToken 接口返回的 access_token。
begin_timestamp
Int64
1623954399000
房间起始开始时间,所有开始时间大于这个值的房间都会被查询出来,单位:毫秒。
status
Int
3
固定为3。
page
Int
1
第几页,从1开始。
count
Int
20
分页的大小,默认值为20。

4 请求示例

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

{
    "begin_timestamp": 1623954399000,
    "status": 3,
    "access_token": "jZPr93v1-Nzpm6KUIAvov_G7rbpZrqqr5bj0_huosae-EC6v2lgzdGFxQvX6h-ofFTuPlZL574Q=",
    "secret_id": 1000001,
    "uid": 100062223
}

5 响应参数

参数 类型 示例 描述
ret
Object
-
接口调用结果。
ret.code
Int
0
错误码。
ret.message
String
"succeed"
错误信息。
ret.version
String
"1.0.0"
版本号。
data
Object
-
接口调用返回数据。
data.count
Int
1
房间数量。
data.room_list
Array of Object
-
房间对象的数组。
data.room_list[0].room_id
String
"123456789"
房间 ID。
data.room_list[0].pid
Int64
1200
项目 ID。
data.room_list[0].subject
String
"subject"
房间主题。
data.room_list[0].room_type
Int
1
房间类型:
  • 1:小房间模式
  • 3:1v1 房间模式
  • 5:大房间模式
  • 6:语音直播模式
data.room_list[0].begin_timestamp
Int64
1590666065838
房间开始时间,时间戳,精确到毫秒。
data.room_list[0].end_timestamp
Int64
1624434174000
房间结束时间,时间戳,精确到毫秒。
data.room_list[0].create_timestamp
Int64
1590666065838
房间创建时间,时间戳,精确到毫秒。
data.room_list[0].host
Object
-
主持人。
data.room_list[0].host.uid
Int64
99975923
主持人 uid。
data.room_list[0].locked
Int
0
房间锁定状态:
  • 0:未锁定
  • 1:已锁定
data.room_list[0].status
Int
1
房间状态:
  • 1:未开始
  • 2:进行中
  • 4:已结束
  • 8:已取消
data.room_list[0].max_attendee_count
Int
10
房间参会的总人数上限。
data.room_list[0].user_role
Int
1
用户在此房间的角色:
  • 1:老师/主持人
  • 2:普通观众
  • 4:助教
data.room_list[0].settings
Object
-
房间配置项。
data.room_list[0].settings.enable_host_cam
Bool
true
主持人默认开启摄像头。
data.room_list[0].settings.enable_host_mic
Bool
true
主持人默认开启麦克风。
data.room_list[0].settings.enable_attendee_cam
Bool
true
参会人员默认开启摄像头。
data.room_list[0].settings.enable_attendee_mic
Bool
true
参会人员默认开启麦克风。
data.room_list[0].settings.enable_chat
Bool
true
房间默认是否允许聊天。
data.room_list[0].settings.enable_raise_hand
Bool
true
房间默认是否允许举手。
data.room_list[0].settings.enable_attendee_share
Bool
true
房间默认是否允许分享。
data.room_list[0].settings.enable_attendee_draw
Bool
true
房间默认是否允许使用画笔。
data.room_list[0].settings.enable_wait
Bool
true
房间默认是否开启等候功能。
data.room_list[0].settings.enable_wait_setting
Bool
true
房间是否允许开启等候功能。
data.room_list[0].settings.is_auto_start
Bool
true
房间是否直接开始启动。
data.room_list[0].settings.max_onstage_count
Int
2
房间最大上台人数。
data.room_list[0].settings.is_private_room
Bool
false
是否是私有房间。

6 响应示例

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

{
    "ret": {
        "code": 0,
        "message": "succeed",
        "version": "1.0.0"
    },
    "data": {
        "count": 1,
        "room_list": [
            {
                "room_id": "124768350",
                "pid": 1241,
                "subject": "2",
                "room_type": 6,
                "settings": {
                    "enable_host_cam": true,
                    "enable_host_mic": true,
                    "enable_attendee_cam": true,
                    "enable_attendee_mic": true,
                    "automatic_recording": false,
                    "enable_wait": false,
                    "enable_wait_setting": false,
                    "enable_chat": true,
                    "enable_raise_hand": true,
                    "default_locked": false,
                    "enable_attendee_share": true,
                    "enable_attendee_draw": true,
                    "is_auto_start": false,
                    "max_onstage_count": 2,
                    "is_private_room": false
                },
                "begin_timestamp": 1624433994000,
                "end_timestamp": 1624434174000,
                "create_timestamp": 1624434001531,
                "duration": 3,
                "status": 2,
                "locked": 0,
                "host": {
                    "uid": 100062223
                },
                "attendee_count": 2,
                "max_user_count": 2,
                "max_attendee_count": 2,
                "user_role": 1
            }
        ]
    }
}
本篇目录