网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-12-19 GMT+08:00
分享

创建会议

描述

该接口用于创建立即会议和预约会议。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/mmc/management/conferences

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

userUUID

String

Query

用户的UUID。

说明:

该参数将废弃,请勿使用。

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Authorization-Type

String

Header

标识是否为第三方portal过来的请求。

说明:

该参数将废弃,请勿使用。

X-Site-Id

String

Header

用于区分到哪个HCSO站点鉴权。

说明:

该参数将废弃,请勿使用。

startTime

String

Body

会议开始时间(UTC时间)。格式:yyyy-MM-dd HH:mm。

说明:
  • 创建预约会议时,如果没有指定开始时间或填空串,则表示会议马上开始
  • 时间是UTC时间,即0时区的时间

length

Integer

Body

会议持续时长,单位分钟。默认30分钟。

最大1440分钟(24小时),最小15分钟。

subject

String

Body

会议主题。最多128个字符。

mediaTypes

String

Body

会议的媒体类型。

  • Voice:语音会议
  • HDVideo:视频会议

groupuri

String

Body

软终端创建即时会议时在当前字段带临时群组ID,由服务器在邀请其他与会者时在或者conference-info头域中携带。 长度限制为31个字符。

attendees

Array of Attendee objects

Body

与会者列表。

cycleParams

CycleParams object

Body

周期会议的参数,当会议是周期会议的时候该参数必须填写。

isAutoRecord

Integer

Body

会议是否自动启动录制,在录播类型为:录播、录播+直播时才生效。默认为不自动启动。

  • 1:自动启动录制
  • 0:不自动启动录制

encryptMode

Integer

Body

会议媒体加密模式。默认值由企业级的配置填充。

  • 0:自适应加密
  • 1 : 强制加密
  • 2 : 不加密

language

String

Body

会议通知短信或邮件的语言。默认中文。

  • zh-CN:中文
  • en-US:英文

timeZoneID

String

Body

会议通知中会议时间的时区信息。时区信息,参考时区映射关系

说明:
  • 举例:“timeZoneID”:"26",则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。
  • 非周期会议,如果会议通知是通过第三方系统发送,则这个字段不用填写。

recordType

Integer

Body

录播类型。默认为禁用。

  • 0: 禁用
  • 1: 直播
  • 2: 录播
  • 3: 直播+录播
说明:

当录播类型含有直播属性(recordType为1或3),则liveAddress或者auxAddress至少填一个,否则会中无直播功能。

liveAddress

String

Body

主流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。

auxAddress

String

Body

辅流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。

recordAuxStream

Integer

Body

是否录制辅流,在录播类型为:录播、录播+直播时有效。默认只录制视频主流,不录制辅流。

  • 0:不录制
  • 1:录制

confConfigInfo

ConfConfigInfo object

Body

会议其他配置信息。

recordAuthType

Integer

Body

录播观看鉴权方式,在录播类型为:录播、直播+录播时有效。

  • 0:可通过链接观看/下载
  • 1:企业用户可观看/下载
  • 2:与会者可观看/下载

vmrFlag

Integer

Body

是否使用云会议室或者个人会议ID召开预约会议。默认0。

  • 0:不使用云会议室或者个人会议ID
  • 1:使用云会议室或者个人会议ID

vmrID

String

Body

绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。

说明:
  • vmrID取上述查询接口中返回的id,不是vmrId
  • 创建个人会议ID的会议时,使用vmrMode=0的VMR;创建云会议室的会议时,使用vmrMode=1的VMR
  • vmrID使用个人会议ID占用并发资源,使用云会议室ID占用云会议室资源;vmrID既不使用个人会议ID也不使用云会议室ID(vmrflag=0,vmrID=null)占用并发资源

concurrentParticipants

Integer

Body

会议方数,会议最大与会人数限制。

  • 0:无限制
  • 大于0:会议最大与会人数

supportSimultaneousInterpretation

