跳到主要内容

新成员加入群组之后的回调

功能说明​

App 业务服务端可以通过该回调实时查看群成员加入的消息，包括：通知 App 后台成员入群，App 可以据此进行必要的数据同步。

注意事项​

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

可能触发该回调的场景​

  • App 用户通过客户端申请加入群组并得到通过。
  • App 用户通过客户端成功拉其他人加入群组。
  • App 管理员通过 REST API 添加用户到群组。

回调发生时机​

  • 用户主动申请成功加入群组之后。
  • 用户被其他成员邀请并成功加入群组之后。
  • 用户被管理员通过 REST API 添加到群组之后。

接口说明​

请求 URL 示例​

以下示例中 App 配置的回调 URL 为 http://www.example.com/callbackCommand?contenttype=json。

http://www.example.com/CallbackAfterMemberJoinGroupCommand?contenttype=json

请求参数说明​

参数说明
http请求协议为 HTTP，请求方式为 POST
www.example.comconfigy.yaml 中的 callback.url 字段，域名或主机名
CallbackCommand此处为：CallbackAfterMemberJoinGroupCommand
contenttype固定值为：JSON
header名示例值选填类型说明
operationID1646445464564必填stringoperationID用于全局链路追踪

请求包示例​

{
  "callbackCommand": "CallbackAfterMemberJoinGroupCommand",
  "groupID": "12345",
  "userID": "user789",
  "ex": "Extra data",
  "groupEx": "GroupExtra data"
}

请求包字段说明​

对象类型描述
callbackCommandstring回调命令，这里是创建群组之前的回调。
userIDstring加入群组的用户ID。
groupIDstring群组的唯一标识符。
exstring额外的数据字段。
groupExstring群组额外的数据字段。

应答包示例​

App 后台同步数据后，发送回调应答包

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "Success",
    "errDlt": "",
    "nextCode": 1
}

应答包字段说明​

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