服务端 API

设置群成员信息

使用 设置群成员信息 从可信后端调用 OpenIM 群组 REST 接口。批量修改群成员昵称、头像、角色和扩展字段。请先在接入准备中配置 API 地址和管理员 Token；接口参数通过请求头和 JSON 请求体传递。

HTTP 请求

POST {API_ADDRESS}/group/set_group_member_info

请求示例

curl --request POST "${API_ADDRESS}/group/set_group_member_info" \
  --header "Content-Type: application/json; charset=utf-8" \
  --header "operationID: ${OPERATION_ID}" \
  --header "token: ${ADMIN_TOKEN}" \
  --data-raw '{
  "members": [
    {
      "groupID": "group_001",
      "userID": "user_002",
      "nickname": "新的群昵称",
      "faceURL": "https://example.com/new-avatar.png",
      "roleLevel": 60,
      "ex": ""
    }
  ]
}'

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

参数

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

请求头

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

请求体

{
  "members": [
    {
      "groupID": "group_001",
      "userID": "user_002",
      "nickname": "新的群昵称",
      "faceURL": "https://example.com/new-avatar.png",
      "roleLevel": 60,
      "ex": ""
    }
  ]
}

参数名	是否必填	类型	说明
members	是	array	要修改的群成员对象列表，字段说明见群组模块的 `GroupMemberInfo`，最多 1000 个。
members.groupID	是	string	目标群 ID。
members.userID	是	string	目标成员用户 ID。
members.nickname	否	string	新的群内昵称。
members.faceURL	否	string	新的群内头像 URL。
members.roleLevel	否	int	群成员角色，参见群组模块的 `GroupMemberRole`；此接口不能设置为群主。
members.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`，并在服务端日志中保留。
参数校验失败	请求体字段类型、必填字段或枚举值不符合接口要求。	对照请求体参数表和限制说明检查字段。

权限和限制

更新群成员资料或角色，并可能触发群成员资料变更通知。
members 必填且最多 1000 个。
members.roleLevel 只能传 60 或 20。
不要通过此接口把成员设置为群主；群主转让应调用转让群主接口。
所有数组型请求参数建议控制在 1000 个元素以内。

HTTP 请求

请求示例

参数

请求头

请求体

响应

响应参数

错误

权限和限制

相关页面