华为云会议 MEETING-编辑网络研讨会:请求参数
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
---|---|---|---|---|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Request-Id |
否 |
String |
Header |
请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 |
Accept-Language |
否 |
String |
Header |
语言参数,默认为中文zh-CN,英文为en-US。 |
conferenceId |
是 |
String |
Body |
网络研讨会ID。 |
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 |
会议通知中会议时间的时区信息。时区信息,参考时区映射关系。
说明:
|
attendees |
否 |
Array of Attendee objects |
Body |
与会嘉宾列表。
说明:
观众只能自己通过链接或者会议ID+密码加入,不支持被邀请。 |
notifySetting |
否 |
NotifySetting object |
Body |
网络研讨会通知配置。 |
guestPasswd |
否 |
String |
Body |
嘉宾密码(4-16位长度的纯数字)。 |
audiencePasswd |
否 |
String |
Body |
观众密码(4-16位长度的纯数字)。 |
callRestriction |
否 |
Boolean |
Body |
入会范围开关。 |
scope |
否 |
Integer |
Body |
主持人、嘉宾入会范围。
|
audienceScope |
否 |
Integer |
Body |
观众入会范围。
|
enableRecording |
否 |
String |
Body |
录制是否开启。
|
liveAddress |
否 |
String |
Body |
主流直播推流地址,最大不超过255个字符。若仅填写liveAddress,未填写auxAddress,无人共享时直播画面显示演讲者视图,有人共享时直播画面显示共享屏幕视图。若同时填写了liveAddress和auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 |
auxAddress |
否 |
String |
Body |
辅流直播推流地址,最大不超过255个字符。在填写liveAddress后可增加填写auxAddress,liveAddress对应直播画面显示演讲者视图,auxAddress对应直播画面显示共享屏幕视图。 |
liveUrl |
否 |
String |
Body |
直播观看地址 |