设置参会人数上限
更新时间: 2024/09/06 10:27:31
该接口用于设置一场视频会议能容纳的参会人数上限。
请求信息
- 请求方法:POST
- URL:https://roomkit.netease.im/scene/meeting/api/v1/{meeting_id}/member_limit
- Content-Type:application/json;charset=utf-8
- AppKey:应用的 AppKey。详情请参考 创建应用并获取 AppKey。
- 鉴权头:接口鉴权。详情请参考 请求结构。
请求头参数
请求头(Header)的参数说明,请参考 请求结构。
请求 URL 参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
meeting_id | Long | 是 | 110120119 | 会议唯一 ID。 |
请求体参数
参数名称 |
类型 |
是否必选 |
示例 |
描述 |
---|---|---|---|---|
max | number | 是 | 1000 | 会议的参会人数上限,最高支持 2000。 |
请求体示例
JSON{
"max": 1000
}
响应信息
响应参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
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. | 参数错误 | 检查接口传参 |
404 | Not Found. | 会议不存在 | 检查 meeting_id 传参 |
995 | The maximum must not exceed 2000. | 超过上限 | 检查 max 参数 |
此文档是否对你有帮助?