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
  • Update room settings

Update room settings

Last updated：2022-02-25 17:04

1 Description

Updates 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.
subject
String
Yes
"The Future Of Remote Learning"
The subject of the room.
host
Int64
No
-
User ID of the Host.
settings
Object
No
-
Room settings. If not specified, all its internal attributes will be false.
settings.max_attendee_count
Int
No
10
The maximum number of users allowed in the room.
settings.enable_host_cam
Bool
No
true
Whether to turn on the Host's camera by default. If not specified, the default is false.
settings.enable_host_mic
Bool
No
true
Whether to turn on Host's microphone by default. If not specified, the default is false.
settings.enable_attendee_cam
Bool
No
true
Whether to turn on the Attendees' camera by default. If not specified, the default is false.
settings.enable_attendee_mic
Bool
No
true
Whether to turn on the Attendees' microphone by default. If not specified, the default is false.
settings.enable_chat
Bool
No
true
Whether to enable the text chat feature. If not specified, the default is false.
settings.enable_raise_hand
Bool
No
true
Whether to enable the Raise Hand feature. If not specified, the default is false.
settings.enable_attendee_share
Bool
No
true
Whether to enable the content sharing feature for attendees. If not specified, the default is false.
settings.enable_attendee_draw
Bool
No
true
Whether to allow attendees to use the Paintbrush tool. If not specified, the default is false.
settings.enable_wait
Bool
No
true
Whether to enable the Waiting Room feature (only valid for meeting use cases). If not specified, the default is false.
settings.is_auto_start
Bool
No
true
Whether to start the room automatically. If not specified, the default is false, which means the host will need to click the Start button to start the room.
settings.max_onstage_count
Int
No
2
The maximum number of users allowed on the speaker stage (only valid for Large Rooms). If not specified, the default is 2.
settings.is_private_room
Bool
No
true
Whether it is a private room. A private room only accepts invited people and the organization's administrators. If not specified, the default is false.
attendees
[]Int64
No
[1,2]
The array of the Attendees' user IDs.

4 Sample request

{
    "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],
    "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.

6 Sample response

{
    "ret": {
        "code": 0,
        "message": "succeed",
        "version": "1.0.0"
    }
}
Page Directory
  • Free trial