Boolean

Body

会议是否支持同声传译

  • true:支持
  • false:不支持
表3 Attendee 数据结构

参数

是否必须

类型

描述

userUUID

String

与会者的用户UUID。

accountId

String

与会者的账号。

  • 如果是账号/密码鉴权场景: 选填,表示华为云会议账号ID
  • 如果是APP ID鉴权场景:必填,表示第三方的User ID,同时需要携带参数appId

appId

String

App ID。如果是APP ID鉴权场景,此项必填。参考“App ID的申请”。

name

String

与会者名称。长度限制为96个字符。

role

Integer

会议中的角色。默认为普通与会者。

  • 0:普通与会者
  • 1:会议主持人

phone

String

号码。支持SIP号码或者手机号码。

  • 如果是账号/密码鉴权场景:必填
  • 如果是APP ID鉴权场景:选填
说明:
  • 号码可以通过查询企业通讯接口录获取。返回的number是SIP号码,phone是手机号码
  • 填SIP号码系统会呼叫对应的软终端或者硬终端;填手机号码系统会呼叫手机
  • 呼叫手机需要开通PSTN权限,否则无法呼叫

phone2

String

预留字段,取值类型同参数“phone”

phone3

String

预留字段,取值类型同参数“phone”

email

String

邮件地址。需要发邮件通知时填写。

sms

String

短信通知的手机号码。需要发短信通知时填写。

isMute

Integer

用户入会时是否需要自动静音 。默认不静音。

  • 0: 不需要静音
  • 1: 需要静音
说明:

仅会中邀请与会者时才生效。

isAutoInvite

Integer

会议开始时是否自动邀请该与会者。默认值由企业级配置决定。

  • 0:不自动邀请。
  • 1:自动邀请。
说明:

仅并发会议资源的随机会议ID会议才生效。

type

String

终端类型,类型枚举如下:

  • normal:软终端
  • terminal:硬终端
  • outside:外部与会人
  • mobile:用户手机号码
  • ideahub:ideahub
  • board: 电子白板(SmartRooms),含Maxhub、海信大屏、IdeaHub B2
  • hwvision:华为智慧屏TV
  • customnumber: 自定义呼叫号码(包括级联会议号、手机号码、硬终端SIP号码等)

address

String

预留字段,终端所在会议室信息。

deptUUID

String

部门ID。

deptName

String

部门名称。最大不超过128个字符。

uniqueType

Integer

企业内唯一会场标识, 0标识为普通与会者,1标识为企业内唯一会场

说明:

创建级联会议时,uniqueType 为1, 同时type为customnumber

表4 CycleParams 数据结构

参数

是否必须

类型

描述

startDate

String

周期会议的开始日期,格式:YYYY-MM-DD。

开始日期不能早于当前日期。

说明:

日期是timeZoneID指定的时区的日期,非UTC时间的日期。

endDate

String

周期会议的结束日期,格式:YYYY-MM-DD。

开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议,若超过50个子会议,会自动调整结束日期。

说明:

日期是timeZoneID指定的时区的日期,非UTC时间的日期。

cycle

String

周期类型。

  • Day:天
  • Week:星期
  • Month:月

interval

Integer

子会议间隔。

  • “cycle”选择了“Day”,表示每几天召开一次,取值范围[1,15]
  • “cycle”选择了“Week”,表示每几周召开一次,取值范围[1,5]
  • “cycle”选择了“Month”,Interval表示隔几月,取值范围[1,3]

point

Array of integers

周期内的会议召开点。仅当按周和月时有效。

  • “cycle”选择了“Week”,point中填入了两个元素1和3,则表示每个周一和周三召开会议,0表示周日
  • “cycle”选择了“Month”,point中填入了12和20则表示每个月的12号和20号召开会议,取值范围为[1,31],若当月没有该值,则为月末

preRemindDays

Integer

提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。

默认值是1。

