预约会议 - 融合会议管理平台

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Body 参数application/json

会议表单

theme

string

会议主题

可选

<= 64 字符

code

string | null

可选

会议号, 为 null 的时候则默认生成八位的会议号

scheduleType

enum<integer> | enum<null>

会议类型

必需

枚举值:

recurringRule

object (RecurringRuleContent)

周期会议规则

可选

startDate

string

周期会议开始日期

可选

endDate

string

周期会议结束日期

可选

recurringType

enum<integer>

可选

周期类型：1-每日，2-每周，3-每月，4每年

枚举值:

1234

interval

integer

可选

间隔, 几日/周/月

dayOfWeeks

array[integer]

可选

每周的周几，周一为 1，以此类推

默认值:

new ArrayList<>()

dayOfMonths

array[integer]

可选

每月的第几日，1 号为 1，以此类推

默认值:

new ArrayList<>()

monthOfYears

array[integer]

可选

每年的第几个月，1 月为 1，以此类推

默认值:

new ArrayList<>()

content

string

会议议程

可选

meetingOption

会议设置

必需

Any of

VirtualRoomOptionForm

null

会议表单

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<>()

startTime

string | null

会议开始时间

必需

endTime

string | null

会议结束时间

必需

venues

array[object (VenueForm) {5}] | null

预约的用户或设备

必需

<= 1000 items

默认值:

new ArrayList<>()

uid

string | null

可选

用户或设备id，如果是临时设备，则该字段无需填写

uidType

enum<integer> | enum<null>

可选

用户类型，如果是临时设备，则该字段无需填写

枚举值:

0123

name

string

可选

用户名称, 如果是临时终端，则该字段必填

identifier

string

用户标识

可选

accessType

enum<string>

用户接入类型

可选

枚举值:

未知SVCH.323SIP

recurringMeetingApplied

boolean

是否应用到周期会议

可选

默认值:

false

masters

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

必需

会议指定主持人的用户列表

<= 100 items

默认值:

new ArrayList<>()

uid

string | null

用户或设备id

可选

uidType

enum<integer> | enum<null>

用户类型

可选

枚举值:

0123

thirdPartyMeetingId

string

第三方会议室ID

可选

<= 64 字符

示例

{
    "theme": "test meeting2", 
    "scheduleType": 0, 
    "content": "",
    "meetingOption": { 
        "password": "",
        "autoMuteType": 0, 
        "autoCallEnabled": false, 
        "autoRecordEnabled": false, 
        "recordLayoutMode": 1, 
        "recordLayoutTemplate": "SINGLE_ACTIVEVIDEO",
        "bannerEnabled": false, 
        "mediaCapabilityOptions": {
            "bitRate": "4Mbit/s",
            "mediaCrypto": "自动加密",
            "frameRate": "自动",
            "videoResolution": "自动",
            "videoCodecs": "自动",
            "audioCodecs": "自动"
        },
        "joinBeforeMasterEnabled": "true",
        "joinPermissionRangeType": 0, 
        "layoutOptions": []
    },
    "startTime": "1721010600000", 
    "endTime": "1721014200000", 
    "venues": [ 
        {
            "name": "预约临时设备",
            "identifier": "172.20.74.85",
            "accessType": "H.323"
        }
    ],
    "code": ""
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

预约会议的信息

array of:

meeting

object (MeetingResponse)

会议信息

可选

string

会议id

可选

theme

string

会议主题

可选

code

string

会议号

可选

state

enum<integer>

会议状态

可选

枚举值:

01234

address

string

会议地址

可选

content

string

会议议程

可选

virtualRoom

object (VirtualRoomResponse)

预约的云会议室

可选

startTime

string

会议开始时间

可选

endTime

string

会议结束时间

可选

scheduleType

enum<integer>

会议预约类型

可选

枚举值:

recurringRule

object (RecurringRuleContent)

可选

周期会议规则，当预约类型为RECURRING时，该字段不为空

uid

string | null

创建者用户id

必需

uidType

enum<integer> | enum<null>

创建者id类型

必需

枚举值:

0123

companyId

string | null

企业id

必需

ownerDisplayName

string

创建者名称

可选

onlineMeetingState

enum<integer>

视频会议状态

可选

枚举值:

createdTime

string

会议创建时间

可选

meetingVenues

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

可选

示例

{
  "meeting": {
    "id": "",
    "theme": "",
    "code": "",
    "state": 0,
    "address": "",
    "content": "",
    "virtualRoom": {
      "isUsed": false,
      "id": "",
      "code": "",
      "name": "",
      "password": "",
      "type": 0,
      "option": {
        "allowJoinBeforeMaster": false,
        "password": "",
        "autoMuteType": 0,
        "autoCallEnabled": false,
        "autoRecordEnabled": false,
        "recordLayoutMode": 0,
        "recordLayoutTemplate": "",
        "bannerEnabled": false,
        "bannerInfo": {},
        "mediaCapabilityOptions": {
          "bitRate": "",
          "mediaCrypto": "",
          "frameRate": "",
          "videoResolution": "",
          "videoCodecs": "",
          "audioCodecs": ""
        },
        "applyMasterEnabled": false,
        "masterPassword": "",
        "masterPasswordTimes": 0,
        "maxEndpointCount": 0,
        "joinPermissionRangeType": 0,
        "layoutOptions": [
          {
            "apply": false,
            "type": 0,
            "content": "",
            "index": 0
          }
        ]
      },
      "uid": "",
      "uidType": 0,
      "companyId": "",
      "venues": [
        {
          "uid": "",
          "uidType": 0,
          "displayName": "",
          "identifier": "",
          "accessType": "",
          "groupName": "",
          "groupId": "",
          "companyId": ""
        }
      ]
    },
    "startTime": "",
    "endTime": "",
    "scheduleType": 0,
    "recurringRule": {
      "startDate": "",
      "endDate": "",
      "recurringType": 0,
      "interval": 0,
      "dayOfWeeks": [
        0
      ],
      "dayOfMonths": [
        0
      ],
      "monthOfYears": [
        0
      ]
    },
    "uid": "",
    "uidType": 0,
    "companyId": "",
    "ownerDisplayName": "",
    "onlineMeetingState": 0,
    "createdTime": ""
  },
  "meetingVenues": [
    {
      "uid": "",
      "uidType": 0,
      "displayName": "",
      "identifier": "",
      "accessType": "",
      "groupName": "",
      "groupId": "",
      "companyId": ""
    }
  ]
}