tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明（TUICallKit）
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング（TUICallKit）
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom（Web）の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現（旧）
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集
ドキュメントTencent Real-Time Communicationライブ配信Server APIsThird-Party WebhooksBattle RelatedWebhook After Creating Battle

Webhook After Creating Battle

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-27 11:42:01

Feature Description

The app server can use this webhook to view information about user-created battles in real time.

Must-Knows

To enable a webhook, you must configure the webhook URL and turn on the switch corresponding to this webhook protocol. For the configuration method, see Third-Party Webhook Configuration documentation.
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

The app user successfully creates a battle through the client.
The app admin successfully creates a battle via REST API.

Timing Of Webhook Occurrence

After the battle is created 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

Description Of Request Parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Webhook URL.
SdkAppid
The SDKAppID assigned in the Chat console when creating an application.
CallbackCommand
Fixed as Live.CallbackAfterCreateBattle.
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 Webhook for the parameter meaning of OptPlatform.

Request Packet Sample

{
    "CallbackCommand": "Live.CallbackAfterCreateBattle",
    "Operator_Account": "brennanli",
    "BattleId": "4siHsNsWN/T3aub9zKraqPbSEGRX2z6gs3LDFi+d/3M=",  //battle id
    "FromRoomId": "pk-3", // Room ID of the caller initiating the battle
    "ToRoomIdList": [ // Room ID list of the callee participating in the battle
        "pk-5"
    ],
    "Timeout": 30000, // If NeedResponse is true, the maximum waiting duration for the callee to process; if the callee does not process, it indicates giving up participating in the battle
    "Duration": 60000, // Duration after the battle starts, in milliseconds
    "NeedResponse": false, // If false, start the battle directly; if true, wait for the callees to process before starting the battle
    "ExtensionInfo": "extension pk",
    "EventTime":1739954005000
}

Field Description Of Request Packet

Field
Type
Description
CallbackCommand
String
Webhook command.
Operator_Account
String
User who initiates battle request.
BattleId
String
Battle ID.
FromRoomId
String
Room id of the caller initiating the battle.
ToRoomIdList
Array
List of callee participating in the battle.
Timeout
Integer
Maximum waiting duration after creating a battle, waiting for the callees to process, in milliseconds.
Duration
Integer
Duration of the battle in milliseconds.
NeedResponse
Bool
After creating a battle, is the consent of the callee's room owner required for joining.
ExtensionInfo
String
Extended information of the battle.
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
}

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

Introduction to Third-Party Webhook
前の記事へ: Webhook After Seat List Changed次の記事へ: Webhook After Creating Battle

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック