用户下麦
更新时间: 2024/11/04 15:22:15
可以通过该接口让指定成员下麦。
请求
URI
POST https://{endpoint}/neroom/v3/rooms/:room_archive_id/seats/kick_user/:user_uuid
- {endpoint} 为 NERoom 接入地址的域名,默认为
roomkit.netease.im
。如果您的应用主要服务于海外用户,请将域名设置为海外数据中心域名(roomkit-sg.netease.im
)。 - Content-Type:application/json
Header
请求 Header 的设置请参见 请求结构。
路径参数
路径参数说明如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
room_archive_id | String | 是 | 4***251 | 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度 36 个字符。 获取方法请参见 创建房间 中的返回参数。 |
user_uuid | String | 是 | ryi***cyu | 下麦的用户 ID。 |
请求示例
curl --request POST 'https://roomkit.netease.im/neroom/v3/rooms/123/seats/kick_user/abc' \
--header 'AppKey: xxx' \
--header 'Nonce: xxx' \
--header 'CurTime: 1677050511' \
--header 'CheckSum: xxx' \
--header 'Content-Type: application/json' \
响应
响应参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 状态码,0 表示成功,具体请参见 错误码。 |
msg | String | Success | 业务结果描述,Success 表示成功。 |
ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。 |
request_id | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识。 |
cost | String | 48ms | 处理该请求所消耗的时间。 |
响应示例
{
"code":0,
"msg":"Success",
"ts":1619068087795,
"request_id":"6e507107d1f4447ea731f651dc6d2432",
"cost":"66ms"
}
错误码
错误码 | 错误信息 | 说明 | 处理建议 |
---|---|---|---|
0 | Success. | 请求成功 | 无需处理 |
400 | Invalid parameter. | 参数错误 | 检查接口传参 |
1004 | Room not found. | 房间不存在或者已关闭 | 根据业务场景处理 |
此文档是否对你有帮助?