CURL 命令
4 会议管理
4.1 应用示例
4.2.1 创建会议
描述
您可根据需要创建立即会议和预约会议。
调试
您可以在API Explorer中调试该接口。
接口原型
表4-1 接口原型 请求方法 POST
请求地址 /v1/mmc/management/conferences 传输协议 HTTPS
请求参数
表4-2 参数说明
参数 是否必
须
类型 位置 描述
userUUID 否 String Query 用户的UUID（已在USG注册过 的）。
X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴
权”响应的accessToken。
X- Authorization-Type
否 String Header 标识是否为第三方portal过来的 请求。
X-Site-Id 否 String Header 用于区分到哪个HCSO站点鉴 权。
startTime 否 String Body 会议开始时间（UTC时间）。
说明
● 创建预约会议时，如果没有指定 开始时间或填空串，则表示会议 马上开始。
● 时间是UTC时间，即0时区的时 间。
格式：yyyy-MM-dd HH:mm
参数 是否必 须
类型 位置 描述
length 否 Integer Body 会议持续时长，单位分钟，最大 值为1440，最短15。default:
30。
subject 否 String Body 会议主题。长度限制为128个字 符。
mediaTypes 是 String Body 会议的媒体类型。
由1个或多个枚举String组成，多
groupuri 否 String Body 软终端创建即时会议时在当前字 段带临时群组ID，由服务器在邀 请其他与会者时在或者
conference-info头域中携带。
长度限制为31个字符。
attendees 否 Array of Attende eobjects
Body 与会者列表。该列表可以用于发 送会议通知、会议提醒、会议开 始时候进行自动邀请。
cycleParams 否 CyclePa ramsobject
isAutoRecord 否 Integer Body 会议是否自动启动录制，在录播 类型为：录播、录播+直播时才 生效。默认为不自动启动。
● 1：自动启动录制。
● 0：不自动启动录制。
参数 是否必 须
类型 位置 描述
encryptMode 否 Integer Body 会议媒体加密模式。默认值由企 业级的配置填充。
● 0：自适应加密。
● 1 : 强制加密。
● 2 : 不加密。
language 否 String Body 会议的默认语言，默认值由会议 云服务定义。
对于系统支持的语言，按照 RFC3066规范传递。
● zh-CN：简体中文。
● en-US：美国英文。
timeZoneID 否 String Body 会议通知中会议时间的时区信 息。时区信息，参考时区映射关
“2021/11/11 星期四 00:00 -02:00 (GMT) 格林威治标准时 间:都柏林, 爱丁堡, 里斯本, 伦 敦”。
● 如果会议通知是通过第三方系统 发送，则这个字段不用填写。
recordType 否 Integer Body 录播类型。默认为禁用。
● 0: 禁用 。
● 1: 直播 。
● 2: 录播。
● 3: 直播+录播。
liveAddress 否 String Body 主流直播地址，最大不超过255 个字符，在录播类型为：直播、
录播+直播时有效。
auxAddress 否 String Body 辅流直播地址，最大不超过255 个字符，在录播类型为：直播、
参数 是否必 须
类型 位置 描述
confConfigInf
o 否 ConfCo
nfigInfo object
Body 会议其他配置信息。
recordAuthTy
pe 否 Integer Body 录播鉴权方式，在录播类型为:录 播、直播+录播时有效。
● 0：可通过链接观看/下载。
● 1：企业用户可观看/下载。
● 2：与会者可观看/下载。
vmrFlag 否 Integer Body 是否使用云会议室或者个人会议 ID召开预约会议。默认不使用云 会议室。
● 0：不使用云会议室。
● 1：使用云会议室或者个人会 议ID。
vmrID 否 String Body 绑定给当前创会帐号的VMR ID。通过查询云会议室及个人会
议ID接口获取。
说明
● vmrID取上述查询接口中返回的 id，不是vmrId。
● 创建个人会议ID的会议时，使用 vmrMode=0的VMR；创建云会 议室的会议时，使用
vmrMode=1的VMR。
concurrentPar
ticipants 否 Integer Body 会议方数，会议最大与会人数限 制。
● 0：无限制。
● 大于0：会议最大与会人数。
表4-3 Attendee 数据结构
参数 是否必须 类型 描述
userUUID 否 String 与会者的用户UUID。
参数 是否必须 类型 描述
accountId 否 String 与会者的账号ID。
● 如果是账号/密码鉴权场 景，选填，表示华为云 会议帐号ID。
● 如果是APP ID鉴权场 景，必填，表示第三方 的User ID，同时需要携 带appid参数
appId 否 String App ID，应用标识，一个应
用只需创建一次，参考
“App ID的申请”
如果是APP ID鉴权场景，此 项必填
name 否 String 与会者名称或昵称。长度限
制为96个字符。
role 否 Integer 会议中的角色。默认为普通
与会者。
● 0：普通与会者。
● 1：会议主持人。
phone 否 String ● 如果是账号/密码鉴权场
景，必填，号码（可支 持SIP、TEL号码格 式）。最大不超过127个 字符。phone、email和 sms三者需至少填写一 个。
● 如果是APP ID鉴权场 景，选填。
phone2 否 String 预留字段，取值类型同参数
“phone”。
phone3 否 String 预留字段，取值类型同参数
“phone”。
email 否 String 邮件地址。最大不超过255
个字符。如果是账号/密码 鉴权场景，phone、email 和sms三者需至少填写一 个。（用于预定、修改、取 消会议的信息通知）
参数 是否必须 类型 描述
sms 否 String 短信通知的手机号码。最大
不超过32个字符。如果是账 号/密码鉴权场景，
phone、email和sms三者需 至少填写一个。（用于预 定、修改、取消会议的信息 通知）
isMute 否 Integer 用户入会时是否需要自动静
音(仅会中邀请时生效) 。默 认不静音。
● 0： 不需要静音。
● 1： 需要静音。
isAutoInvite 否 Integer 会议开始时是否自动邀请该 与会者。默认值由企业级配 置决定。
● 0：不自动邀请。
● 1：自动邀请。
type 否 String 默认值由会议AS定义，号
码类型枚举如下：
● “normal”：软终端。
● “telepresence”：智 真。单屏、三屏智真均 属此类。（预留字段）
● “terminal”：会议室 或硬终端。
● “outside”：外部与会 人。
● “mobile”：用户手机 号码。
● “telephone”：用户固 定电话。（预留字段）
address 否 String 终端所在会议室信息。（预
留字段）
deptUUID 否 String 部门ID。最大不超过64个字 符。
deptName 否 String 部门名称。最大不超过128
个字符。
表4-4 CycleParams 数据结构
参数 是否必须 类型 描述
startDate 是 String 周期会议的开始日期，格
式：YYYY-MM-DD。
开始日期不能早于当前日 期。
endDate 是 String 周期会议的结束日期，格
式：YYYY-MM-DD。
interval 否 Integer ● “cycle”选择了
“Day”，表示每几天
point 否 Array of
integers 周期内的会议召开点。仅
参数 是否必须 类型 描述
preRemindDays 是 Integer 支持用户指定提前会议通 知的天数N，预订人收到 整个周期会议的通知，所 有与会人在每个子会议召 开时间的前N天收到会议 通知（包括日历）。
天数N的输入根据间隔期 进行自动调整，如果按日 每隔2天召开，则N自动 变为2，如果为按周每2周 的周一、周二，则N自动 变为14。 约束：暂不考 虑夏令时处理。
取值范围[0,30]。
default: 1
表4-5 ConfConfigInfo 数据结构
参数 是否必须 类型 描述
isSendNotify 否 Boolean 是否需要发送会议邮件通 知。默认值由企业级配置决 定。
● true：需要。
● false：不需要。
isSendSms 否 Boolean 是否需要发送会议短信通 知。默认值由企业级配置决 定。
● true：需要。
● false：不需要。
说明
只有正式商用企业才有发 送会议短信通知的权限，
免费企业即使isSendSms设 置成true也不会发送会议短 信通知。
isSendCalendar 否 Boolean 是否需要发送会议日历通 知。默认值由企业级配置决 定。
● true：需要。
● false：不需要。
参数 是否必须 类型 描述
isAutoMute 否 Boolean 来宾入会，软终端是否自动 静音。默认值由企业级配置 决定。
● true：自动静音。
● false：不自动静音。
isHardTerminalAu
toMute 否 Boolean 来宾入会，硬终端是否自动
静音。默认值由企业级配置 决定。
● true：自动静音。
● false：不自动静音。
isGuestFreePwd 否 Boolean 是否来宾免密（仅随机会议 有效）。
● true：免密。
● false：需要密码。
callInRestriction 否 Integer 允许呼入的范围。
● 0：所有用户。
guestPwd 否 String 来宾密码（4-16位长度的纯 数字）。
vmrIDType 否 Integer 云会议室会议ID模式。
● 0：固定ID。
● 1：随机ID。
prolongLength 否 Integer 自动延长会议时长（推荐取 值范围0-60）。
状态码
表4-6 状态码说明
HTTP状态码 描述
200 操作成功。
400 参数异常。
401 未鉴权或鉴权失败。
403 权限受限。
500 服务端异常。
响应参数
表4-7 响应参数
参数 类型 描述
[数组元素] Array of ConferenceInfo 会议信息列表。
表4-8 ConferenceInfo 数据结构
参数名称 参数类型 描述
conferenceID String 会议ID。长度限制为32个 字符。
subject String 会议主题。长度限制为
128个字符。
size Integer 会议方数。
参数名称 参数类型 描述
timeZoneID String 会议通知中会议时间的时
区信息。时区信息，参考
时区映射关系。
说明
● 举例：
“timeZoneID”:"26"，
则通过华为云会议发送 的会议通知中的时间将 会标记为如
“2021/11/11 星期四 00:00 - 02:00 (GMT) 格 林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦 敦”。
startTime String 会议起始时间 (YYYY-MM-DD HH:MM )。
endTime String 会议结束时间
(YYYY-MM-DD HH:MM )。
mediaTypes String 会议的媒体类型。
由1个或多个枚举String组 成，多个枚举时，每个枚 举值之间通过”,”逗号分 隔。
● “Voice”：语音。
● “Video”：标清视 频。
● “HDVideo”：高清视 频（与“Video”互 斥，如果同时选择
“Video”、
“HDVideo”，则系统 默认选择“Video”）。
● “Telepresence”：智 真(与“HDVideo”、
“Video”互斥，如果 同时选择，系统使用
“Telepresence”)。
（预留字段）
● “Data”：多媒体。
参数名称 参数类型 描述
conferenceState String 目前只会返回Created和 Schedule状态， 如果会议 已经召开返回Created状 态，否则返回Schedule状 态。
● “Schedule”：预定状 态。
● “Creating”：正在创 建状态。
● “Created”：会议已 经被创建，并正在召 开。
● “Destroyed”：会议 已经关闭。
language String 会议语言。
accessNumber String 会议接入码。
passwordEntry Array of PasswordEntry
objects 会议密码条目。预订者返
回主持人密码和来宾密 码。
● 主持人查询时返回主持 人密码。
● 来宾查询时返回来宾密 码。
userUUID String 会议预订者UUID。
scheduserName String 会议预订者帐号名称。长 度最大限制为96个字符。
conferenceType Integer ● 0 : 普通会议。
● 2 : 周期性会议。
confType String 会议类型。
● FUTURE
● IMMEDIATELY
● CYCLE
cycleParams CycleParams object 周期会议参数。当会议是 周期会议的时候携带该参 数。
该参数包括周期会议的开 始日期、结束日期、会议 的周期和周期中的开会时 间点。
参数名称 参数类型 描述
isAutoMute Integer 是否入会自动静音。
● 0 : 不自动静音。
● 1 : 自动静音。
isAutoRecord Integer 是否自动开启录音。
● 0 : 不自动启动。
● 1 : 自动启动。
chairJoinUri String 主持人会议链接地址。
guestJoinUri String 普通与会者会议链接地
址。最大长度1024。
audienceJoinUri String 观众会议链接地址。最大 长度1024。（网络研讨会 场景）
recordType Integer 录播类型。
● 0: 禁用 。
● 1: 直播 。
● 2: 录播 。
● 3: 直播+录播。
auxAddress String 辅流直播地址。
liveAddress String 主流直播地址。
recordAuxStream Integer 是否录制辅流。
● 0：否。
● 1：是。
recordAuthType Integer 录播鉴权方式。录播类型 为:录播、直播+录播时有 效。
● 0：可通过链接观看/下 载。
● 1：企业用户可观看/下 载。
● 2：与会者可观看/下 载。
liveUrl String 直播地址。（配置直播房
间时会返回）
confConfigInfo ConfConfigInfo object 会议其他配置信息。
参数名称 参数类型 描述
vmrFlag Integer 是否使用云会议室召开预
约会议。
● 0：不使用云会议室。
● 1：使用云会议室。
界面显示会议ID需要使 用“vmrConferenceID”
作为会议ID；查询会议 详情、登录会控、一键 入会等会议业务操作依 然使用“conferenceID”字 段。
isHasRecordFile Boolean 仅历史会议返回值有效。
默认没有录制文件。
true：有录制文件。
false：没有录制文件。
vmrConferenceID String 云会议室id，如果
“vmrFlag”为“1”，则 该字段不为空。
confUUID String 会议的UUID。
说明
● 只有创建立即开始的会 议才返回UUID，如果是 预约未来的会议，不会 返回UUID。
● 只有创建立即开始的会 议才返回UUID，如果是 预约未来的会议，不会 返回UUID。