创建会议

更新时间: 2025/08/15 17:58:06

通过该接口预约一场会议,或者立即开始一场会议。创建后的会议状态流转如下图所示。

会议状态.png

请求信息

请求 URI

HTTPPUT https://{endpoint}/scene/meeting/api/{appId}/v1/create/{type}
  • {endpoint} 为 网易会议组件接入地址的域名,默认为 roomkit.yunxinapi.com

  • Content-Type:application/json;charset=utf-8

请求头参数

请求 Header 的参数说明请参考 请求结构

请求路径参数

参数名称 类型 是否必选 示例 说明
appId String abcdefg**** 应用的 App Key。获取方式请参考 创建应用并获取 App Key
type Int 1 会议类型。
  • 1:使用随机号创建的即时会议。
  • 2:使用个人号创建的即时会议。
  • 3:使用随机号预约的会议。

请求体参数

参数名称
类型
是否必选
示例
描述
owner String abcdefg**** 会议拥有者的 userUuid。
若此参数传空,则使用 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 秒开始到事件发生时的 毫秒 数。
destroyTime Long 1616738307000 会议销毁时间。Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的 毫秒 数。与 endTime 不同的是,destroyTime 会在预设的时间点强行结束会议。设置会议销毁时间后,在到达对应时刻的前 10 分钟、5 分钟、1 分钟会各提醒一次,提醒时间持续 1 分钟。
  • 会议销毁时间最晚为会议开始之后的 24 小时内。
  • 如果是预约会议,会议销毁时间不能早于预约会议的结束时间(endtime)。
