このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Conference/
Web/
サーバー API/
REST インターフェース/
Room Management/
Update the Room Information/

Update the Room Information

Feature Overview

App administrators can update room information through this API.

API Calling Description

Sample Request URL

https://xxxxxx/v4/room_engine_http_srv/update_room_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The table below only lists the parameters modified when calling this API. For more details, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain name for the country/region where the SDKAppID is located:
Singapore :adminapisgp.im.qcloud.com
v4/room_engine_http_srv/update_room_info
Request API
sdkappid
The SDKAppID assigned by the Chat console when an app is created
identifier
Must be an App administrator account. For more details, please refer to App Administrator.
usersig
The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
random
Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
The request format fixed value is json

Maximum Calling Frequency

200 times per second.

Sample Request Packets

Basic Form
{
  "RoomInfo":{
      "RoomId": "room-test",
      "RoomName": "room-name-test",
      "MaxMemberCount": 300,
      "IsVideoDisabled": true,
      "IsAudioDisabled": true,
      "IsMessageDisabled": true,
      "IsScreenSharingDisabled": true,
      "IsCloudRecordingDisabled": true,
      "CustomInfo": "custom123",
      "TakeSeatMode": "ApplyToTake"
  }
}

Request Packet Field Description

Field
Type
Attribute
Description
RoomId
String
Mandatory
Room ID
RoomName
String
Optional
Room Name, defaults to Room ID, up to 100 bytes
MaxMemberCount
Integer
Optional
Maximum number of room members
IsVideoDisabled
Bool
Optional
Mute all video
IsAudioDisabled
Bool
Optional
Mute all audio
IsMessageDisabled
Bool
Optional
Disable all members from sending text messages
IsScreenSharingDisabled
Bool
Optional
Disable screen sharing
IsCloudRecordingDisabled
Bool
Optional
Disable cloud recording
CustomInfo
String
Optional
Custom Information, maximum 500 bytes
TakeSeatMode
String
Optional
Seat mode: FreeToTake (open mic), ApplyToTake (mic on request)

Sample Response Packets

Basic Form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

Response Packet Field Description

Field
Type
Description
ActionStatus
String
The result of the request process. OK for success, FAIL for failure.
ErrorCode
Integer
Error code. 0 for success, others for failure.
ErrorInfo
String
Error message
RequestId
String
The unique request ID is returned for each request and required to provide this RequestId when locating issues.

Error Codes

Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see Error Code documentation. The private error codes for this API are as follows:
Error code
Description
100001
Internal server error, please retry.
100002
Invalid parameter, please check the request for correctness based on the error description.
100004
Room does not exist, or it once existed but now has been destroyed.
100005
Non-room members
100006
Insufficient operational permissions

Possible Callbacks

After the Room Information Is Updated