服务端

创建房间

更新时间: 2024/03/25 11:00:40

创建音视频房间。

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

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

URL

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

接口请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制

请求参数

  • 请求中 Header 的设置请参考请求结构描述。

  • 请求中 Body 须为 JSON 格式,参数说明如下:

参数 类型 是否必选 示例 描述
channelName String 必选 abc 房间名称。字符串格式,长度为 1~64 字节。
支持以下字符类型:
  • 大写英文字母
  • 小写英文字母
  • 数字
  • 空格
  • 特殊字符,支持!#$%&()+-:;≤.,>? @[]^_{|}~”
mode Integer 必选 2 固定为 2。
uid Long 必选 163 房间创建者的用户 ID,是您的业务系统中的实际用户 ID。长度限制为 64 位二进制。

返回参数

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

示例

请求示例

{
    "channelName": "abc",  
    "mode": 2,               
    "uid": 163              
}

正常返回示例

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

错误码

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