将群组/聊天室成员加入或移出白名单的事件

大约 3 分钟

将群组/聊天室成员加入或移出白名单的事件

将群组/聊天室成员加入或移出白名单后,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调查看添加或移出白名单的成员,进行数据同步。

提示

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

将成员加入白名单

回调时机

  1. 客户端将群组/聊天室成员加入白名单。
  2. 调用 RESTful API 将群组/聊天室成员加入白名单。

回调请求

请求示例

{
	"callId": "XXXX#XXXX_763084e9-XXXX-XXXX-b550-9196e3163b6b",
	"security": "8131be530aXXXX9108ee0411958b91b9",
	"payload": {
		"member": [
			"tst01"
		],
		"type": "ADD"
	},
	"appkey": "XXXX#XXXX",
	"id": "255445981790209",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "WHITE",
	"operator": "@ppAdmin",
	"timestamp": 1729499291465
}

请求字段说明

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

将成员移出白名单

回调时机

  1. 客户端将群组/聊天室成员移出白名单。
  2. 调用 RESTful API 将群组/聊天室成员移出白名单。

回调请求

请求示例

{
	"callId": "XXXX#XXXX_7907fe50-15c1-493e-9774-4a628c050fc9",
	"security": "2f73f64eXXXX1f86e9db9ab6ffe746f4",
	"payload": {
		"member": [
			"tst01",
			"tst02"
		],
		"type": "REMOVE"
	},
	"appkey": "XXXX#XXXX",
	"id": "255445981790209",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "WHITE",
	"operator": "@ppAdmin",
	"timestamp": 1729499336703
}

请求字段说明

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