音视频通话 2.0
服务端
动态与公告
更新日志
活动与公告
【活动】内容安全检测限时补贴活动
关于RTC反垃圾送检计费变更的说明
新手接入指南
产品简介
产品介绍
功能特性
产品优势
应用场景
基本概念
服务端 API 说明
简介
API 概览
调用方式
数据结构
错误码和状态码
Token 鉴权
基础 Token 鉴权
高级 Token 鉴权
房间管理
房间管理概述
创建房间
查询房间信息
查询活跃房间列表
查询房间在线成员信息
查询房间历史成员信息
移除房间成员
撤销移除房间成员
查询房间移除成员列表
设置房间成员封禁状态
删除房间
房间管理事件抄送
安全通
安全通概述
开通安全通服务
创建安全通审核任务
安全通审核自动打码
查询审核视频截图
查询审核音频断句
停止安全通审核任务
安全通最佳实践
实现音视频安全检测
安全通审核事件抄送
云端播放
云端播放概述
云端播放计费说明
创建云端播放任务
更新云端播放任务
查询云端播放任务
暂停云端播放任务
恢复云端播放任务
销毁云端播放任务
云端播放事件抄送
云端录制
云端录制概述
云端录制计费说明
云端录制的实现流程
创建云端录制任务
录制布局
查询云端录制配置
更新订阅名单
停止录制任务
获取录制文件
云端录制事件抄送
旁路推流
旁路推流概述
实现旁路推流
创建旁路推流任务
旁路推流画面布局
更新旁路推流任务
查询指定旁路推流任务
查询所有旁路推流任务
停止旁路推流任务
旁路推流事件抄送
消息抄送
消息抄送服务概述
开通消息抄送服务
房间管理事件抄送
安全通审核事件抄送
云端播放事件抄送
云端录制事件抄送
旁路推流事件抄送
质量数据监控台
质量数据监控
质量数据分析
质量数据分析案例
常见问题处理

创建房间

更新时间: 2023/04/20 17:34:07

创建音视频房间。

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

注意:服务端创建房间后 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
  • 接口请求频率
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例
  • 错误码