华为云用户手册

请求消息示例 GET /v1/wss/webinar/open/conferences/history?endTime=2021-04-24%2023%3A59&limit=10&offset=0&startTime=2021-04-04%2000%3A01 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ X-APIG-Mode: debug

响应参数 表4 响应参数 参数 类型 描述 offset Integer 偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of OpenWebinarHistoryInfo objects 历史网络研讨会信息列表。 表5 OpenWebinarHistoryInfo 数据结构 参数 类型 描述 conferenceId String 网络研讨会ID。 confUUID String 网络研讨会UUID。 subject String 网络研讨会主题。 scheduserName String 预订者名称。 moderator String 网络研讨主持人名称。 deptName String 预订人部门名称。 startTime String 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 duration Integer 网络研讨会持续时长，单位分钟。 actualStartTime String 网络研讨会实际召开时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 endTime String 网络研讨会结束时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 actualDuration Integer 网络研讨会实际时长，单位分钟。 attendeeCount Integer 与会人数。 chairCount Integer 主持人数。 guestCount Integer 嘉宾数。 audienceCount Integer 观众数。 vmrId String VMR ID。 vmrPkgName String 网络研讨会VMR名称。 vmrPkgAudienceParties Integer 网络研讨会VMR最大观众数。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 offset 否 Integer Query 查询偏移量,若超过最大数量，则返回最后一页的数据。 默认为0。 limit 否 Integer Query 查询数量。默认值：10。最大500条。 searchKey 否 String Query 查询条件。支持主题/会议ID/创建人和资源搜索。 sortType 否 String Query 查询结果排序。默认升序。 ASC_StartTIME：按会议开始时间升序排序 DSC_StartTIME：按会议开始时间降序排序 startTime 否 String Query 开始时间（UTC时间）, 格式：yyyy-MM-dd HH:mm。 endTime 否 String Query 结束时间（UTC时间）, 格式：yyyy-MM-dd HH:mm。

响应参数 表4 响应参数 参数 类型 描述 offset Integer 偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of OpenWebinarUpcomingInfo objects 即将召开研讨会信息列表。 表5 OpenWebinarUpcomingInfo 数据结构 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String 企业ID。 subject String 网络研讨会主题。 deptName String 预订人部门名称。 description String 网络研讨会描述。 startTime String 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 duration Integer 网络研讨会持续时长，单位分钟。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 scheduserId String 网络研讨会预订者的用户UUID。 scheduserName String 预订者名称。 vmrPkgName String 网络研讨会VMR名称。 chairJoinUri String 主持人入会地址。 chairPasswd String 主持人入会密码。 guestJoinUri String 嘉宾入会地址。 guestPasswd String 嘉宾入会密码。 audienceJoinUri String 观众入会地址。 audiencePasswd String 观众入会密码。

请求消息示例 GET /v1/wss/webinar/open/conferences/upcoming?limit=10&offset=0 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ X-APIG-Mode: debug

