群组/聊天室公告事件

大约 2 分钟

群组/聊天室公告事件

设置或更新群组/聊天室公告后,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调查看公告信息,进行数据同步。

提示

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

回调时机

  1. 客户端设置或更新了群组/聊天室公告。
  2. 调用 RESTful API 设置/更新了群组/聊天室公告。
  3. 环信控制台open in new window设置或更新了群组/聊天室公告。

回调请求

请求示例

{
	"callId": "XXXX#XXXX_b9a9862f-XXXX-XXXX-acf5-8816f0303c7c",
	"security": "de170d1c00XXXX9f294306ec72831d53",
	"payload": {
		"type": "ANNOUNCEMENT",
		"announcement": "公告"
	},
	"appkey": "XXXX#XXXX",
	"id": "262246968131585",
	"type": "GROUP",
	"event": "group_op_event",
	"operation": "UPDATE",
	"operator": "tst",
	"timestamp": 1729496921620
}

请求字段说明

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