服务端 API

申请加入群组

使用 申请加入群组 从可信后端调用 OpenIM 群组 REST 接口。提交入群申请；如果群组允许直接加入，服务端会直接写入成员关系。请先在接入准备中配置 API 地址和管理员 Token；接口参数通过请求头和 JSON 请求体传递。

HTTP 请求

POST {API_ADDRESS}/group/join_group

请求示例

curl --request POST "${API_ADDRESS}/group/join_group" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "groupID": "group_001",
  "reqMessage": "申请加入群组",
  "joinSource": 3,
  "inviterUserID": "user_002",
  "ex": ""
}'

安全提示：管理员 Token 只能保存在可信后端服务中，不能下发到客户端或写入前端代码。客户端登录应使用服务端签发的用户 Token。

参数

此接口通过请求头传入链路追踪信息和鉴权凭证，通过 JSON 请求体传递业务参数。

请求头

Header	是否必填	类型	说明
operationID	是	string	每次请求的唯一链路追踪 ID，建议由后端生成并写入日志。
token	是	string	APP 管理员 Token；仅保存在可信后端服务中。
Content-Type: application/json	是	string	请求体为 JSON 时必须设置。

请求体

{
  "groupID": "group_001",
  "reqMessage": "申请加入群组",
  "joinSource": 3,
  "inviterUserID": "user_002",
  "ex": ""
}

参数名	是否必填	类型	说明
groupID	是	string	目标群 ID。
reqMessage	否	string	申请说明。
joinSource	是	int	入群来源，参见群组模块的 `JoinSource`。
inviterUserID	是	string	申请加入群组的用户 ID；当前服务端沿用该字段名承载申请用户。
ex	否	string	扩展字段。

响应

请求被 OpenIM 正常处理时通常返回 200 OK。业务是否成功以响应体中的 errCode 为准；errCode === 0 表示成功，非 0 表示业务错误。

{
  "errCode": 0,
  "errMsg": "",
  "errDlt": ""
}

响应参数

参数名	类型	说明
errCode	int	业务错误码，0 表示成功。
errMsg	string	错误简要信息，成功时通常为空。
errDlt	string	错误详细信息，成功时通常为空。

错误

如果请求失败，OpenIM 返回错误对象。更多错误码说明见错误码。

{
  "errCode": 1004,
  "errMsg": "RecordNotFoundError",
  "errDlt": ": [1004]RecordNotFoundError"
}

错误场景	可能原因	处理方式
鉴权失败	`token` 缺失、过期，或不是可调用管理端接口的管理员 Token。	重新获取 APP 管理员 Token，并只在可信后端保存。
链路追踪困难	`operationID` 缺失或在大量请求中重复使用。	为每次请求生成独立 `operationID`，并在服务端日志中保留。
参数校验失败	请求体字段类型、必填字段或枚举值不符合接口要求。	对照请求体参数表和限制说明检查字段。

权限和限制

根据群验证策略创建入群申请或直接加入群组，并可能触发入群申请或成员加入通知。
groupID 和 inviterUserID 必填。
joinSource 只能为 1、2、3 或 4。
所有数组型请求参数建议控制在 1000 个元素以内。

HTTP 请求

请求示例

参数

请求头

请求体

响应

响应参数

错误

权限和限制

相关页面