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
  • Room operations
  • Get room settings

Get room settings

Last updated：2022-02-25 17:04

1 Description

Gets the settings of a room.

2 Request method and endpoint

  • Transmission protocol: HTTPS

3 Request parameters

Parameter Type Required Example Description
secret_id
Int64
Yes
12580
The Secret ID assigned to your project by ZEGO.
access_token
String
Yes
"CIE7hNPK6Y55DeUJBSDrInP"
The server access token obtained via the get_access_token request.
pid
Int64
Yes
1200
The Product ID assigned to your project by ZEGO.
room_id
String
Yes
"123456"
Room ID. The numeric value it represents must be a 64-bit integer.

4 Sample request

{
    "pid": 1255,
    "room_id": "123456",
    "secret_id": 2587762184,
    "access_token": "kaVmfcZR5P8hpqqMmAWXCGYkxf2AgpQjo3NPfBg-mVHYfYUkukaXWN-wekbdVRDlYEp4mbvq9tonqDEw2nNsiw=="
}

5 Response parameters

Parameter Type Example Description
ret
Object
-
The returned status of the request.
ret.code
Int
0
The returned code.
ret.message
String
"succeed"
The returned message.
ret.version
String
"1.0.0"
Version number.
data
Object
-
The returned data of the request.
data.pid
Int64
1
The Product ID assigned to your project by ZEGO.
data.room_id
String
"123456"
Room ID.
data.subject
String
"The Future Of Remote Learning"
The subject of the room.
data.host
Int64
-
User ID of the Host.
data.settings
Object
-
Room settings.
data.settings.max_attendee_count
Int
10
The maximum number of users allowed in the room.
data.settings.enable_host_cam
Bool
true
Whether the Host's camera is on by default.
data.settings.enable_host_mic
Bool
true
Whether the Host's microphone is on by default.
data.settings.enable_attendee_cam
Bool
true
Whether the Attendees' camera is on by default.
data.settings.enable_attendee_mic
Bool
true
Whether the Attendees' microphone is on by default.
data.settings.enable_chat
Bool
true
Whether the text chat feature is enabled.
data.settings.enable_raise_hand
Bool
true
Whether the Raise Hand feature is enabled.
data.settings.enable_attendee_share
Bool
true
Whether the content sharing feature is enabled.
data.settings.enable_attendee_draw
Bool
true
Whether attendees can use the Paintbrush tool.
data.settings.enable_wait
Bool
true
Whether the Waiting Room feature is enabled.
data.settings.is_auto_start
Bool
true
Whether the room starts automatically. If false, the host will need to click the Start button to start the room.
data.settings.max_onstage_count
Int
2
The maximum number of users allowed on the speaker stage (only valid for Large Rooms).
data.settings.is_private_room
Bool
true
Whether it is a private room. A private room only accepts invited people and the organization's administrators.

6 Sample response

{
    "ret": {
        "code": 0,
        "message": "succeed",
        "version": ""
    },
    "data": {
        "pid": 1255,
        "room_id": "123456",
        "subject": "The Future Of Remote Learning",
        "settings": {
            "max_attendee_count": 1200,
            "enable_host_cam": true,
            "enable_host_mic": true,
            "enable_attendee_cam": true,
            "enable_attendee_mic": true,
            "enable_chat": true,
            "enable_raise_hand": true,
            "enable_attendee_share": true,
            "enable_attendee_draw": true,
            "is_auto_start": true,
            "max_onstage_count": 2,
            "is_private_room": false
        },
        "host": 100062263,
        "attendees": [
            100062264,
            100062265
        ]
    }
}
Page Directory
  • Free trial