Conference
  • 概要
    • 製品導入
    • サービスをアクティブ化します
    • 価格
      • 無料時間
      • TRTC Conference の月額パッケージ
      • サブスクリプションパッケージ期間の課金説明
  • 始めましょう
    • Demo のクイックスタート
    • インテグレーション
    • UserSig による安全な認証
  • 基本機能
    • 予約会議
    • 会議管理
    • UI のカスタマイズ
    • クラウドレコーディング
    • ロボットプッシュ
    • AI ノイズ低減
  • その他の機能
    • 部屋のパスワード
    • 基本的な美顔
    • ニックネームとアバターを設定する
    • ルームでのチャット
    • 仮想背景
    • 文字の透かし
  • インターフェースドキュメンテーション
    • RoomKit インターフェース
    • RoomEngine インターフェース
      • インターフェースの概要
      • TUIRoomEngine
      • TUIRoomEvents
      • TUIRoomEngine の定義
  • サーバー API
    • RESTful インターフェース
      • RESTful インターフェースの概要
      • RESTful インターフェースリスト
      • Room Management
        • Create a Room
        • Destroy a Room
        • Update the Room Information
        • Get the Room Information
      • ユーザー管理
        • Get the Room Member List
        • Update the Room Member Information
        • Change the Room Ownership
        • Mark Room Members
        • Ban Room Members
        • Unban Room Members
        • Get the Banned Room Member List
        • Remove Room Member
      • Seat Management
        • Get the Seat List
        • Pick User on the Seat
        • Kick User off the Seat
        • Lock the Seat
    • Third-Party Callback
      • Callback Overview
      • Callback Command List
      • Callback Configuration
        • Query Callback Configuration
        • Create Callback Configuration
        • Update Callback Configuration
        • Delete Callback Configuration
      • Room Related
        • After a Room Is Created
        • After a Room Is Destroyed
        • After the Room Information Is Updated
      • User Related
        • After a Room Is Entered
        • After a Room Is Left
      • Seat Connection Related
        • After the Seat List Is Changed
  • よくあるご質問
  • Error Code
Conference
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

After a Room Is Left

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



コミュニティに質問しよう!
技術的な議論を始め、すぐに専門家のサポートを受けよう!