跳到主要内容

移除黑名单用户的回调

功能说明

App 业务服务端可以通过该回调处理用户移除黑名单的请求,包括:对用户退群进行实时记录(例如记录日志,或者同步到其他系统)。

注意事项

  • 为启用回调,必须配置回调 URL,并开启本条回调协议对应的开关。配置方法详见 回调说明 文档。
  • 回调的方向是 OpenIM Server 向 App 后台发起 HTTP/HTTPS POST 请求。
  • APP 业务服务端需在超时时间内响应此请求。

可能触发该回调的场景

  • App 用户通过客户端尝试从黑名单中移除其他用户。

回调发生时机

  • OpenIM Server 收到移除黑名单用户的请求之后,处理该请求前。

接口说明

请求 URL 示例

此处CallbackCommand为:callbackAfterRemoveBlackCommand

{WEBHOOK_ADDRESS}/callbackAfterRemoveBlackCommand?contenttype=json

请求包示例

{
"callbackCommand": "callbackAfterRemoveBlackCommand",
"ownerUserID": "user123",
"blackUserID": "user456"
}

请求包字段说明

字段类型描述
callbackCommandstring回调命令,这里是移除黑名单用户的回调
ownerUserIDstring发起移除黑名单请求的用户ID
blackUserIDstring被移除出黑名单的用户ID

应答包示例

允许移除

允许用户移除指定用户出黑名单。

{
"actionCode": 0,
"errCode": 0,
"errMsg": "",
"errDlt": "",
"nextCode": "nextCodeValue"
}

应答包字段说明

字段说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode0表示自定义错误码,此处填0代表忽略回调结果。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令,1表示拒绝继续执行,actionCode等于0时设置。