Documentation
Documentation
Demo APP
SDK 中心
API 中心
FAQ
代码市场
Console
Sign Up
Log In
中文站 English
RoomKit
Product

ZEGO UIKits

  • In-app Chat Kit
  • Call Kit
  • Live Streaming Kit
  • Video Conference Kit
  • Live Audio Room Kit New

Cloud Communications Products

  • Video Call
  • Voice Call
  • Live Streaming
  • In-app Chat

Low-Code Products

  • RoomKit

AIGC

  • Virtual Avatar
  • Digital Human PaaS New

Supporting Services

  • Super Board
  • AI Effects
  • Cloud Recording
  • Admin Console
  • Mini Game Engine New
  • iOS : Objective-C
  • Android
  • Web
  • Flutter
Expand All
  • Introduction
  • Demo app
  • Sample codes
  • Client SDKs
    • SDK downloads
    • Release notes
  • Getting started
    • Integration
    • Start a room
  • Guides
    • Customize room parameters
    • Customize the room UI
    • Listen for room callbacks
    • Screen rotation support
    • Screen sharing
    • Manage rooms with Education Cloud Service
    • Use server event callbacks
  • Server APIs
  • Error codes
  • Documentation
  • RoomKit
  • Server APIs
  • RoomKit Server APIs
  • API overview

API overview

Last updated：2022-03-22 13:06

RoomKit provides REST APIs for your app server to interact with the RoomKit server, including getting authentication tokens from the RoomKit server for client-side and server-side access, and server-side operations on RoomKit users, rooms, and cloud drives.

Authentication

Method Description
Get server access token Gets the Roomkit access token for authenticating server-side requests to RoomKit's REST APIs.
Get SDK access token Gets the Roomkit access token for authenticating client-side user login.

Room operations

Method Description
Update room settings Updates the settings of a room.
End room Ends a room.
Get room settings Gets the settings of a room.
List room's IM chat messages Lists all IM chat messages of a room.

Cloud drive operations

Method Description
List files Lists all files in a folder.
Upload file Uploads files to a folder.
Create folder Creates a folder.
Bind file to folder Associates a transcoded file with a folder.
Rename file or folder Renames a file or a folder.
Move files or folders Moves files or folders to another folder.
Delete files or folders Deletes files or folders.
Get file details Gets detailed information on a file.

Room statistics

Method Description
Get room's current participants count Gets the current number of participants in a room.
Get room's highest participants count in specified time period Gets the highest number of participants in a room in a specified time period.
Get room's elapsed time Gets the elapsed time of a room.
Get room's cumulative participants count Gets the cumulative number of unique participants of a room.
Get room's participants entry and exit records Gets the participants entry and exit records of a room.

User statistics

Method Description
Get user's room attendance records in specified time period Gets a user's room attendance records in a specified time period.

Project statistics

Method Description
List project's rooms in specified time period Lists all rooms created under a project where the room's scheduled start time falls within a specified time period.
Get project's current online user count Gets the current number of online users of a project.
Get project's highest online user count in specified time period Gets the highest number of online users of a project in a specified period of time.

Event callbacks

Event Description
Server event callbacks RoomKit server-side event callbacks.
Page Directory
  • Free trial