创建云会议室 - 融合会议管理平台

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

theme

string | null

云会议室名称

必需

<= 30 字符

code

string

可选

会议号，参数指定会议号时，会使用此会议号作为云会议室的会议号。若不指定，则会根据云会议室类型生成不同位数的会议号

option

object (VirtualRoomOptionForm)

云会议室设置

可选

password

string | null

会议密码

必需

autoMuteType

enum<integer> | enum<null>

必需

参会人入会自动静音类型

枚举值:

012

默认值:

{value: 0}

autoCallEnabled

boolean | null

必需

是否自动呼叫设备，默认为 false

默认值:

false

autoRecordEnabled

boolean | null

必需

会议开始时，是否自动开启录制

默认值:

false

recordLayoutMode

enum<integer> | enum<null>

必需

录制布局策略: 0-云录制视图优先, 1-广播布局优先。只有在autoRecord为true时有效

枚举值:

默认值:

{value: 1}

recordLayoutTemplate

string | null

必需

用户录制布局，具体值由媒体决定。只有在autoRecord为true时有效

bannerEnabled

boolean | null

必需

是否预设横幅，为 true 则为预设，为 false 则为取消预设

默认值:

false

bannerInfo

object (BannerInfoForm)

横幅内容

可选

mediaCapabilityOptions

媒体能力参数设置

必需

joinBeforeMasterEnabled

boolean | null

必需

是否允许参会人在主持人之前入会，false不允许，true允许，默认true

默认值:

true

applyMasterEnabled

boolean

是否开启主持人密码

可选

默认值:

true

masterPassword

string

主持人密码

可选

masterPasswordTimes

integer

可选

主持人密码使用限制次数

默认值:

maxEndpointCount

integer

可选

云会议室的最大入会方数，不超过技术上限制的最大方数。

joinPermissionRangeType

enum<integer> | enum<null>

必需

云会议室参会范围类型, 0为所有会场，1为指定的会场

枚举值:

默认值:

{value: 0}

layoutOptions

array[object (LayoutOptionForm) {4}] | null

布局设置

必需

默认值:

new ArrayList<>()

venues

array[object (UserForm) {2}] | null

新增的用户或设备

必需

<= 1000 items

默认值:

new ArrayList<>()

uid

string | null

用户或设备id

可选

uidType

enum<integer> | enum<null>

用户类型

可选

枚举值:

0123

示例

