创建房间
更新时间: 2024/01/19 06:02:08
本文介绍如何调用服务端接口创建房间。相比于客户端创建房间的接口,如果您需要在您的业务系统中保存创建房间后的相关房间信息,您可以使用该服务端创建房间的接口。
注意:创建房间后 24 小时内,如果无人加入房间,房间会自动销毁。
接口请求地址
- 请求方法:PUT
- URL:https://roomkit.netease.im/apps/v2/room
请求参数
- 请求 Header 的设置请参见调用方式中的请求结构。
- 请求 Body 的设置如下:
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
templateId | Long | 是 | 23 | 模板ID ,模板 ID获取方法请参见如何获取模板 ID。 |
roomUuid | String | 否 | NE***10 | 房间ID,最大长度64个字符,传空值,则随机生成一个房间ID。 支持以下字符类型:
|
roomName | String | 是 | Example | 房间名,最大长度为 64 个字符。支持以下字符类型:
|
password | String | 否 | Example123456 | 房间密码,最大长度为64个字符。支持以下字符类型:
|
roomConfig | JsonObject | 否 | - | 配置待创建的 NERoom 房间开启哪些功能,不配置则使用默认房间配置。详细信息请参考 roomConfig.resource 结构。 |
externalLiveConfig | JsonObject | 否 | - | 配置 CDN 推拉流地址。详细信息请参考 externalLiveConfig 结构。 |
roomSeatConfig | JsonObject | 否 | - | 设置麦位的初始化配置。具体请参见roomSeatConfig结构。 |
数据结构
roomConfig.resource
NERoom 的房间配置。
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
whiteboard | Boolean | 可选 | true | 设置该房间是否包含白板功能。 |
chatroom | Boolean | 可选 | true | 设置该房间是否包含聊天室功能。 |
live | Boolean | 可选 | true | 设置该房间是否包含直播功能。 |
rtc | Boolean | 可选 | true | 设置该房间是否包含音视频功能。 |
sip | Boolean | 可选 | true | 设置该房间是否开启 sip。 |
record | Boolean | 可选 | true | 设置该房间是否开启录制。 |
seat | Boolean | 可选 | true | 设置是否开启麦位管理。 |
externalLiveConfig
直播功能的推拉流地址配置。
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
pushUrl | String | 必选 | rtmp://sample.live.net/live/b54*** | 推流地址。最大长度支持 512 字节。 |
pullHlsUrl | String | 可选,但必须至少选择其中一种拉流地址 | http://sample.live.net/live/34a***/playlist.m3u8 | hls 拉流地址。最大长度支持 512 字节。 |
pullRtmpUrl | String | rtmp://sample.live.net/live/451*** | rtmp 拉流地址。最大长度支持 512 字节。 | |
pullHttpUrl | String | http://sample.live.net/live/b5r***.flv?sample.live.net | http 拉流地址。最大长度支持 512 字节。 | |
pullRtsUrl | String | rtmp://sample.live.net/live/a27*** | rts 拉流地址。最大长度支持 512 字节。 |
roomSeatConfig
房间麦位信息配置。
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
seatCount | Integer | 是 | 8 | 麦位的数量。默认为 8。最多20个麦位。 |
applyMode | Integer | 否 | 0 | 麦位申请审批模式。
|
inviteMode | Integer | 否 | 0 | 麦位邀请确认模式。
|
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
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 | 处理该请求所消耗的时间。 |
data | Object | - | 创建房间的结果 |
data.roomArchiveId | String | 4***251 | 归档到历史记录中的房间 ID,全局唯一,最大长度36个字符 |
示例
请求示例
java
{
"templateId":40,
"roomUuid":"8978634332",
"roomName":"Example",
"password":"Example123456",
"roomConfig": {
"resource": {
"whiteboard": true,
"chatroom": true,
"live": true,
"rtc": true,
"sip": true,
"record": true,
"seat": true
}
},
"externalLiveConfig":{
"pushUrl":"****",
"pullRtmpUrl":"****",
"pullRtsUrl":"****"
},
"roomSeatConfig":{
"seatCount":8,
"applyMode":0,
"inviteMode":0
}
}
返回示例
java{
"code":0,
"msg":"Success",
"ts":1619068087795,
"requestId":"6e507107d1f4447ea731f651dc6d2432",
"cost":"66ms",
"data":{
"roomArchiveId":"136584"
}
}
此文档是否对你有帮助?