切换麦位模式
更新时间: 2024/11/04 15:22:15
设置指定房间的麦位模式,包括麦位申请审批模式和麦位邀请确认模式。
请求信息
请求组成
HTTPPOST https://{endpoint}/neroom/v3/rooms/:room_archive_id/seat_mode
{endpoint} 为房间组件接入地址的域名:
- 默认为中国大陆地区的
roomkit.netease.im
。 - 如果您的应用主要服务于其他国家或地区用户,请设置为
roomkit-sg.netease.im
。
请求头参数
请求 Header 的设置,请参考 请求结构。
请求 URL 参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
room_archive_id | String | 是 | 4***251 | 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度 36 个字符。 获取方法请参考 创建房间 中的返回参数。 |
请求体参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
apply_mode |
Integer |
否 |
0 |
麦位申请审批模式,不传则保持原值。
|
invite_mode |
Integer |
否 |
0 |
麦位邀请确认模式,不传则保持原值。
|
请求体示例
JSON{
"apply_mode": 0,
"invite_mode": 0
}
响应信息
响应参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
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 | 处理该请求所消耗的时间。 |
响应示例
JSON{
"code": 0,
"msg": "Operation succeeded.",
"ts": 1684374465150,
"cost": "405ms",
"request_id": "local_b3d293d26bf74cc1aaca3d589c9d2366"
}
错误码
错误码 | 错误信息 | 说明 | 处理建议 |
---|---|---|---|
0 | Success | 请求成功 | 无需处理 |
400 | Invalid parameter. | 参数错误 | 检查接口传参 |
1004 | The room does not exist. | 房间不存在 | 检查 room_archive_id 是否正确,或者房间是否已经结束 |
1307 | mic seat not initialized. | 麦位没有初始化 | 检查创建房间参数里的麦位功能是否开启 |
此文档是否对你有帮助?