表5 ConfConfigInfo 数据结构

参数

是否必须

类型

描述

isSendNotify

Boolean

是否需要发送会议邮件通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要

isSendSms

Boolean

是否需要发送会议短信通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要
    说明:

    只有正式商用企业才有发送会议短信通知的权限,免费企业即使isSendSms设置成true也不会发送会议短信通知。

isSendCalendar

Boolean

是否需要发送会议邮件日历通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要

isAutoMute

Boolean

来宾入会,软终端是否自动静音。默认值由企业级配置决定。

  • true:自动静音
  • false:不自动静音

isHardTerminalAutoMute

Boolean

来宾入会,硬终端是否自动静音。默认值由企业级配置决定。

  • true:自动静音
  • false:不自动静音

isGuestFreePwd

Boolean

是否来宾免密。

  • true:免密
  • false:需要密码
说明:

仅随机会议ID的会议生效。

callInRestriction

Integer

允许加入会议的范围。

  • 0:所有用户
  • 2:企业内用户
  • 3:被邀请用户

allowGuestStartConf

Boolean

是否允许来宾启动会议。

  • true:允许来宾启动会议
  • false:禁止来宾启动会议
说明:

仅随机会议ID的会议生效。

guestPwd

String

来宾密码(4-16位长度的纯数字)。

vmrIDType

Integer

云会议室的会议ID模式。

  • 0:固定会议ID
  • 1:随机会议ID

prolongLength

Integer

自动延长会议时长(取值范围0-60)。

  • 0:表示会议到点自动结束,不延长会议。
  • 其他:表示自动延长的时长。
说明:
  • 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束,会议时长2个小时,如果与会者8:00就加入会议了,那会议在10:00就会自动结束
  • 设置成其他值时,只要会中还有与会者,会议自动多次延长

enableWaitingRoom

Boolean

是否开启等候室(只对MMR企业生效)。

  • true:开启
  • false:不开启

isHostCameraOn

Boolean

主持人入会是否开启摄像头。

  • true:开启

  • false:不开启

isGuestCameraOn

Boolean

来宾入会是否开启摄像头。

  • true:开启

  • false:不开启

状态码

表6 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常。

响应参数

表7 响应参数

参数

类型

描述

[数组元素]

Array of ConferenceInfo

会议信息列表。

表8 ConferenceInfo 数据结构

参数名称

参数类型

描述

conferenceID

String

会议ID。

subject

String

会议主题。

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组成,多个枚举时,每个枚举值之间通过”,”逗号分隔。如:mediaTypes:“Voice,Data,HDVideo”

  • “Voice”:语音
  • “Video”:标清视频
  • “HDVideo”:高清视频
  • “Data”:数据

conferenceState

String

会议状态。

  • “Schedule”:预定状态
  • “Creating”:正在创建状态
  • “Created”:会议已经被创建,并正在召开
  • “Destroyed”:会议已经关闭

language

String

会议通知短信或邮件的语言。默认中文。

  • zh-CN:中文
  • en-US:英文

accessNumber

String

会议接入的SIP号码。

passwordEntry

Array of PasswordEntry objects

会议密码。

说明:
  • 创建会议时,返回主持人密码和来宾密码
  • 主持人查询会议时,返回主持人密码和来宾密码
  • 来宾查询会议时,返回来宾密码

userUUID

String

会议预订者的用户UUID。

scheduserName

String

会议预订者名称。

conferenceType

Integer

会议类型。

  • 0 : 普通会议。
  • 2 : 周期性会议。

confType

String

会议类型。

  • FUTURE:将来开始的会议(创建时)
  • IMMEDIATELY:立即开始的会议(创建时)
  • CYCLE:周期会议

cycleParams

CycleParams object

周期会议参数。当会议是周期会议的时候携带该参数。

isAutoMute

Integer

是否入会自动静音。

  • 0 : 不自动静音
  • 1 : 自动静音

isAutoRecord

