tencent cloud

Mobile Live Video Broadcasting

Release Notes and Announcements
TUILiveKit Release Notes
Live SDK Release Notes
User Guide
Product Introduction
Overview
Strengths
Performance Statistics
Concepts
Purchase Guide
TRTC Live Billing Overview
Billing of Video Live Component
Activating the Service (TUILiveKit)
Free Demo
Demo
Run Demo（TUILiveKit）
Integration Guide
Video Live Streaming
Preparation
Host Live Streaming
Audience Viewing
Live Stream List Live Stream List
Voice Chat Room
Preparation
Host Live Streaming
Audience Viewing
Live Stream List
Live Streaming Kit
Live Streaming Kit（Electron Desktop Application）
Live Streaming Kit（Web Desktop Browser）
Live Broadcast Monitoring
Monitoring Webpage （Web Desktop Browser React）
Monitoring Webpage （Web Desktop Browser Vue）
UI Customization
Live Stream Video Component
Video Source Editing Canvas
Audience List Component
Barrage Component
Media Source Configuration Panel
Link Management Panel
Live Gift Component
No UI Integration
Video Live Streaming
Voice Chat Room
Feature Guide
Follow Anchors (TUILiveKit)
Ultimate Image Quality (TUILiveKit)
Push Media Stream Into Room (TUILiveKit)
Gift System (TUILiveKit)
Client APIs
Android
iOS
Web
Server APIs (TUILiveKit)
Account System
REST API
Third-Party Webhooks
Error Codes (TUILiveKit)
FAQs
Platform Compilation
User Authentication
Live SDK
Product Introduction
Purchase Guide
Free Demo
Free Trial License
SDK Download
Licenses
Advanced Features
Client API
FAQs
Integration (No UI)
API Documentation
OSS information
OSS Attribution Notice
문서Mobile Live Video BroadcastingServer APIs (TUILiveKit)Third-Party WebhooksRoom RelatedWebhook After Room Creation

Webhook After Room Creation

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-27 11:45:04

Feature Overview

The app backend can use this webhook to view real-time information about users creating rooms, including when the app backend receives a notification of successful room creation, allowing for data synchronization and other operations.

Notes

To enable the webhook, a webhook URL must be configured and the switch corresponding to this webhook protocol activated. For configuration methods, see Third-party Webhook Configuration document.
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

App users successfully create a room through the client.
App administrators successfully create a room via the REST API.

Webhook Trigger Time

After the room is created successfully.

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.CallbackAfterCreateRoom.
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.CallbackAfterCreateRoom",
    "Operator_Account":"admin",
    "RoomInfo":{
        "RoomId":"tandy-test-rest",
        "RoomName":"tandy-test-rest",
        "RoomType":"Live",
        "Owner_Account":"user3",
        "MaxMemberCount":300,
        "IsMessageDisabled":true,
        "CustomInfo":"custom123",
        "IsSeatEnabled":true,
        "TakeSeatMode":"ApplyToTake",
        "MaxSeatCount":16,
        "CreateTime":1703589922,
        "IsPublicVisible":true,
        "CoverURL":"cover url",
        "Category":[1,2]
    }
}

Request packet fields

Field
Type
Description
CallbackCommand
String
Webhook command.
Operator_Account
String
Operator UserID initiating live room creation request.
RoomId
String
Room ID.
RoomName
String
Room Name.
RoomType
String
Room Type: Live (Live Room).
Owner_Account
String
Host ID.
MaxMemberCount
Integer
Maximum number of room members.
IsMessageDisabled
Bool
Prohibit all members from sending text messages.
CustomInfo
String
Custom Definition Fields.
IsSeatEnabled
Bool
Is microphone support available?
MaxSeatCount
Integer
Maximum Number of Microphones.
TakeSeatMode
String
Seat Mode: None (Off), FreeToTake (Free to Join the Podium), ApplyToTake (Apply to join the microphone).
CreateTime
Integer
Create time in Unix time.
IsPublicVisible
Bool
Room is public or not.
CoverURL
String
Room cover URL.
Category
Array
Room Type Identification, Integer array type.
EventTime
Integer
Event trigger timestamp in milliseconds.

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:Create Room.
이전 주제: Delete Webhook Authentication Token​​다음 주제: Webhook After Room Destroyed

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백