跳到主要内容

邀请新成员加入群组之前的回调

功能说明​

邀请新成员加入群组前，业务服务端可拒绝此请求，或对请求做修改和干预。

注意事项​

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

可能触发该回调的场景​

  • 用户通过客户端或APP管理员通过REST API进行相应操作前

回调发生时机​

  • 邀请新成员加入群组之前。

接口说明​

请求 URL 示例​

此处CallbackCommand为：callbackBeforeInviteJoinGroupCommand

{WEBHOOK_ADDRESS}/callbackBeforeInviteJoinGroupCommand?contenttype=json

请求包示例​

{
  "callbackCommand": "callbackBeforeInviteJoinGroupCommand",
  "operationID": "1646445464564",
  "groupID": "12345",
  "reason": "friend",
  "invitedUserIDs": "[user1,user2]"
}

请求包字段说明​

对象类型描述
callbackCommandstring回调命令，这里是邀请好友加入群组之前的回调。
operationIDstringoperationID用于全局链路追踪
groupIDstring群组的唯一标识符。
reasonstring邀请理由
invitedUserIDsstring[]加入群组的用户ID。

应答包示例​

允许创建​

允许用户加入群组。

{
    "actionCode": 0,
    "errCode": 0,
    "errMsg": "",
    "errDlt": "",
    "nextCode": 0,
    "invitedUserIDs": "[user1,user2]"
}

应答包字段说明​

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