Integer

是否自动开启云录制。

  • 0 : 不自动启动
  • 1 : 自动启动

chairJoinUri

String

主持人会议链接地址。

guestJoinUri

String

普通与会者会议链接地址。

audienceJoinUri

String

网络研讨会观众会议链接地址。

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

是否使用云会议室或个人会议ID召开预约会议。

  • 0:不使用云会议室或个人会议ID
  • 1:使用云会议室或个人会议ID

isHasRecordFile

Boolean

是否有会议录制文件。仅历史会议查询时返回。

true:有录制文件。

false:没有录制文件。

vmrConferenceID

String

云会议室会议ID或个人会议ID。如果“vmrFlag”“1”,则该字段不为空。

confUUID

String

会议的UUID。

说明:
  • 只有创建立即开始的会议才返回UUID,如果是预约未来的会议,不会返回UUID
  • 可以通过查询历史会议列表获取历史会议的UUID

partAttendeeInfo

Array of PartAttendee objects

被邀请的部分与会者信息。

说明:

terminlCount

Integer

硬终端个数,如IdeaHub,TE30等。

normalCount

Integer

软终端个数,如PC端、手机端App等。

deptName

String

会议预定者的企业名称。

role

String

与会者角色。

  • chair :主持人
  • general :来宾
  • audience : 观众
说明:
  • 仅在查询会议详情时返回
  • 返回查询者本身的角色

multiStreamFlag

Integer

标识是否为多流视频会议。

  • 1 :多流会议

webinar

Boolean

是否是网络研讨会。

onlineAttendeeAmount

Integer

当前在线与会人数。包含被邀入会和主动入会的与会者。

说明:

仅在“查询在线会议列表”接口中返回。

confMode

String

会议模型。

  • COMMON :MCU会议
  • RTC :MMR会议

scheduleVmr

Boolean

VMR预约记录。

  • true :VMR会议
  • false :普通会议
说明:

该参数将废弃,请勿使用。

vmrID

String

云会议室ID。

concurrentParticipants

Integer

会议最大与会人数。默认值0。

  • 0:无限制
  • 大于0:会议最大与会人数

supportSimultaneousInterpretation

Boolean

会议是否支持同声传译

  • true :支持
  • false :不支持

picDisplay

MultiPicDisplayDO object

多画面信息。

subConfs

Array of Subconfs objects

周期子会议列表。

cycleSubConfID

String

第一个周期子会议的UUID。

表9 PasswordEntry 数据结构

参数

参数类型

描述

conferenceRole

String

会议角色。

  • chair:会议主持人
  • general:普通与会者

password

String

会议中角色的密码(明文)。

表10 PartAttendee 数据结构

参数

参数类型

描述

name

String

与会者名称。

phone

String

号码。SIP号码或者手机号码。

phone2

String

预留字段,取值类型同参数“phone”

phone3

String

预留字段,取值类型同参数“phone”

type

String

终端类型,类型枚举如下:

  • normal:软终端
  • terminal:硬终端
  • outside:外部与会人
  • mobile:用户手机号码
  • ideahub:ideahub
  • board: 电子白板(SmartRooms)。含Maxhub、海信大屏、IdeaHub B2
  • hwvision:华为智慧屏TV

role

Integer

会议中的角色。默认为普通与会者。

  • 0:普通与会者
  • 1:会议主持人

isMute

Integer

用户入会时是否需要自动静音 。默认不静音。

  • 0: 不需要静音
  • 1: 需要静音
说明:

仅会中邀请与会者时才生效。

表11 MultiPicDisplayDO 数据结构

参数

类型

描述

manualSet

Integer

是否为手工设置多画面。

  • 0 :系统自动多画面
  • 1 :手工设置多画面

imageType

String

