编辑网络研讨会
描述
该接口用于修改已创建的网络研讨会。网络研讨会开始后不能修改。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
PUT |
---|---|
请求地址 |
/v1/wss/webinar/open/conferences |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
---|---|---|---|---|
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 |
直播观看地址 |
状态码
HTTP状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常。 |
响应参数
无
请求消息示例
PUT /v1/wss/webinar/conferences HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 Content-Length: 822 Content-Type: application/json;charset=UTF-8 X-Access-Token: cnr1419S2HGv2BLFO3HiDrxnyEO6lKKuDlyarRKn { "subject": "网络研讨会", "startTime": "2021-04-12 02:30", "duration": 60, "timeZoneId": "56", "guestPasswd": "*******", "conferenceId": "982879818" }
响应消息示例
HTTP/1.1 200 OK Transfer-Encoding: chunked Cache-Control: no-cache Connection: keep-alive Content-Security-Policy: connect-src 'self' *.huaweicloud.com ;style-src 'self' 'unsafe-inline' 'unsafe-eval';object-src 'self'; font-src 'self' data:; Content-Type: application/json;charset=UTF-8 Date: Mon, 12 Apr 2021 01:44:36 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 308 X-APIG-Ratelimit-Api: remain:97,limit:100,time:1 minute X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second X-APIG-Upstream-Latency: 304 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 239 X-Frame-Options: SAMEORIGIN X-Request-Id: d63c323a67bb3a3928e324aee937fe97 X-Xss-Protection: 1;mode=block
错误码
当您使用华为云会议服务端API时,如果遇到“WSS”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token:cnr1419S2HGv2BLFO3HiDrxnyEO6lKKuDlyarRKn' -d '{ "subject": "网络研讨会","startTime": "2021-04-12 02:30","duration": 60,"timeZoneId": "56","guestPasswd": "*******","conferenceId": "982879818" }' 'https://api.meeting.huaweicloud.com/v1/wss/webinar/conferences'