移出房间成员
更新时间: 2024/11/04 15:22:15
将用户从房间移出。
使用场景:在内容安全审核等场景中,如果发现某个成员涉嫌违规,您需要将该成员强制移出房间,您可以调用该接口实现。服务端使用 checkSum 鉴权后,调用该接口具有超级管理员权限,对本产品下的所有房间成员具有移出权限。
接口请求地址
- 请求方法:DELETE
- URL:https://roomkit.netease.im/apps/v2/room-user?roomArchiveId={roomArchiveId}&userUuid={userUuid}
URL 中参数说明
请求 Header 的设置请参见 请求结构。
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
roomArchiveId | String | 是 | 4***251 | 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度36个字符。 获取方法请参见创建房间 中的返回参数。 |
userUuid | String | 是 | yunxinuser01 | 用户 ID,用于唯一标识某个用户 |
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | int | 0 | 状态码,0 表示成功,具体请参见错误码。 |
msg | String | Success | 业务结果描述,Success表示成功。 |
ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。 |
requestId | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识。 |
cost | String | 48ms | 处理该请求所消耗的时间。 |
示例
请求示例
javahttps://roomkit.netease.im/apps/v2/room-user?roomArchiveId=133456&&userUuid=yunxinuser01
返回示例
java{
"code":0,
"msg":"Success",
"ts":1619068087795,
"requestId":"6e507107d1f4447ea731f651dc6d2432",
"cost":"66ms"
}
此文档是否对你有帮助?