创建房间

更新时间: 2022/09/16 09:57:47

创建白板房间。

创建房间后,房间默认为初始化状态,第一位成员进入房间时,房间转为正常运行状态。

服务端创建房间后 24 小时内,如果无人加入房间,房间会自动销毁。

URL

  • 请求方法:POST
  • URL:https://logic-dev.netease.im/v2/api/room

请求参数

参数名称 类型 是否必选 示例 描述
channelName String 必选 abc 房间名称。
mode Int 必选 2 固定为 2。
uid int64 必选 163 房间创建者的用户 ID,是您的业务系统中的实际用户 ID。
persistent Bool 非必选 false 是否开启房间持久化
channelDestroyTime Number 非必选 0 房间关闭的Unix时间戳,精确到秒,仅对白板房间有效。以创建房间的时间开始,到关闭房间的时间,最长为30个自然日
platform int 非必选 0 房间类型。
  • 0:RTC 房间
  • 2:白板房间

返回参数

参数名称 类型 示例 描述
code int 200 状态码。
cid int64 12345 房间 ID。

示例

请求示例

{
    "channelName": "abc",  
    "mode": 2,               
    "uid": 163,      
    "persistent": true,
    "channelDestroyTime":1656433748  
    "platform": 2,      
}

正常返回示例

{ 
    "code": 200,  
    "cid": 12345   
}

错误码

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码