群组/聊天室成员离开事件

大约 4 分钟

群组/聊天室成员离开事件

在群组或聊天室中的成员离开时,包括主动退出、被踢出以及被加入群组/聊天室黑名单时退出,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调查看离开的成员,进行数据同步。

提示

  1. 你所使用的环信即时通讯 IM 的版本可能需要单独开通回调服务,详见增值服务说明
  2. 如果需要群组/聊天室成员离开的回调事件,你需要在环信控制台open in new window设置发送后回调规则,详见配置回调规则
  3. 发送后回调的相关介绍,详见回调说明

主动退出

回调时机

  1. 通过客户端主动退出群组/聊天室。
  2. 由于网络等原因,用户离线 2 分钟后退出聊天室。

回调请求

以下以主动退出群组的事件为例进行介绍,聊天室的字段与其相同。

请求示例

{
	"callId": "XXXX#XXXX_e90431f3-XXXX-XXXX-9bbb-231c371c7acb",
	"security": "e452d25366abXXXX2138fffa4b06726a",
	"payload": {
		"member": [
			"tst"
		],
		"type": "QUIT"
	},
	"appkey": "XXXX#XXXX",
	"id": "261958837272578",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "LEAVE",
	"operator": "tst",
	"timestamp": 1729497862844
}

请求字段说明

字段名称类型描述
callIdStringcallId 为每个回调请求的唯一标识,格式为 App Key_UUID
securityString签名,格式如下: MD5(callId+secret+timestamp)。详见配置环信控制台回调规则
payloadObject事件内容。
payload.memberJSON退出群组/聊天室的用户 ID。
payload.typeArray退群方式:QUIT 表示主动退出群组或聊天室或者因离线退出聊天室。
appkeyString你在环信管理后台注册的应用唯一标识。
idString群组/聊天室 ID。
typeString区分群组或聊天室事件:
- GROUP:群组
- CHATROOM :聊天室
eventString对于群组和聊天室,该参数的值固定为 group_op_event。接收方可按此字段区分是否是群组/聊天室操作事件。
operationString操作。用户主动退出群组/聊天室的操作为 LEAVE
operatorString操作人。
timestampLong操作完成的时间戳。

被踢

回调时机

  1. 通过客户端将用户踢出群组/聊天室。
  2. 调用 RESTful API 将用户踢出群组/聊天室。
  3. 环信控制台open in new window将用户踢出群组/聊天室。

回调请求

请求示例

{
	"callId": "XXXX#XXXX_3667067f-ac06-XXXX-96aa-a9a708c3b361",
	"security": "b77b545b538XXXXbb72e4cf2395050c3",
	"payload": {
		"member": [
			"tst01"
		],
		"type": "KICK"
	},
	"appkey": "XXXX#XXXX",
	"id": "254636824002561",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "LEAVE",
	"operator": "tst",
	"timestamp": 1729497896834
}

请求字段说明

字段名称类型描述
callIdStringcallId 为每个回调请求的唯一标识,格式为 App Key_UUID
securityString签名,格式如下: MD5(callId+secret+timestamp)。详见配置环信控制台回调规则
payloadObject事件内容。
payload.memberJSON被踢出群组/聊天室的用户 ID。
payload.typeArray退群方式:KICK 表示将用户踢出群组/聊天室。
appkeyString你在环信管理后台注册的应用唯一标识。
idString群组/聊天室 ID。
typeString区分群组或聊天室事件:
- GROUP:群组
- CHATROOM :聊天室
eventString对于群组和聊天室,该参数的值固定为 group_op_event。接收方可按此字段区分是否是群组/聊天室操作事件。
operationString操作。将用户踢出群组/聊天室的操作为 LEAVE
operatorString操作人。
timestampLong操作完成的时间戳。

加入黑名单后退出

回调时机

  1. 通过客户端将用户加入群组/聊天室黑名单时退出群组/聊天室。
  2. 调用 RESTful API 将用户加入群组/聊天室黑名单时退出群组/聊天室。
  3. 环信控制台open in new window将用户加入群组/聊天室黑名单时退出群组/聊天室。

回调请求

请求示例

{
	"callId": "XXXX#XXX_7dc24fac-3451-421e-a8aa-70ba0587e69d",
	"security": "9b30e4c2bXXXXcd51ef730836d427965",
	"payload": {
		"member": [
			"tst02"
		],
		"type": "BLOCK"
	},
	"appkey": "XXXX#XXX",
	"id": "255445981790209",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "LEAVE",
	"operator": "tst",
	"timestamp": 1729498876236
}

请求字段说明

字段名称类型描述
callIdStringcallId 为每个回调请求的唯一标识,格式为 App Key_UUID
securityString签名,格式如下: MD5(callId+secret+timestamp)。详见配置环信控制台回调规则
payloadObject事件内容。
payload.memberJSON被加入群组/聊天室黑名单后离开的用户 ID。
payload.typeArray退群方式:BLOCK 表示加入群组/聊天室黑名单后离开群组/聊天室。
appkeyString你在环信管理后台注册的应用唯一标识。
idString群组/聊天室 ID。
typeString区分群组或聊天室事件:
- GROUP:群组
- CHATROOM :聊天室
eventString对于群组和聊天室,该参数的值固定为 group_op_event。接收方可按此字段区分是否是群组/聊天室操作事件。
operationString操作。将用户踢出群组/聊天室的操作为 LEAVE
operatorString操作人。
timestampLong操作完成的时间戳。