画面类型。取值范围:

  • Single: 单画面
  • Two: 二画面
  • Three: 三画面, Three-2: 三画面-2, Three-3: 三画面-3, Three-4: 三画面-4
  • Four: 四画面, Four-2: 四画面-2, Four-3: 四画面-3
  • Five: 五画面, Five-2: 五画面-2
  • Six: 六画面, Six-2: 六画面-2, Six-3: 六画面-3, Six-4: 六画面-4, Six-5: 六画面-5
  • Seven: 七画面, Seven-2: 七画面-2, Seven-3: 七画面-3, Seven-4: 七画面-4
  • Eight: 八画面, Eight-2: 八画面-2, Eight-3: 八画面-3, Eight-4: 八画面-4
  • Nine: 九画面
  • Ten: 十画面, Ten-2: 十画面-2, Ten-3: 十画面-3, Ten-4: 十画面-4, Ten-5: 十画面-5, Ten-6: 十画面-6
  • Thirteen: 十三画面, Thirteen-2: 十三画面-2, Thirteen-3: 十三画面-3,Thirteen-4: 十三画面-4, Thirteen-5: 十三画面-5, ThirteenR: 十三画面R, ThirteenM: 十三画面M
  • Sixteen: 十六画面
  • Seventeen: 十七画面
  • Twenty-Five: 二十五画面
  • Custom: 自定义多画面(当前不支持)

subscriberInPics

Array of PicInfoNotify objects

子画面列表。

switchTime

Integer

表示轮询间隔,单位:秒。当同一个子画面中包含有多个视频源时,此参数有效。

picLayoutInfo

PicLayoutInfo object

自定义多画面布局信息。预留字段,当前不支持。

表12 PicInfoNotify 数据结构

参数

类型

描述

index

Integer

多画面中每个画面的编号,编号从1开始。

id

Array of strings

每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯接口录获取。

share

Integer

是否为辅流

  • 0: 不是辅流
  • 1: 是辅流
表13 PicLayoutInfo 数据结构

参数

类型

描述

x

Integer

横向小格子数。

y

Integer

纵向小格子数。

subPicLayoutInfoList

Array of SubPicLayoutInfo objects

多画面信息。

表14 SubPicLayoutInfo 数据结构

参数

类型

描述

id

Integer

子画面索引。

left

Integer

子画面从左到右的索引。

top

Integer

子画面从上到下的索引。

xSize

Integer

子画面横向尺寸。

ySize

Integer

子画面纵向尺寸。

表15 CycleParams 数据结构

参数

类型

描述

startDate

String

周期会议的开始日期,格式:YYYY-MM-DD。

开始日期不能早于当前日期。

说明:

日期是timeZoneID指定的时区的日期,非UTC时间的日期。

endDate

String

周期会议的结束日期,格式:YYYY-MM-DD。

开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议,若超过50个子会议,会自动调整结束日期。

说明:

日期是timeZoneID指定的时区的日期,非UTC时间的日期。

cycle

String

周期类型。

  • Day:天
  • Week:星期
  • Month:月

interval

Integer

子会议间隔。

  • “cycle”选择了“Day”,表示每几天召开一次,取值范围[1,15]
  • “cycle”选择了“Week”,表示每几周召开一次,取值范围[1,5]
  • “cycle”选择了“Month”,Interval表示隔几月,取值范围[1,3]

point

Array of integers

周期内的会议召开点。仅当按周和月时有效。

  • “cycle”选择了“Week”,point中填入了两个元素1和3,则表示每个周一和周三召开会议,0表示周日
  • “cycle”选择了“Month”,point中填入了12和20则表示每个月的12号和20号召开会议,取值范围为[1,31],若当月没有该值,则为月末

preRemindDays

Integer

提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。

默认值是1。

表16 ConfConfigInfo 数据结构

参数

类型

描述

isSendNotify

Boolean

是否需要发送会议邮件通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要

isSendSms

Boolean

是否需要发送会议短信通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要

isSendCalendar

Boolean

是否需要发送会议日历通知。默认值由企业级配置决定。

  • true:需要
  • false:不需要

