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

Webhook After Room Metadata Set

PDF

포커스 모드

폰트 크기

마지막 업데이트 시간: 2026-03-11 14:29:36

Feature Description
The app server can use this webhook to monitor real-time settings of the room's metadata.
Must-Knows
To enable a webhook, you must configure the webhook URL and turn on the switch corresponding to this webhook protocol. For configuration methods, see Third-Party Webhook Configuration document.
The direction of the webhook is that the live server initiates an HTTP POST request to the app server.
After receiving the webhook request, the app server must verify whether the parameter SDKAppID in the request URL is its own SDKAppID.
Scenarios That May Trigger This Webhook
App users set metadata through the client.
App admin sets metadata via REST API.
Timing Of Webhook Occurrence
After the room metadata is set successfully.
API Description
Request URL Sample:
In the following example, the webhook URL configured for the App is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request Parameter Description
Parameter
Description
https
The request protocol is HTTPS, and the request method is POST
www.example.com
Webhook URL
SdkAppid
SDKAppID assigned in the Chat console when creating an application
CallbackCommand
Fixed as Live.CallbackAfterSetMetadata
contenttype
The fixed value is json
ClientIP
Client IP, format: 127.0.0.1
OptPlatform
Client platform. For the value, see Introduction to Third-Party Webhooks for the parameter meaning of OptPlatform
Request Packet Sample
{
    "CallbackCommand": "Live.CallbackAfterSetMetadata",
    "Operator_Account": "brennanli",
    "RoomId": "live-room1111",
    "Metadata": [
        {
            "Key": "key1",
            "Value": "value1"
        },
        {
            "Key": "key2",
            "Value": "value2"
        }
    ],
    "EventTime": 1739965885831
}
Request Packet Field Description
Field
Type
Description
CallbackCommand
String
Webhook command.
Operator_Account
String
Operator UserID who initiates the room destruction request
RoomId
String
Room ID
Metadata
Array
Metadata data
EventTime
Integer
Millisecond-level timestamp triggered by the event
Key
String
Metadata key
Value
String
Metadata value
Response Packet Example
After the app synchronizes data in the background, it sends a webhook response packet.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore webhook result
}
Response Packet Field Description
Field
Type
Attribute
Description
ActionStatus
String
Required
The result of request processing. OK indicates successful processing, and FAIL indicates failure.
ErrorInfo
String
Required
Error message.
ErrorCode
Integer
Required
Error code, 0 means ok.
Reference
﻿Introduction to Third-Party Webhooks﻿
﻿Set room's metadata﻿

도움말 및 지원

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

더 자세한 내용은 문의하기 또는 티겟 제출 을 통해 문의할 수 있습니다.

피드백

tencent cloud

Mobile Live Video Broadcasting

Webhook After Room Metadata Set

Feature Description

Must-Knows

Scenarios That May Trigger This Webhook

Timing Of Webhook Occurrence

API Description

Request URL Sample:

Request Parameter Description

Request Packet Sample

Request Packet Field Description

Response Packet Example

Response Packet Field Description

Reference

도움말 및 지원

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST
www.example.com	Webhook URL
SdkAppid	SDKAppID assigned in the Chat console when creating an application
CallbackCommand	Fixed as `Live.CallbackAfterSetMetadata`
contenttype	The fixed value is `json`
ClientIP	Client IP, format: `127.0.0.1`
OptPlatform	Client platform. For the value, see Introduction to Third-Party Webhooks for the parameter meaning of OptPlatform

Field	Type	Description
CallbackCommand	String	Webhook command.
Operator_Account	String	Operator UserID who initiates the room destruction request
RoomId	String	Room ID
Metadata	Array	Metadata data
EventTime	Integer	Millisecond-level timestamp triggered by the event
Key	String	Metadata key
Value	String	Metadata value

Field	Type	Attribute	Description
ActionStatus	String	Required	The result of request processing. OK indicates successful processing, and FAIL indicates failure.
ErrorInfo	String	Required	Error message.
ErrorCode	Integer	Required	Error code, 0 means ok.