# 预约网络研讨会 - CreateWebinar #### 描述 该接口用于创建网络研讨会。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=Meeting&api=CreateWebinar)中调试该接口。 #### URI POST /v1/wss/webinar/open/conferences #### 请求参数 表1参数说明 | 参数 | 是否必须 | 类型 | 位置 | 描述 | |:---|:---|:---|:---|:---| | X-Access-Token | 是 | String | Header | 授权令牌。获取"[执行App ID鉴权](https://support.huaweicloud.com/api-meeting/meeting_21_0311.html)"响应的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 | 会议通知中会议时间的时区信息。时区信息，参考[时区映射关系](https://support.huaweicloud.com/api-meeting/meeting_21_0110.html#ZH-CN_TOPIC_0212714472__table137407441463)。 说明： - 举例："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](https://support.huaweicloud.com/api-meeting/meeting_21_1106.html)接口获取。 说明： - 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 | 直播观看地址 | 表2Attendee 数据结构 | 参数 | 是否必须 | 类型 | 描述 | |:---|:---|:---|:---| | appId | 是 | String | App ID。如果是APP ID鉴权场景，此项必填。参考"[App ID的申请](https://support.huaweicloud.com/devg-meeting/meeting_20_0011.html#section1)"。 | | userAccount | 否 | String | 嘉宾的账号。 - 如果是账号/密码鉴权场景: 选填，表示华为云会议账号ID - 如果是APP ID鉴权场景：必填，表示第三方的User ID，同时需要携带参数appId | | userName | 否 | String | 嘉宾的名称。长度限制为96个字符。 | | deptName | 否 | String | 部门名称，最大128字符。 | | phone | 否 | String | 号码。支持SIP号码或者手机号码。 - 如果是账号/密码鉴权场景：必填 - 如果是APP ID鉴权场景：选填 说明： - 号码可以通过[查询企业通讯](https://support.huaweicloud.com/api-meeting/meeting_21_0512.html)接口录获取。返回的number是SIP号码，phone是手机号码 - 填SIP号码系统会呼叫对应的软终端或者硬终端；填手机号码系统会呼叫手机 - 呼叫手机需要开通PSTN权限，否则无法呼叫 | | email | 否 | String | 邮件地址。需要发邮件通知时填写。 | | sms | 否 | String | 短信通知的手机号码。需要发短信通知时填写。 | | isHardTerminal | 否 | Boolean | 是否硬终端（会议室或硬终端）。 | 表3NotifySetting 数据结构 | 参数 | 是否必须 | 类型 | 描述 | |:---|:---|:---|:---| | enableCalendar | 是 | String | 发送邮件日历是否开启。 - Y：开启 - N： 不开启 | | enableSms | 是 | String | 发送短信通知是否开启。 - Y：开启 - N： 不开启 | | enableEmail | 是 | String | 发送邮件是否开启。 - Y：开启 - N： 不开启 | #### 状态码 表4状态码说明 | HTTP状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 参数异常。 | | 401 | 未鉴权或鉴权失败。 | | 403 | 权限受限。 | | 500 | 服务端异常。 | #### 响应参数 表5响应参数 | 参数 | 类型 | 描述 | |:---|:---|:---| | conferenceId | String | 网络研讨会ID。 | | corpId | String | 企业ID。 | | subject | String | 网络研讨会主题。 | | description | String | 网络研讨会描述。 | | startTime | String | 网络研讨会开始时间（UTC时间），格式"yyyy-MM-dd HH:mm"。 | | duration | Integer | 网络研讨会持续时长，单位分钟，取值范围\[15,1440\]。 | | timeZoneId | Integer | 会议通知中会议时间的时区信息。时区信息，参考[时区映射关系](https://support.huaweicloud.com/api-meeting/meeting_21_0110.html#ZH-CN_TOPIC_0212714472__table137407441463)。 说明： - 举例："timeZoneID":"26"，则通过华为云会议发送的会议通知中的时间将会标记为如"2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦"。 | | state | String | 会议状态。 - schedule: 预定状态 - created: 会议已经被创建并正在召开 - destroyed: 会议已经关闭 | | scheduserId | String | 网络研讨会预订者的用户UUID。 | | deptName | String | 预订者部门命名。 | | scheduserName | String | 预订者名称。 | | vmrPkgName | String | 网络研讨会VMR名称。 | | callRestriction | Boolean | 入会范围开关。 | | scope | Integer | 主持人、嘉宾入会范围。 - 0: 所有用户 - 2: 企业内用户 - 3: 被邀请用户 | | audienceScope | Integer | 观众入会范围。 - 0: 所有用户 - 2: 企业内用户 | | chairJoinUri | String | 主持人入会地址。 | | chairPasswd | String | 主持人入会密码。 | | guestJoinUri | String | 嘉宾入会地址。 | | guestPasswd | String | 嘉宾入会密码。 | | audienceJoinUri | String | 观众入会地址。 | | audiencePasswd | String | 观众入会密码。 | | enableRecording | String | 录制是否开启。 - Y: 开启 - N: 不开启 | | liveAddress | string | 主流直播推流地址。 | | auxAddress | string | 辅流直播推流地址。 | | liveUrl | string | 直播房间地址。 | | attendees | Array of String objects | 与会嘉宾名称列表。 | #### 请求消息示例 ``` POST /v1/wss/webinar/open/conferences HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 Content-Length: 627 Content-Type: application/json;charset=UTF-8 X-Access-Token: cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F X-APIG-Mode: debug { "subject": "网络研讨会", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": "56", "vmrID": "2c908f997544c76501754927728b0167", "attendees": [{ "appId": "appid", "userName": "user", "sms": "+8613111111111", "deptName": "dept", "phone": "+86131****1111", "userAccount": "userAccount", "email": "user@xxx.com" }], "notifySetting": { "enableEmail": "N", "enableSms": "N", "enableCalendar": "N" }, "callRestriction": false, "guestPasswd": null, "audiencePasswd": null, "audienceScope": 0, "scope": 0, "enableRecording": "Y", "liveAddress": "rtmp://pushs.skylin.tv/live/lxep4ed5?auth_info=20121116-784d9d656ayongc0e208a6a126ca78cc1", "auxAddress": "rtmp://pushs.skylin.tv/live/lxep4ed5?auth_info=20121116-784d9d656abec8c0yonga6a126ca78cc", "liveUrl": "http://e516b694a7974cd5bceab78ee05b8f43.skylin.tv/watch/ldx4o" } ``` #### 响应消息示例 ``` 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: Fri, 23 Apr 2021 07:30:56 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 426 X-APIG-Ratelimit-Api: remain:99,limit:100,time:1 minute X-APIG-Ratelimit-Api-Allenv: remain:199,limit:200,time:1 second X-APIG-Upstream-Latency: 425 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 321 X-Frame-Options: SAMEORIGIN X-Request-Id: 93c193ab24312a9abe45638a3381a26b X-Xss-Protection: 1;mode=block { "conferenceId": "982311022", "corpId": "314765464", "subject": "网络研讨会", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": 56, "state": "schedule", "scheduserId": "bb05917f7363407ea6b1df019fdf257a", "scheduserName": "user", "vmrPkgName": "网络研讨会_1000方观众", "callRestriction": false, "scope": 0, "audienceScope": 0, "chairJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/f78c393***********************************c43c3d", "chairPasswd": "******", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e057f9************************************0014d", "guestPasswd": "******", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab78*********************************aac4d7e5", "audiencePasswd": "******", "enableRecording": "Y", "liveUrl": "http://e516b694a7974cd5bceab78ee05b8f43.skylin.tv/watch/ldx4o", "attendees": ["user"] } ``` #### 错误码 当您使用华为云会议服务端API时，如果遇到"WSS"开头的错误码，请参考[华为云API错误中心](https://apierrorcenter.developer.huaweicloud.com/apierrorcenter/errorcode?product=Meeting)。 #### CURL命令示例 ``` curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F' -d '{ "subject": "网络研讨会", "startTime": "2021-04-29 11:00", "duration": 120, "timeZoneId": "56", "vmrID": "2c908f997544c76501754927728b0167", "attendees": [{ "userId": "bb05917f7363407ea6b1df019fdf257a", "userName": "user", "sms": "+86131****1111", "deptName": "dept", "phone": "+86131****1111", "userAccount": "userAccount", "email": "user@xxx.com" }], "notifySetting": { "enableEmail": "N", "enableSms": "N", "enableCalendar": "N" }, "callRestriction": false, "guestPasswd": null, "audiencePasswd": null, "audienceScope": 0, "scope": 0 }' 'https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences' ```