tencent cloud

Update Room Information
Download PDF
Last updated:2026-01-29 16:06:57
Update Room Information
Last updated: 2026-01-29 16:06:57
Download PDF

Feature Overview

App Administrators can update room information through this interface.

API Calling Description

Sample request URL

https://xxxxxx/v4/live_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 this interface is called. For more details on other parameters, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Others in China: console.tim.qq.com.
Singapore : adminapisgp.im.qcloud.com.
United States: adminapiusa.im.qcloud.com.
v4/live_engine_http_srv/update_room_info
Request API.
sdkappid
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 Admin.
usersig
The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format fixed value: json.

Maximum calling frequency

200 queries/sec.

Sample request packets

Basic Form
{
    "RoomInfo" : {
      "RoomId":"live-room",
      "RoomName" : "rname-123", 
      "MaxMemberCount" : 300, 
      "IsMessageDisabled" : false, 
      "CoverURL": "https://xxxx.png", 
      "Category": [1,2,3], 
      "ActivityStatus":1, 
      "IsPublicVisible": false,
      "TakeSeatMode": "ApplyToTake"
  }
}

Request packet fields

Field
Type
Attribute
Description
RoomId
String
Mandatory
Room ID.
RoomName
String
Optional
Room Name.
MaxMemberCount
Integer
Optional
Max Room Capacity.
IsMessageDisabled
Bool
Optional
Room-wide Mute Switch, except for the Administrator and Homeowner.
CoverURL
String
Optional
Room cover.
Category
Array
Optional
Room Category Tag, maximum array length is 3.
ActivityStatus
Integer
Optional
Room self-definition status.
IsPublicVisible
Bool
Optional
Room Open Switch, mainly used for retrieving the room list.
TakeSeatMode
String
Optional
Seat Mode, Free to Join the Podium FreeToTake, Apply to join the microphone ApplyToTake.
Notice
String
Optional
Room notice, maximum 100 bytes.

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 indicates success; FAIL indicates failure.
ErrorCode
Integer
Error code. 0: success; other values: failure.
ErrorInfo
String
Error message.
RequestId
String
Unique Request ID is returned with each request and required to provide this RequestId when locating issues.

Error codes

Unless a network error occurs (e.g., 502 Error), the HTTP return code for this interface will always be 200. The actual error code and error information are indicated in the response payload by ErrorCode and ErrorInfo. Common Error Codes (60000 to 79999) can be found in the Error Code document. 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
The room does not exist, possibly because it was never created or has already been dissolved.
100006
No permission to dissolve, for example, the operator is neither the homeowner nor the root administrator, or the room being dissolved is not a live room, etc.



Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback