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 WebhooksBattle RelatedWebhook After Creating Battle

Webhook After Creating Battle

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

Feature Description

The app server can use this webhook to monitor battle started.

Must-Knows

To enable the webhook, the webhook must be configured 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 backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must verify whether the parameter SDKAppID in the request URL is its own SDKAppID.

Scenarios That May Trigger This Webhook

After creating a battle with , it can directly enter the started state without waiting when .
After the battle is created, once all callees have processed the battle request, as long as there is at least one room owner of the callee who agrees to join the battle, the battle officially begins.

Timing Of Webhook Occurrence

After the battle is officially launched.

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

Description Of Request Parameters

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

Request Packet Sample

{
    "CallbackCommand": "Live.CallbackAfterStartBattle",  
    "BattleId": "4siHsNsWN/T3aub9zKraqI4zZAyPRpXQhdtKv1q4HOs=", // battle id
    "Duration": 60000, // battle duration
    "CreateTime": 1739954005, // battle creation time, in seconds
    "StartTime": 1739954005, // battle start time, in seconds
    "FromRoomInfo": {  // Caller information in battle
        "RoomId": "pk-3",
        "Owner_Account": "brennan"
    },
    "ToRoomList": [ // Called party information in battle
        {
            "RoomId": "pk-5",
            "Owner_Account": "tandy"
        }
    ],
    "EventTime": 1739954005000, // Callback trigger time, in milliseconds
}

Description Of Request Packet Fields

Field
Type
Description
CallbackCommand
String
Webhook command.
BattleId
String
Battle ID.
Duration
Integer
Battle duration in milliseconds.
CreateTime
Integer
Creation time of the battle, Unix time.
StartTime
Integer
Start time of the battle, Unix time.
FromRoomInfo
String
Caller information in battle.
ToRoomList
Array
Information of the callee participating in the battle.
RoomId
String
Room ID.
Owner_Account
String
The owner ID of room.
EventTime
Integer
Millisecond-level timestamp triggered by the event.

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
}

Description Of Response Packet Fields

Field
Type
Attribute
Description
ActionStatus
String
Required
Result of request processing. OK indicates success and FAIL indicates failure.
ErrorCode
Integer
Required
Error code. Fill in 0 here to ignore the webhook result.
ErrorInfo
String
Required
Error message.

Reference

Introduction to Third-Party Webhook
이전 주제: Webhook After Creating Battle다음 주제: Webhook After Ending Battle

도움말 및 지원

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

피드백