华为云会议 MEETING-预约网络研讨会:请求参数

时间：2024-04-29 16:21:10

华为云会议 MEETING

请求参数

表2 参数说明
参数	是否必须	类型	位置	描述
X-Access-Token	是	String	Header	授权令牌。获取“执行App ID鉴权”响应的accessToken。
X-Request-Id	否	String	Header	请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。
Accept-Language	否	String	Header	语言参数，默认为中文zh-CN，英文为en-US。
subject	是	String	Body	网络研讨会主题。长度限制为128个字符。
description	否	String	Body	网络研讨会描述。长度限制为1000个字符。
startTime	是	String	Body	网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。
duration	是	Integer	Body	网络研讨会持续时长，单位分钟，取值范围[15,1440]。
timeZoneId	是	Integer	Body	会议通知中会议时间的时区信息。时区信息，参考时区映射关系。说明：举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。
attendees	否	Array of Attendee objects	Body	与会嘉宾列表。说明：观众只能自己通过链接或者会议ID+密码加入，不支持被邀请。
notifySetting	否	NotifySetting object	Body	网络研讨会通知配置。
vmrID	是	String	Body	绑定给当前创建网络研讨会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。说明： vmrID取上述查询接口中返回的id，不是vmrId 创建网络研讨会时，使用vmrMode=2的VMR
guestPasswd	否	String	Body	嘉宾密码（4-16位长度的纯数字)。不指定则系统自动生成。
audiencePasswd	否	String	Body	观众密码（4-16位长度的纯数字)。不指定则系统自动生成。
callRestriction	否	Boolean	Body	入会范围开关。 false：不限制入会范围 true：限制入会范围
scope	否	Integer	Body	主持人、嘉宾入会范围。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户 3: 被邀请用户
audienceScope	否	Integer	Body	观众入会范围。仅callRestriction设置成true后生效。 0: 所有用户 2: 企业内用户和被邀请用户
enableRecording	否	String	Body	录制是否开启。 Y: 开启 N: 不开启
liveAddress	否	String	Body	主流直播推流地址，最大不超过255个字符。若仅填写liveAddress，未填写auxAddress，无人共享时直播画面显示演讲者视图，有人共享时直播画面显示共享屏幕视图。若同时填写了liveAddress和auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。
auxAddress	否	String	Body	辅流直播推流地址，最大不超过255个字符。在填写liveAddress后可增加填写auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。
liveUrl	否	String	Body	直播观看地址

表3 Attendee 数据结构
参数	是否必须	类型	描述
appId	是	String	App ID。如果是APP ID鉴权场景，此项必填。参考“App ID的申请”。
userAccount	否	String	嘉宾的账号。如果是账号/密码鉴权场景: 选填，表示华为云会议账号ID 如果是APP ID鉴权场景：必填，表示第三方的User ID，同时需要携带参数appId
userName	否	String	嘉宾的名称。长度限制为96个字符。
deptName	否	String	部门名称，最大128字符。
phone	否	String	号码。支持SIP号码或者手机号码。如果是账号/密码鉴权场景：必填如果是APP ID鉴权场景：选填说明：号码可以通过查询企业通讯接口录获取。返回的number是SIP号码，phone是手机号码填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机呼叫手机需要开通PSTN权限，否则无法呼叫
email	否	String	邮件地址。需要发邮件通知时填写。
sms	否	String	短信通知的手机号码。需要发短信通知时填写。
isHardTerminal	否	Boolean	是否硬终端（会议室或硬终端）。

表4 NotifySetting 数据结构
参数	是否必须	类型	描述
enableCalendar	是	String	发送邮件日历是否开启。 Y：开启 N：不开启
enableSms	是	String	发送短信通知是否开启。 Y：开启 N：不开启
enableEmail	是	String	发送邮件是否开启。 Y：开启 N：不开启