tencent cloud

Tencent Real-Time Communication

소식 및 공지 사항
제품 업데이트
Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가
TRTC 월간 구독 패키지 출시 관련 안내
제품 소개
제품 개요
기본 개념
제품 기능
제품 장점
응용 시나리오
성능 데이터
구매 가이드
Billing Overview
무료 시간 안내
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
과금 FAQ
Refund Instructions
신규 사용자 가이드
Demo 체험
Call
개요(TUICallKit)
Activate the Service
Run Demo
빠른 통합(TUICallKit)
오프라인 푸시
Conversational Chat
온클라우드 녹화(TUICallKit)
AI Noise Reduction
UI 사용자 정의
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
릴리스 노트
FAQs
라이브 스트리밍
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 클라이언트 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
FAQs
과금 개요
기능 관련
UserSig 관련
방화벽 제한 처리
설치 패키지 용량 축소 관련 질문
Andriod 및 iOS 관련
Web 관련
Flutter 관련
Electron 관련
TRTCCalling Web 관련
멀티미디어 품질 관련
기타 질문
Protocols and Policies
컴플라이언스 인증
보안 백서
정보 보안에 관한 참고 사항
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
용어집

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

도움말 및 지원

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

피드백