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 Ending Battle

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-05-29 11:31:19

Feature Description

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

Must-Knows

To enable webhook, configuration is required.
URL, and turn on the switch corresponding to this webhook protocol. For detailed 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 server must verify whether the parameter SDKAppID in the request URL is its own SDKAppID.

Scenarios That May Trigger This Webhook

The battle ends normally when the time is up.
During the battle, all room owners exit the battle.
After the battle is created, it ends directly when all the called room owners do not agree to join the battle.

Timing Of Webhook Occurrence

After the battle ends.

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.CallbackAfterEndBattle
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.CallbackAfterEndBattle",
"BattleId": "4siHsNsWN/T3aub9zKraqPfGQAimPhdFoe6VWhtz9lY=",
"Duration": 30000,
"CreateTime": 1739956115,
"StartTime": 1739956115,
"EndTime": 1739956145,
"OpType": 0, // 0 indicates normal completion when time is up; 1 indicates completion caused by all streamers exiting after the battle starts; 2 indicates that the battle was created but ended directly without starting because no streamers joined.
"FromRoomInfo": { //Caller information
"RoomId": "pk-3",
"Score": 0,
"Owner_Account": 144115245353757792
},
"ToRoomList": [ // Called party information
{
"RoomId": "pk-5",
"Score": 0,
"Owner_Account": 144115245442327522
}
],
"EventTime": 1739956146119
}

Description Of Request Packet Fields

Field
Type
Description
CallbackCommand
String
Callback command
BattleId
String
Battle Id
Duration
Integer
Duration of the battle
CreateTime
Integer
Creation time of the battle
StartTime
Integer
Start time of the battle
EndTime
Integer
Termination time of the battle
OpType
Integer
0 indicates normal completion when time is up;
1 indicates completion caused by all room owners exiting after the battle starts;
2 indicates that the battle was created but ended directly without starting because no room owners joined.
FromRoomInfo
String
Caller information of the battle
ToRoomList
Array
Callee information of the battle
RoomId
String
Room Id
Score
Integer
The room score in battle
Owner_Account
String
The room owner in 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
Required
The result of request processing. OK indicates successful processing, FAIL indicates failure
ErrorInfo
String
Required
Error message
ErrorCode
Integer
Required
Error code

Reference

도움말 및 지원

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

피드백