Docs Overview/
Conference/
Web/
服务器 API/
Third-Party Callback/
User Related/
After a Room Is Left/

After a Room Is Left

功能说明

App 后台可以通过该回调实时查看房间成员退出的消息，包括：通知 App 后台有成员退出房间，App 可以据此进行必要的数据同步。

注意事项

要启用回调，必须配置回调 URL，并打开本条回调协议对应的开关，配置方法详见 第三方回调配置 文档。
回调的方向是 Room 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后，务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。

可能触发该回调的场景

App 用户通过客户端主动退出房间。
App 用户被踢出房间。
App 用户心跳过期导致退出房间。

回调发生时机

用户退出房间成功之后。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为https://www.example.com。 示例：
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数
说明
https
请求协议为 HTTPS，请求方式为 POST
www.example.com
回调 URL
SdkAppid
创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand
固定为 Room.CallbackAfterMemberLeave
contenttype
固定值为 JSON
ClientIP
客户端 IP，格式如：127.0.0.1
OptPlatform
客户端平台，取值参见 第三方回调简介：回调协议 中 OptPlatform 的参数含义

请求包示例

{
  "CallbackCommand":"Room.CallbackAfterMemberLeave",
  "Operator_Account":"user1",
  "RoomId":"rid-123",
  "MemberCount":20,

  "Type":"Leave", 
  "MemberList_Account":["user1"],
  "Reason":"xxxx",
  "EventTime":1670574414123//毫秒级别，事件触发时间戳
}

请求包字段说明

字段
类型
说明
CallbackCommand
String
回调命令
Operator_Account
String
发起请求的操作者 UserID
RoomId
String
房间 ID
MemberCount
Integer
房间人数
Type
String
退房方式：Leave(自己离开)；Kicked(被踢)；Expired(心跳过期)
MemberList_Account
Array
退出房间成员列表
Reason
String
退房原因
EventTime
Integer
事件触发的毫秒级别时间戳

应答包示例

App 后台同步数据后，发送回调应答包。
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 忽略回调结果
}

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
必填
错误码，此处填0表示忽略应答结果
ErrorInfo
String
必填
错误信息

参考

第三方回调简介