响应消息示例 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, 30 Apr 2021 02:19:39 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 67 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: 67 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 41 X-Frame-Options: SAMEORIGIN X-Request-Id: 7215911f1edff234a32a4b90b679235f X-Xss-Protection: 1;mode=block { "offset": 0, "limit": "10", "count": 3, "data": [{ "conferenceId": "900818751", "corpId": "314765464", "subject": "test1234", "startTime": "2020-11-23 07:30", "duration": 120, "timeZoneId": 56, "deptName": "dept", "scheduserName": "user2", "vmrPkgName": "网络研讨会_1000方观众", "chairJoinUri": "https://meeting.huaweicloud.com/#/j/900818751/ff63****************************************8069", "chairPasswd": "*********", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/900818751/3135****************************************c65d", "guestPasswd": "*********", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/900818751/5679**************************************2afe", "audiencePasswd": "*********" }, { "conferenceId": "900132199", "corpId": "314765464", "subject": "user3网络研讨会", "startTime": "2020-11-25 10:00", "duration": 120, "timeZoneId": 56, "deptName": "dept", "scheduserName": "user3", "vmrPkgName": "网络研讨会_1000方观众", "chairJoinUri": "https://meeting.huaweicloud.com/#/j/900132199/ff63****************************************8069", "chairPasswd": "********", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/900132199/3135****************************************c65d", "guestPasswd": "********", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/900132199/5679*************************************2afe", "audiencePasswd": "********" }, { "conferenceId": "987610448", "corpId": "314765464", "subject": "user4网络研讨会", "startTime": "2021-04-30 02:30", "duration": 45, "timeZoneId": 56, "deptName": "网络研讨会Webinar", "scheduserName": "user4", "vmrPkgName": "网络研讨会_1000方观众", "chairJoinUri": "https://meeting.huaweicloud.com/#/j/987610448/32a4***************************************b92e8", "chairPasswd": "*******", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/987610448/b701****************************************59a2", "guestPasswd": "*******", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/987610448/0613*************************************4622", "audiencePasswd": "*******" }] }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 offset 否 Integer Query 查询偏移量,若超过最大数量，则返回最后一页的数据。 默认为0。 limit 否 Integer Query 查询数量。默认值：10。最大500条。 searchKey 否 String Query 查询条件。支持主题/会议ID/创建人和资源搜索。 sortType 否 String Query 查询结果排序。默认升序。 ASC_StartTIME：按会议开始时间升序排序 DSC_StartTIME：按会议开始时间降序排序

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 offset 否 Integer Query 查询偏移量,若超过最大数量，则返回最后一页的数据。 默认为0。 limit 否 Integer Query 查询数量。默认值：10。最大500条。 searchKey 否 String Query 查询条件。支持主题/会议ID/创建人和资源搜索。 sortType 否 String Query 查询结果排序。默认升序。 ASC_StartTIME：按会议开始时间升序排序 DSC_StartTIME：按会议开始时间降序排序

请求消息示例 GET /v1/wss/webinar/open/conferences/ongoing?limit=10&offset=0&sortType=ASC_StartTIME HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ X-APIG-Mode: debug

CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:cnr1519IZUrrVdIgql7TRJHRl6AfFOOKzkO9zmqJ' https://api.meeting.huaweicloud.com/v1/wss/webinar/open/conferences/ongoing?limit=10&offset=0&sortType=ASC_StartTIME

响应参数 表4 响应参数 参数 类型 描述 offset Integer 偏移量。 limit Integer 每页的记录数。 count Integer 总记录数。 data Array of OpenWebinarOngoingInfo objects 正在网络召开研讨会信息列表。 表5 OpenWebinarOngoingInfo 数据结构 参数 类型 描述 conferenceId String 网络研讨会ID。 confUUID String 网络研讨会UUID。 corpId String 企业ID。 subject String 网络研讨会主题。 deptName String 预订人部门名称。 description String 网络研讨会描述。 startTime String 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 scheduserId String 网络研讨会预订者的用户UUID。 scheduserName String 预订者名称。 vmrPkgName String 网络研讨会VMR名称。 chairJoinUri String 主持人入会地址。 chairPasswd String 主持人入会密码。 guestJoinUri String 嘉宾入会地址。 guestPasswd String 嘉宾入会密码。 audienceJoinUri String 观众入会地址。 audiencePasswd String 观众入会密码。 onlineAttendeeCount Integer 实时在线人数。

响应消息示例 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, 30 Apr 2021 02:14:51 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 88 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: 86 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 25 X-Frame-Options: SAMEORIGIN X-Request-Id: c56c59b8c68443fcf480c83a26424b7e X-Xss-Protection: 1;mode=block { "offset": 0, "limit": "10", "count": 1, "data": [{ "onlineAttendeeCount": 1, "confUUID": "9cc9db0ba95911eba637897a0ff0f70e", "deptName": "dept", "conferenceId": "981326872", "corpId": "314765464", "subject": "网络研讨会", "startTime": "2021-04-30 02:13", "timeZoneId": 56, "scheduserName": "user", "vmrPkgName": "网络研讨会_1000方观众", "chairJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/64368***************************************034f", "chairPasswd": "*******", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/411ed***************************************a7fb", "guestPasswd": "*******", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/981326872/b08***************************************5d8", "audiencePasswd": "*******" }] }

请求消息示例 DELETE /v1/wss/webinar/conferences/989692846 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1419S2HGv2BLFO3HiDrxnyEO6lKKuDlyarRKn

