tencent cloud

Destory Room
Download PDF
Last updated: 2025-11-18 09:39:29
Destory Room
Last updated: 2025-11-18 09:39:29
Download PDF

Feature Overview

App admin can dissolve a room using this interface.

API Calling Description

Sample request URL

https://xxxxxx/v4/live_engine_http_srv/destroy_room?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/destroy_room
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
Must be an App admin account. For more details, see 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
{
    "RoomId":"live-room"      
}

Request packet fields

Field
Type
Attribute
Description
RoomId
String
Mandatory
Room ID

Sample response packets

Basic Form
{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-1b30123ad8a149b0aa225d8596999714-O-Seq-616334",
    "Response": {
        "Statistic": {
            "TotalViewers": 0,
            "TotalGiftsSent": 0,
            "TotalGiftCoins": 0,
            "TotalUniqueGiftSenders": 0,
            "TotalLikesReceived": 0
        }
    }
}

Response Packet Field Description

Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates failure.
ErrorInfo
String
Error Message
RequestId
String
Unique request ID, returned for each request. To locate an issue, provide the RequestId of that request.
TotalViewers
Integer
Total Enter Room count. Same user repeat Enter Room N times counts as N.
TotalGiftsSent
Integer
Total gift count
TotalGiftCoins
Integer
Total gift value
TotalUniqueGiftSenders
Integer
Total number of gift senders
TotalLikesReceived
Integer
Total like count

Live room auto-destroy mechanism

Room auto-destroy is triggered under the following 3 conditions. These policies are configurable at the ​sdkappid level. To modify settings, contact your account manager or submit a ticket.
1. The room will be automatically destroyed if it remains empty for a continuous period (default: 30 minutes) with no new participants after users have entered the room. Sdkappids created before May 20, 2025, retain the original 6-hour auto-destroy threshold. The timeframe is adjustable within a configurable range of ​​[10 minutes, 24 hours]​. Rooms containing bots are exempt from auto-disbandment.
2. If the room owner leaves room via API and doesn,t enter room within the configured timeframe (recommend: 10 minutes), the room will trigger auto-destroy rule, which is disabled by default. The timeframe is adjustable within a configurable range of [2 minutes, 12 hours]. The auto-disbandment mechanism is disabled when the room owner is identified as a bot.
3. If the room owner disconnects beyond the heartbeat keep-alive period, and fails to report heartbeat to server within th configured timeframe (recommend: 10 minutes), the room will trigger auto-destroy rule, which is disabled by default. The timeframe is adjustable within a configurable range of [2 minutes, 12 hours]. The auto-disbandment mechanism is disabled when the room owner is identified as a bot.

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