创建会议
更新时间: 2024/09/10 18:14:28
通过该接口创建一个会议。
功能描述
创建后的会议状态流转如下图所示。
请求信息
请求 URI
HTTPPUT https://{endpoint}/scene/meeting/api/{appId}/v1/create/{type}
-
{endpoint} 为 网易会议组件接入地址的域名,默认为
roomkit.netease.im
。 -
Content-Type:application/json;charset=utf-8
请求头参数
请求 Header 的参数说明请参考 请求结构。
请求路径参数
参数名称 | 类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
appId | String | 是 | abcdefg**** | 应用的 App Key。获取方式请参考 创建应用并获取 App Key。 |
type | Int | 是 | 1 | 会议类型。
|
请求体参数
参数名称 |
类型 |
是否必选 |
示例 |
描述 |
---|---|---|---|---|
owner | String | 是 | abcdefg**** | 会议拥有人的 ID。 若此参数传空,则使用 host 作为 owner。 |
subject | String | 是 | 随机会议 | 会议主题。 长度限制为 30 字符以内。 |
password | String | 否 | 123456 | 会议密码。 只能填入数字串,长度限制为 4 ~ 6 位。 |
startTime | Long | type = 3:必选。 type = 1:可选。 |
1616738307000 | 预约开始时间。Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的 毫秒 数。 |
endTime | Long | type = 3:必选。 type = 1:可选。 |
1616738347000 | 预约结束时间。Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的 毫秒 数。 |
roomConfigId | Long | 是 | 40 | 固定值为 40。NERoom 应用的房间模版 ID。 |
+ roomConfig | Object | 是 | - | NERoom 应用的房间配置。 |
+ roomProperties | Object | 否 | - | 会议扩展字段。 |
+ recordConfig | Object | 否 | - | 录制配置。 |
externalLiveConfig | Object | 否 | - | 外部 CDN 推拉流地址配置。详细信息请参考 externalConfig 结构。 |
roleBinds | Object | 否 | "abcdefg": "host" | 给对应的成员绑定角色,格式为 "userUuid": **角色名称** 。角色名称包括: |
destroyTime | Long | 否 | 1616738307000 | 会议销毁时间。Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的 毫秒 数。
|
enableJoinBeforeHost | Boolean | 否 | true | 是否允许成员提前加入会议 |
openWaitingRoom |
Boolean |
否 |
true |
是否开启等候室:
|
maxMembers | Integer | 否 | 500 | 会议能容纳的参会人数上限,默认最大 2000。 |
请求体示例
JSON{
"owner": "abcdefghijk",
"subject": "This ia a random meeting.",
"password": "112233",
"roleBinds": {
"yourUserUuid": "host"
},
"roomConfigId": "40",
"roomConfig": {
"resource": {
"whiteboard": true,
"chatroom": true,
"live": true,
"rtc": true,
"sip": true,//true 表示开启,false 表示关闭,默认 false,开启前请确认是否使用了 sip 服务
"record": true
}
}
"roomProperties": {
"extraData":{
"value": "meeting extra data"
}
},
"destroyTime": 17034500012000,
"enableJoinBeforeHost": true,
"openWaitingRoom": true,
"maxMembers":500,
"recordConfig": {
"rtcRecordType": 1,
"rtcAudioRecord": true,
"rtcVideoRecord": true
}
}
响应信息
响应体参数
以下是返回结果中 data
属性内包含的参数。其他统一返回参数的相关说明请参考 返回结果。
参数名称 |
类型 |
示例 |
说明 |
---|---|---|---|
meetingId | Long | 123456**** | 会议唯一 ID。 |
meetingNum | String | 123456789 | 随机会议码(长度为 9 位数字)或个人会议码(长度为 10 位数字)。 |
subject | String | 随机会议。 | 预约会议主题。 |
startTime | Long | 1616738307000 | 预约开始时间。单位为毫秒。 |
endTime | Long | 1616738307000 | 预约结束时间。单位为毫秒,返回值为 -1 表示会议无限期。 |
password | String | 123456 | 会议密码。 |
state |
int |
1 |
会议状态:
|
meetingShortNum | String | 1234 | 会议短号。 |
roomArchiveId | String | 1234567 | neroom 房间 ID。 |
响应体示例
JSON{
"meetingId": "123456****",
"meetingNum": "123456789",
"subject": "This ia a random meeting.",
"startTime": 1616738307000,
"endTime": 1618844844651,
"state": "1",
"meetingShortNum": "1234",
"settings": {
"roomInfo": {
"password": "123455",
"roomConfig": {
"resource": {
"rtc": true,
"chatroom": true,
"live": true,
"whiteboard": false,
"record": true,
"sip": false
}
"roomProperties": {
"extraData": {
"value": "meeting extra data"
}
},
"destroyTime": 1618844844651
}
},
"recordConfig": {
"rtcRecordType": 1,
"rtcAudioRecord": true,
"rtcVideoRecord": true
}
},
"roomArchiveId": "1234567"
}
此文档是否对你有帮助?