服务端 API

成员加入群组前

在用户成为群成员前校验或调整成员资料。

触发时机

项目	说明
类型	前置回调
配置项	`beforeMemberJoinGroup`
回调命令	`callbackBeforeMembersJoinGroupCommand`

HTTP 请求

POST {WEBHOOK_ADDRESS}/callbackBeforeMembersJoinGroupCommand
Content-Type: application/json
operationID: {OPERATION_ID}

{
  "callbackCommand": "callbackBeforeMembersJoinGroupCommand",
  "groupID": "group_001",
  "memberList": [
    {
      "userID": "user_002",
      "ex": ""
    }
  ],
  "groupEx": "group_001"
}

请求体参数

参数名	是否必填	类型	说明
callbackCommand	是	string	回调命令，值与当前页面的回调命令一致。
groupID	是	string	群组 ID。
memberList	否	object[]	待加入群组的成员列表。
groupEx	是	string	群组扩展字段。

响应

业务服务端应返回 HTTP 成功状态和 JSON 响应体。

{
  "actionCode": 0,
  "errCode": 0,
  "errMsg": "",
  "errDlt": "",
  "nextCode": 0,
  "memberCallbackList": [{}]
}

响应参数

参数名	类型	说明
actionCode	int	处理状态，参见Webhooks 概述的 `CallbackAction`。
errCode	int	业务错误码；拒绝前置操作时返回业务约定的非零错误码。
errMsg	string	错误简要信息。
errDlt	string	错误详细信息。
nextCode	int	处理下一步，参见Webhooks 概述的 `CallbackNextCode`。
memberCallbackList	object[]	允许修改的群成员资料列表。

处理规则

OpenIM 同步等待业务服务端响应。
返回 nextCode: 0 时继续原流程；返回 nextCode: 1 时，OpenIM 使用响应中的错误信息终止本次操作。
请求失败或超时后的行为由该回调的 failedContinue 配置决定。
响应中的业务字段仅在对应字段存在时覆盖 OpenIM 即将处理的数据。

触发时机

HTTP 请求

请求体参数

响应

响应参数

处理规则

相关页面