华为云会议 MEETING-创建会议:请求参数

时间：2024-11-07 19:46:56

华为云会议 MEETING

请求参数

表2 参数说明
参数	是否必须	类型	位置	描述
userUUID	否	String	Query	用户的UUID。说明：该参数将废弃，请勿使用。
X-Access-Token	是	String	Header	授权令牌。获取“执行App ID鉴权”响应的accessToken。
X-Authorization-Type	否	String	Header	标识是否为第三方portal过来的请求。说明：该参数将废弃，请勿使用。
X-Site-Id	否	String	Header	用于区分到哪个H CS O站点鉴权。说明：该参数将废弃，请勿使用。
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: 直播+录播
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
address	否	String	预留字段，终端所在会议室信息。
deptUUID	否	String	部门ID。
deptName	否	String	部门名称。最大不超过128个字符。

表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位长度的纯数字）。
vmr IDT ype	否	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：不开启