roomConfigId Long 40 固定值为 40。NERoom 应用的房间模板 ID。
- roomConfig Object - NERoom 应用的房间配置。
- resource Object - NERoom 应用的房间配置。
whiteboard Boolean true 是否创建白板。
  • true(默认):是。
  • false:否。
  • chatroom Boolean true 是否创建聊天室。
  • true(默认):是。
  • false:否。
  • live Boolean true 是否创建主播间。
  • true:是。
  • false(默认):否。
  • rtc Boolean true 是否创建音视频房间。
  • true(默认):是。
  • false:否。
  • sip Boolean true 是否开启 sip。
  • true:是。
  • false(默认):否。
  • record Boolean true 是否录制。
  • true:是。
  • false(默认):否。
  • waitingRoom Boolean true 是否为会议增加等候室资源。
    • true(默认):增加。
    • false:不增加。
    如果您在一个会议中开启了等候室,则会增加一个聊天室占用。此时,一个会议会占用两个聊天室,应用对应的 AppKey 同时开会的数量则会减少。默认会议结束就关闭聊天室。有关什么是聊天室,请参考 聊天室功能概述
    - roomProperties Object - 会议扩展字段。
    - guest Object - 访客入会配置。
    value Number 1 是否开启访客入会,1=开启访客入会,0=不开启访客入会。
    - extraData Object - 会议扩展字段。
    value String - 会议扩展字段。
    - securityCtrl Object - 会议安全控制设置。
    value String "4112" 会议安全控制权限值,表示会议安全控制的各项权限设置,默认值为 0(即 000000000000000)。每一位二进制位表示一种特定权限的开关状态,以下是从右往左起各二进制位所代表的权限:
    • 第 1 位(0x1 << 0):禁用批注功能
    • 第 2 位(0x1 << 1):禁用屏幕共享功能
    • 第 3 位(0x1 << 2):禁用白板共享功能
    • 第 4 位(0x1 << 3):禁用自己改名功能
    • 第 5 位(0x1 << 4):开启全体静音
    • 第 6 位(0x1 << 5):禁止自行解除静音
    • 第 7 位(0x1 << 6):开启全体关闭视频
    • 第 8 位(0x1 << 7):禁止自行打开视频
    • 第 9 位(0x1 << 8):禁用表情回复功能
    • 第 10 位(0x1 << 9):空闲位,暂未使用
    • 第 11 位(0x1 << 10):开启成员加入离开提示音
    • 第 12 位(0x1 << 11):隐藏头像显示
    • 第 13 位(0x1 << 12):开启智能会议纪要
    • 第 14 位(0x1 << 13):本地录制权限控制 1
    • 第 15 位(0x1 << 14):本地录制权限控制 2
    使用示例:要同时开启全体静音(第 5 位)和智能会议纪要(第 13 位),计算方式为 001000000010000,十进制为 4112,则 securityCtrl.value 应设置为 "4112"
    - recordConfig Object - 录制配置。
    rtcRecordType Integer 0 录制类型。支持如下三种模式:
    • 0:合流+单流录制(默认)。将会议房间内订阅的媒体流,混合录制为一个媒体文件,同时每个用户 UID 均有其对应的媒体文件。
    • 1:合流录制。将会议房间内订阅的媒体流混合录制为一个媒体文件。
    • 2:单流录制。分开录制房间内每个用户 UID 的媒体流,每个 UID 均有其对应的媒体文件。
    • 100:模板文件集合模式
      • 合流录制模式存在用户画面上限,最多支持 9 个用户画面。
      • 请在开始录制的时候,设置录制模式,开始录制后,不支持切换录制模式。
    rtcAudioRecord Boolean true 是否开启音频录制,默认开启。
    rtcVideoRecord Boolean true 是否开启视频录制,默认开启。
    enableSmartRecording Boolean true true: 开启智能录制。false: 关闭智能录制。默认关闭。
    enableTranscript Boolean false true: 自动开启转写。false: 关闭自动转写。默认关闭。
    recordStrategy Number 0 录制策略,默认不自动录制。
    0:主持人加入房间开始录制
    1:成员加入房间开始录制
    modeList Array [0,1,2] 录制模式列表:
    0:单流录制
    1:录制带有共享屏幕的画廊视图
    2:录制带有共享屏幕的当前演讲者
    3:单独录制当前演讲者
    4:单独录制画廊视图
    5:单独录制屏幕共享
    6:录制单独音频文件
    注意:rtcRecordType必须配置100,录制模式才会生效。并且rtcAudioRecord与rtcVideoRecord的配置将会忽略
    externalLiveConfig Object - 外部 CDN 推拉流地址配置。详细信息请参考 externalConfig 结构仅开启会议直播功能时需要配置。
    roleBinds Object "abcdefg": "host" 给对应的成员绑定角色,格式为 "userUuid": "角色名称" 。角色名称包括:
  • host:主持人
  • cohost:联席主持人
  • member:成员
  • enableJoinBeforeHost Boolean true 是否允许成员提前加入会议
  • true(默认):允许成员提前加入会议。
  • false:成员无法在主持人入会前加入会议,如主持人未入会,且等候室功能开启,则成员自动进入等候室。
  • - scheduledMembers List - 预约会议成员列表,用于指定参会者及其角色。
    • 列表中的成员将以指定角色加入会议。
    • 预约成员总数不得超过 300 人。
    • 若不指定,则默认所有参会者以普通成员身份加入。
    • 会议拥有人 owner 需指定为预约成员。
    userUuid Object abcg**** 会议账号。
    role Object host 会议角色。成员角色包含以下三种:
  • host:主持人
  • cohost:联席主持人
  • member:普通成员
  • maxMembers Integer 500 会议能容纳的参会人数上限,默认最大 2000。

    openWaitingRoom

    Boolean

    false

    在设置了 roomConfig.resource.waitingRoom 字段为 true 后,支持通过 openWaitingRoom 设置等候室的开闭状态。是否开启等候室:

    • true:开启等候室,成员入会会进入等候室。
    • false(默认):不开启等候室。
    timezoneId String America/Cayman 国际时区 ID。取值可参考 时区列表
    coHostLimit Integer 2 会议的联席主持人上限。
    recurringRule Object - 周期性会议设置,具体设置方式请参考 周期会议设置规则

    请求体示例

    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,
          "waitingRoom": "true"
        }
      },
      "roomProperties": {
        "extraData": {
          "value": "meeting extra data"
        },
        "securityCtrl": {
          "value": "16384"
        }
      },
      "destroyTime": 17034500012000,
      "enableJoinBeforeHost": true,
      "openWaitingRoom": false,
      "maxMembers": 500,
      "recordConfig": {
        "rtcRecordType": 1,
        "rtcAudioRecord": true,
        "rtcVideoRecord": true
      },
      "scheduledMembers": [
        {
          "userUuid": "856373c1028f9a0e76a19baa",
          "role": "host"
        },
        {
          "userUuid": "02132002ed372b5a42959396",
          "role": "member"
        },
        {
          "userUuid": "933143780189e9cf252e8314",
          "role": "member"
        }
      ]
    }
    

    响应信息

    响应体参数

    以下是返回结果中 data 属性内包含的参数。其他统一返回参数的相关说明请参考 返回结果

    参数名称
    类型
    示例
    说明
    meetingId Long 123456**** 会议唯一 ID。
    meetingNum String 123456789 随机会议码(长度为 9 位数字)或个人会议码(长度为 10 位数字)。
    subject String 随机会议。 预约会议主题。
    startTime Long 1616738307000 预约开始时间。单位为毫秒。
    endTime Long 1616738307000 预约结束时间。单位为毫秒,返回值为 -1 表示会议无限期。
    password String 123456 会议密码。
    timezoneId String America/Cayman 国际时区 ID。取值可参考 时区列表

    state

    int

    1

    会议状态:

    • 1:未开始
    • 2:进行中
    • 3:已终止
    • 4:已取消
    • 5:已回收
    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",
      "timezoneId": "Asia/Shanghai",
      "settings": {
        "roomInfo": {
          "password": "123455",
          "roomConfig": {
            "resource": {
              "rtc": true,
              "chatroom": true,
              "live": true,
              "whiteboard": false,
              "record": true,
              "sip": false
            }
            "roomProperties": {
              "extraData": {
                "value": "meeting extra data"
              },
              "securityCtrl": {
                "value": "16384"
              }
            },
            "destroyTime": 1618844844651
          }
        },
        "recordConfig": {
            "rtcRecordType": 1,
            "rtcAudioRecord": true,
            "rtcVideoRecord": true
        }
      },
      "roomArchiveId": "1234567"
    }
    

    错误码

    请参考 错误码 预约会议相关章节。

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 请求信息
    • 请求 URI
    • 请求头参数
    • 请求路径参数
    • 请求体参数
    • 请求体示例
    • 响应信息
    • 响应体参数
    • 响应体示例
    • 错误码