跳到主要内容

申请加入群组之前的回调

功能说明​

App 业务服务端可以通过该回调实时查看用户申请加入群组的请求，包括：App 后台可以拦截用户申请加群的操作。

注意事项​

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

可能触发该回调的场景​

  • App 用户通过客户端发起加入群组的请求

回调发生时机​

  • OpenIM Server 准备将用户加入群组之前进行回调（如果需要管理员审批，则在通知管理员之前）。

接口说明​

请求 URL 示例​

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

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

请求参数说明​

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

请求包示例​

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

请求包字段说明​

对象类型描述
callbackCommandstring回调命令，这里是新成员申请进群之前的回调。
operationIDstring唯一操作ID
userIDstring加入群组的用户ID。
groupIDstring群组的唯一标识符。
exstring额外的数据字段。
groupExstring群组额外的数据字段。

应答包示例​

允许加入​

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "Success",
    "errDlt": "",
    "nextCode": 0,
    "roleLevel": 1,
    "ex": "Some extra data"
}

应答包字段说明​

字段值说明
actionCode0表示业务系统的回调是否正确执行。0表示操作成功。
errCode5001表示自定义错误码，范围在5000-9999之间。在 actionCode 不等于0时设置；在 nextCode 等于1时设置。
errMsg"An error message"自定义错误码对应的简单错误信息。
errDlt"Detailed error information"自定义错误码对应的详细错误信息。
nextCode1下一步执行指令，actionCode等于0时设置，1表示拒绝继续执行。
roleLevelint32加入群组用户的权限级别。
exstring额外的数据或信息。