isAutoMute

Boolean

来宾入会,软终端是否自动静音。默认值由企业级配置决定。

  • true:自动静音
  • false:不自动静音

isHardTerminalAutoMute

Boolean

来宾入会,硬终端是否自动静音。默认值由企业级配置决定。

  • true:自动静音
  • false:不自动静音

isGuestFreePwd

Boolean

是否来宾免密(仅随机会议有效)。

  • true:免密
  • false:需要密码
说明:

仅随机会议ID的会议生效。

callInRestriction

Integer

允许加入会议的范围。

  • 0:所有用户
  • 2:企业内用户
  • 3:被邀请用户

allowGuestStartConf

Boolean

是否允许来宾启动会议。

  • true:允许来宾启动会议。
  • false:禁止来宾启动会议。
说明:

仅随机会议ID的会议生效。

guestPwd

String

来宾密码(4-16位长度的纯数字)。

vmrIDType

Integer

云会议室的会议ID模式。

  • 0:固定会议ID
  • 1:随机会议ID

prolongLength

Integer

自动延长会议时长(取值范围0-60)。

  • 0:表示会议到点自动结束,不延长会议
  • 其他:表示自动延长的时长
说明:
  • 自动结束会议是按照会议时长计算。比如预定的会议是9:00开始11:00结束,会议时长2个小时,如果与会者8:00就加入会议了,那会议在10:00就会自动结束
  • 设置成其他值时,只要会中还有与会者,会议可以多次延迟

enableWaitingRoom

Boolean

开启或者关闭等候室。

  • true:开启
  • false:不开启

isHostCameraOn

Boolean

主持人入会是否开启摄像头。

  • true:开启

  • false:不开启

isGuestCameraOn

Boolean

来宾入会是否开启摄像头。

  • true:开启

  • false:不开启

请求消息示例

POST /v1/mmc/management/conferences
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
Content-Type: application/json
user-agent: WeLink-desktop
Content-Length: 548
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "subject": "例行会议",
    "mediaTypes": "HDVideo",
    "startTime": "2022-08-30 12:00",
    "length": 60,
    "attendees": [
        {
            "accountId": "zhangshan@huawei.com",
            "appId": "caaab5a3e584497990f6a9b582a0ae42"
        }
    ],
   "confConfigInfo": {
       "isSendNotify": false,
       "isSendSms": false,
       "isSendCalendar": false
    }
}

响应消息示例

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1153
Connection: keep-alive
http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde
Server: api-gateway
X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241

[
    {
        "conferenceID": "914673889",
        "mediaTypes": "Data,Voice,HDVideo",
        "subject": "例行会议",
        "size": 1,
        "timeZoneID": "56",
        "startTime": "2022-08-30 12:00",
        "endTime": "2022-08-30 13:00",
        "conferenceState": "Schedule",
        "accessNumber": "+991117",
        "language": "zh-CN",
        "passwordEntry": [
            {
                "conferenceRole": "chair",
                "password": "******"
            },
            {
                "conferenceRole": "general",
                "password": "******"
            }
        ],
        "userUUID": "ff80808167ef1edf0167f339533d05a6",
        "scheduserName": "金秘书",
        "conferenceType": 0,
        "confType": "FUTURE",
        "isAutoMute": 1,
        "isAutoRecord": 0,
        "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/6a30b8b5a325105da031442627828e496f91021ece36405f",
        "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d",
        "recordType": 2,
        "confConfigInfo": {  
            "isSendNotify": false,
            "isSendSms": false,
            "isAutoMute": true
        },
        "vmrFlag": 0,
        "partAttendeeInfo": [
            {
                "phone": "+99111********4158",
                "name": "张三",               
                "type": "normal"
            }
        ],
        "terminlCount": 0,
        "normalCount": 1,
        "deptName": "企业协同云服务项目群"
    }
]

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences'

相关文档