{
    "theme": "string",
    "code": "string",
    "option": {
        "password": "string",
        "autoMuteType": "{value: 0}",
        "autoCallEnabled": false,
        "autoRecordEnabled": false,
        "recordLayoutMode": "{value: 1}",
        "recordLayoutTemplate": "string",
        "bannerEnabled": false,
        "bannerInfo": {
            "text": "string",
            "textSize": 0,
            "textColor": {
                "a": 0,
                "r": 0,
                "g": 0,
                "b": 0
            },
            "backgroundColor": {
                "a": 0,
                "r": 0,
                "g": 0,
                "b": 0
            },
            "textLocation": 0,
            "displayModel": 0,
            "bannerId": 0
        },
        "mediaCapabilityOptions": {
            "bitRate": "2048kbit/s",
            "mediaCrypto": "自动加密",
            "frameRate": "自动",
            "videoResolution": "自动",
            "videoCodecs": "自动",
            "audioCodecs": "自动",
            "auxiliaryStreamBandwidthWeight": "50%"
        },
        "joinBeforeMasterEnabled": true,
        "applyMasterEnabled": true,
        "masterPassword": "string",
        "masterPasswordTimes": 10,
        "maxEndpointCount": 0,
        "joinPermissionRangeType": "{value: 0}",
        "layoutOptions": "new ArrayList<>()"
    },
    "venues": "new ArrayList<>()"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

云会议室信息 <p> 403111059 创建云会议室时，若存在会议号相同的云会议室，且该会议室仍可用，则抛出此异常 403111060 当创建云会议室时，会议号创建失败，则抛出此异常

isUsed

boolean | null

必需

云会议室是否正在使用

string <int64> | null

云会议室id

必需

code

string | null

会议号

必需

name

string | null

会议室名称

必需

password

string | null

必需

密码
见 TSMB-5634 安卓手机端取这个路径下的密码

type

enum<integer> | enum<null>

必需

云会议室类型，1为随机，2为个人，3为企业

枚举值:

123

option

会议室设置

必需

Any of

VirtualRoomOptionResponse

null

云会议室信息

403111059 创建云会议室时，若存在会议号相同的云会议室，且该会议室仍可用，则抛出此异常 403111060 当创建云会议室时，会议号创建失败，则抛出此异常

allowJoinBeforeMaster

boolean | null

必需

是否允许参会人在主持人之前入会，false不允许，true允许，默认true

默认值:

true

password

string | null

会议密码

必需

autoMuteType

enum<integer> | enum<null>

必需

参会人入会自动静音类型，0不静音，1静音，2超过一定人数自动静音

枚举值:

012

默认值:

{value: 0}

autoCallEnabled

boolean | null

必需

是否激活时自动呼叫参会人，默认为 false

默认值:

false

autoRecordEnabled

boolean | null

会话自动开启录制

必需

默认值:

false

recordLayoutMode

enum<integer> | enum<null>

必需

录制布局策略: 0-云录制视图优先, 1-广播布局优先。只有在autoRecord为true时有效

枚举值:

默认值:

{value: 1}

recordLayoutTemplate

string | null

必需

用户录制布局，具体值由媒体决定。只有在autoRecord为true时有效

bannerEnabled

boolean | null

横幅是否开启

必需

默认值:

false

bannerInfo

object | null

横幅内容

必需

mediaCapabilityOptions

媒体能力参数设置

必需

applyMasterEnabled

boolean

是否开启主持人密码

可选

默认值:

false

masterPassword

string

主持人密码

可选

masterPasswordTimes

integer

可选

主持人密码使用限制次数

默认值:

maxEndpointCount

integer

可选

云会议室的最大入会方数，最大不超过技术上限制的最大方数。小于或等于0则表示没有限制

默认值:

-1

joinPermissionRangeType

enum<integer> | enum<null>

必需

云会议室参会范围类型, 0为所有会场，1为指定的会场

枚举值:

默认值:

{value: 0}

layoutOptions

array[object (LayoutOptionResponse) {4}] | null

会议布局信息

必需

uid

string | null

用户id

必需

uidType

enum<integer> | enum<null>

设备id

必需

枚举值:

0123

companyId

string | null

企业id

必需

venues

array[object (MeetingVenueResponse) {8}]

会场列表

可选

uid

string

会场id

可选

uidType

enum<integer>

会场类型

可选

枚举值:

0123

displayName

string

会场名称

可选

identifier

string

可选

会场标识，账号、终端号、IP信息等会场唯一标识

accessType

enum<string>

接入类型

可选

枚举值:

未知SVCH.323SIP

groupName

string

分组名称

可选

groupId

string

分组id

可选

companyId

string

企业id

可选

示例

{
  "isUsed": false,
  "id": "",
  "code": "",
  "name": "",
  "type": 0,
  "option": {
    "password": "",
    "autoMuteType": 0,
    "autoCallEnabled": false,
    "autoRecordEnabled": false,
    "recordLayoutMode": 0,
    "recordLayoutTemplate": "",
    "bannerEnabled": false,
    "bannerInfo": {},
    "mediaCapabilityOptions": {
      "bitRate": "",
      "mediaCrypto": "",
      "frameRate": "",
      "videoResolution": "",
      "videoCodecs": "",
      "audioCodecs": ""
    },
    "joinBeforeMasterEnabled": false,
    "applyMasterEnabled": false,
    "masterPassword": "",
    "masterPasswordTimes": 0,
    "maxEndpointCount": 0,
    "joinPermissionRangeType": 0,
    "layoutOptions": [
      {
        "id": "",
        "apply": false,
        "type": 0,
        "content": "",
        "index": 0,
        "createdTime": "",
        "updatedTime": "",
        "applyTime": ""
      }
    ]
  },
  "uid": "",
  "uidType": 0,
  "companyId": "",
  "venues": [
    {
      "uid": "",
      "uidType": 0,
      "displayName": "",
      "identifier": "",
      "accessType": "",
      "groupName": "",
      "groupId": "",
      "companyId": ""
    }
  ]
}