变更成员角色

更新时间: 2023/11/08 11:20:44

本文介绍如何变更房间内某一成员的角色。

请求

URI

httpPATCH https://{endpoint}/neroom/v3/rooms/:room_archive_id/users/:user_uuid/role
  • {endpoint} 为 NERoom 接入地址的域名,默认为 roomkit.netease.im。如果您的应用主要服务于海外用户,请将域名设置为海外数据中心域名(roomkit-sg.netease.im)。
  • Content-Type:application/json

请求 Header 的设置请参见 请求结构

路径参数

参数名称 类型 是否必须 描述
room_archive_id String 房间 ID。
user_uuid String 待变更角色的用户 ID。

请求体参数

请求 Body 的字段如下:

参数名称 类型 是否必须 描述
role String 变更后的角色。请通过控制台获取。具体信息请参见如何获取角色 ID
operator_user_uuid String 操作人的用户ID。该参数可以设置为空。
如果您需要通知客户端操作人信息,您可以设置该参数。如果传入了该参数,则会校验操作人的角色是否具备修改他人的角色的权限。角色的权限可通过控制台的模版里设置,具体信息请参见如何修改角色的权限

请求体示例

json{
  "role":"manager",
  "operator_user_uuid":"user***"
}

响应

响应字段

字段名称 类型 描述
code Integer 状态码,0 表示成功。具体含义请参见错误码
msg String 业务结果描述,Success表示成功。
ts Long NERoom 服务器处理该请求的完成时间。 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
cost String 处理该请求所消耗的时间。
request_id String 请求的唯一标识。
data - 无。

响应示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1684374465150,
    "cost": "405ms",
    "request_id": "local_b3d293d26bf74cc1aaca3d589c9d2366",
    "data": null
}

错误码

错误码 错误信息 说明 处理建议
1004 房间不存在。 房间不存在或者已经结束。 检查房间ID(room_archive_id)和房间状态。
403 没有权限操作。 操作人没有权限。 检查操作人(operator_user_uuid)角色的权限或者在控制台给角色加上修改他人的角色的权限。
1015 被操作的成员不存在。 被变更角色的成员不存在或者不在房间内。 检查被变更角色的成员ID(user_uuid)。
此文档是否对你有帮助?
有帮助
去反馈
  • 请求
  • URI
  • Header
  • 路径参数
  • 请求体参数
  • 请求体示例
  • 响应
  • 响应字段
  • 响应示例
  • 错误码