Tencent Real-Time Communication
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Monthly subscription
- Monthly Packages
- Pay-as-you-go
- Refund Instructions
- Video Calling (Including UI)
- Run Demo（TUICallKit）
- Integration (TUICallKit)
- Calls integration to Chat (TUICallKit)
- Offline Call Push (TUICallKit)
- Flutter
- Additional Features（TUICallKit）
- Multi-Person Call
- Floating Window
- Beauty Effects
- Custom Ringtone
- Monitoring Call Status
- Language Settings
- Solution (TUICallKit)
- Server APIs (TUICallKit)
- REST API
- Third-Party Callback
- Callback Configuration
- Call Status Callback
- Legacy Documentation
- Call Status Callback
- Client APIs (TUICallKit)
- uniapp（Android&iOS）
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Run Demo（TUIRoomKit）
- Integration（TUIRoomKit）
- Screen Sharing (TUIRoomKit)
- Schedule a meeting (TUIRoomKit)
- In-meeting Call (TUIRoomKit)
- Virtual Background (TUIRoomKit)
- Conference Control (TUIRoomKit)
- In-Conference Chat (TUIRoomKit)
- Enhanced Features (TUIRoomKit)
- Text Watermark
- Client APIs (TUIRoomKit)
- iOS&Mac
- Android
- Electron
- Flutter
- RoomEngine API
- Server APIs (TUIRoomKit)
- REST API
- User Management
- Third-Party Callback
- Callback Configuration
- User Related
- Seat Connection Related
- Live Streaming (Including UI)
- Customizable Interface (TUILiveKit)
- Client APIs (TUILiveKit)
- Android
- UIKit API
- iOS
- UIKit API
- Web
- Electron
- Flutter
- API-Example
- Video Live（LiveStreamCore）
- Server APIs (TUILiveKit)
- REST API
- Room Related
- User-Related Matters
- Battle Related
- Third-Party Callback
- Callback Configuration
- User Related
- Seat Connection Related
- Voice Chat Room (with UI)
- Client APIs (TUICallKit)
- iOS
- UIKit API
- Android
- UIKit API
- API-Example
- Server APIs (TUILiveKit)
- REST API
- Room Related
- Integration (No UI)
- SDK Download
- API Usage Guidelines
- SDK Quick Start
- 01. Importing the SDK
- 02. Entering a Room
- 03. Subscribing to Audio/Video Streams
- 04. Publishing Audio/Video Streams
- 05. Exiting a Room
- 06. Advanced Guide
- Sensing Network Quality
- Setting Video Quality
- Rotating Videos
- API Reference Manual
- iOS and macOS
- Android
- All Platforms (C++)
- Electron
- Flutter
- Unity
- Advanced Features
- Testing Hardware Devices
- Testing Network Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Event Callbacks
- Enable Watermark
- Server APIs
- Room Management APIs
- Stream mixing and relay APIs
- Data Monitoring APIs
- Pull stream Relay Related interface
- AI Transcription APIs
- Making API Requests
- Call Quality Monitoring APIs
- On-cloud recording APIs
- Usage Statistics APIs
- Appendix
- Console Guide
- Application Management
- Monitoring Dashboard
- Development Assistance
- Solution
- Real-Time Chorus
- Solution Overview (TUIKaraoke)
- TUIKaraoke APIs
- FAQs
- Legacy Documentation
- Protocols and Policies
DocumentationTencent Real-Time CommunicationMulti-Participant Conference (with UI)Server APIs (TUIRoomKit)Third-Party CallbackUser RelatedAfter a Room Is Left
After a Room Is Left
Last updated: 2024-06-12 11:46:26
Feature Overview
The App backend can view the messages of room members leaving in real-time through this callback, including: notifying the app backend that a member has left the room, allowing the app to perform necessary data synchronization.
Notes
To enable the callback, a callback URL must be configured and the switch corresponding to this callback protocol activated. For configuration methods, see Third-party Callback Configuration document.
The direction of the callback is from the Room backend to the App backend via an HTTP POST request.
After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.
Scenarios
App users actively leave the room through the client.
App users are kicked out of the room.
App users are forced to leave the room due to heartbeat expiration.
Callback Trigger Time
After users successfully leave the room.
API Description
Sample Request URL
In the following example, the callback URL configured in the app is
https://www.example.com.
Example:https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request Parameters
Parameter | Description |
https | The request protocol is HTTPS, and the request method is POST |
www.example.com | Callback URL |
SdkAppid | The SDKAppID assigned by the Chat console when an application is created |
CallbackCommand | Fixed as Room.CallbackAfterMemberLeave |
contenttype | Fixed value: JSON |
ClientIP | Client IP, format such as 127.0.0.1 |
OptPlatform | Client platform. For the value, refer to the meaning of the OptPlatform parameter of Webhook Overview: Callback Protocol. |
Sample Request Packets
{"CallbackCommand":"Room.CallbackAfterMemberLeave","Operator_Account":"user1","RoomId":"rid-123","MemberCount":20,"Type":"Leave","MemberList_Account":["user1"],"Reason":"xxxx","EventTime":1670574414123// Millisecond level, event trigger timestamp}
Request Packet Field Description
Field | Type | Description |
CallbackCommand | String | Callback command |
Operator_Account | String | UserID of the requester |
RoomId | String | Room ID |
MemberCount | Integer | Room capacity |
Type | String | Check-out method: Leave (self left); Kicked (kicked out); Expired (heartbeat expired) |
MemberList_Account | Array | Exit room member list |
Reason | String | Reason for check-out |
EventTime | Integer | Event trigger timestamp in milliseconds |
Sample Response Packets
A callback response packet is sent after the app backend synchronizes the data.
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // Ignore callback result}
Response Packet Field Description
Field | Type | Attribute | Description |
ActionStatus | String | Mandatory | The result of the request process. OK for success, FAIL for failure. |
ErrorCode | Integer | Mandatory | Error code, 0 means to ignore the response result |
ErrorInfo | String | Mandatory | Error message |
Reference
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No