响应消息示例 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:20:08 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 137 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: 137 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 114 X-Frame-Options: SAMEORIGIN X-Request-Id: 215f98bb32634fa5f7e727324f9abe7f X-Xss-Protection: 1;mode=block

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conference_id 是 String Path 网络研讨会ID X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 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 主持人、嘉宾入会范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceScope 否 Integer Body 观众入会范围。 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 直播观看地址

请求消息示例 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" }

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'

响应消息示例 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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conference_id 是 String Path 网络研讨会ID。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

请求消息示例 GET /v1/wss/webinar/open/conferences/982311022 HTTP/1.1 Host: 251ba26eef46472d97fa4462d514b044.APIG.cn-north-7.huaweicloudapis.com User-Agent: APIGatewayDebugClient/1.0 X-Access-Token: cnr1519GbhwxP6eXPT70gHBabwCoAnFHezYAln4F X-APIG-Mode: debug

响应参数 表4 响应参数 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String 企业ID。 subject String 会议主题。长度限制为128个字符。 description String 网络研讨会主题。 startTime String 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 duration Integer 网络研讨会持续时长，单位分钟，取值范围[15,1440]。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“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 观众入会密码。 attendees Array of strings 与会嘉宾名称列表。 notifySetting NotifySetting object 网络研讨会通知配置。 enableRecording String 录制是否开启。 Y: 开启 N: 不开启 liveAddress String 主流直播推流地址。仅设置liveAddress，未设置auxAddress，无人共享时直播画面显示演讲者视图，有人共享时直播画面显示共享屏幕视图。若同时设置了liveAddress和auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 auxAddress String auxAddress对应辅流直播推流地址，在设置liveAddress后如果设置了auxAddress，liveAddress对应直播画面显示演讲者视图，auxAddress对应直播画面显示共享屏幕视图。 liveUrl String 直播观看地址。

响应消息示例 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:44:58 GMT Pragma: no-cache Server: api-gateway Strict-Transport-Security: max-age=16070400; includeSubDomains X-APIG-Latency: 87 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: 86 X-Content-Type-Options: nosniff X-Download-Options: noopen X-Envoy-Upstream-Service-Time: 32 X-Frame-Options: SAMEORIGIN X-Request-Id: 11379ed26a172206cf67e6288b0d73db X-Xss-Protection: 1;mode=block { "conferenceId": "982311022", "corpId": "314765464", "subject": "网络研讨会", "description": "", "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/f78c***************************************43c3d", "chairPasswd": "********", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/8e05****************************************014d", "guestPasswd": "********", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/982311022/aab7*************************************4d7e5", "audiencePasswd": "*********", "notifySetting": { "enableCalendar": "N", "enableSms": "N", "enableEmail": "N" }, "attendees": ["user"], "enableRecording": "Y" }

请求消息示例 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"] }

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'

响应参数 表6 响应参数 参数 类型 描述 conferenceId String 网络研讨会ID。 corpId String 企业ID。 subject String 网络研讨会主题。 description String 网络研讨会描述。 startTime String 网络研讨会开始时间（UTC时间），格式“yyyy-MM-dd HH:mm”。 duration Integer 网络研讨会持续时长，单位分钟，取值范围[15,1440]。 timeZoneId Integer 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“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 与会嘉宾名称列表。

请求参数 表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： 不开启

开启实时字幕示例 var confToken = 获取会控Token接口; var openRealTimeSubtitle = JSON.stringify({ sequence: "000000000000000002611382273463", action: "ConfControl", type: "REALTIMESUBTITLE", data: JSON.stringify({ conferenceID: "986812232", confToken: confToken, isSubtitle: "1", subtitleType: "0" }), });

实时字幕推送示例 { "action": "RealTimeSubtitleNotify", "version": "1614936396556", "createTime": "1614936396556", "msgID": "e20544e37d9411ebbae3fd5b302953d3", "msgMode": 0, "confID": "981112355", "data": { "msgs ": [{ "subtitleLang": "Mandarin", "translateText": "实时字幕。 ", "id ": "c0196fb9-c9c3-47ba-a685-05223552de2f" }], "isFinal ": false, "timestamp ": 1614936396553, "beginTime": 1528680, "endTime": 1530900, "participantID": "984r8z9f4p6p6pry97yfan6z76681f09" } }