群组/聊天室加人事件

大约 4 分钟

群组/聊天室加人事件

在群组或聊天室创建时拉人进入、邀请用户加入、或用户申请加入时,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调进行数据同步。

提示

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

直接加入

回调时机

  • 客户端创建群组或聊天室时直接将用户拉入群。
  • 调用 RESTful API 创建群组或聊天室时直接将用户拉入群。

回调请求

请求示例

下面的请求示例为创建群组时拉人的事件,创建聊天室的字段与其相同。

{
	"callId": "XXXX#XXXX_34092a82-XXXX-XXXX-aa2e-aefeb0bb5a65",
	"security": "0b787dc5dXXXXdeb1e9ffe8803d01eaa",
	"payload": {
		"member": [
			"tst01"
		],
		"type": "DIRECT"
	},
	"appkey": "XXXX#XXXX",
	"id": "262246968131585",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "JOIN",
	"operator": "@ppAdmin",
	"timestamp": 1729497286675
}

请求字段说明

以下以创建群组时拉人的事件为例进行介绍,聊天室的字段与其相同。

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

邀请用户入群

回调时机

普通群成员通过客户端邀请用户加入群组。

聊天室无此事件。

回调请求

请求示例

{
	"callId": "XXXX#XXXX_643c3149-f7cc-4492-8341-c7473ee63f86",
	"security": "1ed483cf9cXXXXb78f99c1e0c4292d41",
	"payload": {
		"member": [
			"tst0"
		],
		"type": "INVITE"
	},
	"appkey": "XXXX#XXXX",
	"id": "262424566497281",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "JOIN",
	"operator": "tst0",
	"timestamp": 1729665977191
}

请求字段说明

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

申请加入

用户通过客户端申请加入群组/聊天室。

回调请求

请求示例

下面以用户申请加入群组的事件为例进行介绍,聊天室的字段与其相同。

{
	"callId": "XXXX#XXXX_c158594d-1165-4641-8336-68125ba68a22",
	"security": "1824c552acXXXXb0bf1c80160c65a1d0",
	"payload": {
		"member": [
			"tst"
		],
		"type": "APPLY"
	},
	"appkey": "XXXX#XXXX",
	"id": "261958837272578",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "JOIN",
	"operator": "tst",
	"timestamp": 1729497831163
}

请求字段说明

下面以用户申请加入群组的事件为例进行介绍,聊天室的字段与其相同。

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