屏蔽/解除屏蔽群组事件

大约 3 分钟

屏蔽/解除屏蔽群组事件

成功屏蔽/解除屏蔽群组后,环信服务器会按照发送后回调规则向你的 App Server 发送回调请求,App Server 可通过该回调查看群组屏蔽/解除屏蔽的信息,进行数据同步。

提示

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

屏蔽群组

回调时机

客户端屏蔽群组。

回调请求

请求示例

{
    "callId": "XXXX#XXXX_a64cbdc6-XXXX-XXXX-81b0-b64285c5f711",
    "security": "eed92d60XXXXa3f30c39b111fc0dfffa",
    "payload": {
        "type": "ADD"
    },
    "appkey": "XXXX#XXXX",
    "id": "test_123",
    "type": "GROUP",
    "event": "group_op_event",
    "operation": "SHIELD",
    "operator": "wzy",
    "timestamp": 1732518372734
}

请求字段说明

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

解除屏蔽群组

回调时机

客户端解除屏蔽群组。

回调请求

请求示例

{
    "callId": "XXXX#XXXX_124b1da0-XXXX-XXXX-8b2f-d5d376c3ad16",
    "security": "895b3f0dfXXXX0a8efb6104d67232961",
    "payload": {
        "type": "REMOVE"
    },
    "appkey": "XXXX#XXXX",
    "id": "test_123",
    "type": "GROUP",
    "event": "group_op_event",
    "operation": "SHIELD",
    "operator": "wzy",
    "timestamp": 1732518426833
}

请求字段说明

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