tencent cloud

Webhook After Room Destroyed
Download PDF
Last updated: 2025-11-18 09:39:29
Webhook After Room Destroyed
Last updated: 2025-11-18 09:39:29
Download PDF

Feature Overview

The app backend can use this webhook to monitor room dissolution in real-time, including real-time recording of room dissolution (e.g., logging or synchronization with other systems).

Notes

To enable this webhook, you must configure the webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Third party webhook configuration documentation.
During this webhook, the Live backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.

Scenarios that may trigger this webhook

The app user successfully dissolved the room using the client
The app administrator successfully dissolved the room using the REST API

Webhook Trigger Time

After the room is successfully destroyed.

API description

Sample request URL

In the following example, the webhook URL configured in the app is https://www.example.com. Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST
www.example.com
Webhook URL
SdkAppid
SDKAppID assigned by the Chat console when an application is created
CallbackCommand
Fixed as Live.CallbackAfterDestroyRoom
contenttype
Fixed value: JSON
ClientIP
Client IP, such as 127.0.0.1
OptPlatform
Client Platform, for value reference see Webhook Overview: Webhook Protocol for the meaning of the OptPlatform parameter

Sample request packets

{
    "CallbackCommand":"Live.CallbackAfterDestroyRoom",
    "Operator_Account":"admin",
    "RoomId":"tandy-test-rest",
    "EventType":"DestroyByUser", //"DestroyByUser", "DestroyBySystem" indicates two kinds: user-initiated dissolution and system-automatic dissolution when room is empty
    "EventTime":1703589922780,
    "RoomInfo": {
        "RoomName": "live name",
        "RoomType": "Live",
        "Owner_Account": 144115216631667826,
        "IsSeatEnabled": true,
        "TakeSeatMode": "FreeToTake",
        "MaxMemberCount": 400,
        "MaxSeatCount": 4,
        "Category": [1, 2, 3],
        "CustomInfo": "",
        "IsMessageDisabled": false,
        "CoverURL": "cover url",
        "ActivityStatus": 0,
        "IsPublicVisible": false,
        "ViewCount": 0,
        "BackgroundURL": "background url",
        "IsUnlimitedRoomEnabled": true
     },
     "Statistic": {
            "TotalViewers": 0,
            "TotalGiftsSent": 0,
            "TotalGiftCoins": 0,
            "TotalUniqueGiftSenders": 0,
            "TotalLikesReceived": 0
     }
}

Request packet fields

Field
Type
Description
CallbackCommand
String
Webhook command
Operator_Account
String
UserID of the operator initiating the room destruction request
RoomId
String
Room ID
EventType
String
Dissolution Type: Divided into user-initiated dissolution (DestroyByUser) and system-automatic dissolution (DestroyBySystem)
EventTime
Integer
Event trigger timestamp in milliseconds
RoomName
String
Room Name
RoomType
String
Room Type: Meeting (Meeting Room)
Owner_Account
String
Host ID
IsSeatEnabled
Bool
Is microphone support available
TakeSeatMode
String
Seat Mode: None (Off), FreeToTake (Free to Join the Podium), ApplyToTake (Apply to join the microphone)
MaxMemberCount
Integer
Maximum number of room members
MaxSeatCount
Integer
Maximum Number of Microphones
Category
Array
Room Type Identification, Integer array type
CustomInfo
String
Custom Definition Fields
IsMessageDisabled
Bool
Prohibit all members from sending text messages
CoverURL
String
Room cover URL
ActivityStatus
Integer
Live room activity status: user-defined tag
IsPublicVisible
Bool
Room is public or not
ViewCount
Integer
Total number of times the user has entered the room
BackgroundURL
String
Room background URL
IsUnlimitedRoomEnabled
Bool
Whether to enable room mixing to support high concurrency scenarios. The default value is false. When true, it corresponds to the TUILiveKit on the SDK side
TotalViewers
Integer
Total room entries, counting N times for the same user entering the room repeatedly
TotalGiftsSent
Integer
Total gift count
TotalGiftCoins
Integer
Total gift value
TotalUniqueGiftSenders
Integer
Total number of gift senders
TotalLikesReceived
Integer
Total like count

Response packet example

A webhook response packet is sent after the app backend synchronizes the data.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore webhook result
}

Response Packet Field Description

Field
Type
Attribute
Description
ActionStatus
String
Mandatory
The result of the request process: OK indicates success; FAIL indicates failure
ErrorCode
Integer
Mandatory
Error Code, here 0 means to ignore the response result
ErrorInfo
String
Mandatory
Error message

Reference

Webhook Overview
REST API:Dissolve Room
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback