华为云用户手册

  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 63facce44898efa03629afd189da7f0f { "count": 1, "data": { "creationTimestamp": 1592795500847, "fileCode": "31531e3de7904613a2364c9e1df1fe11", "fileId": "5", "fileName": "20200622_111136_meeting_record.White.cwb", "fileSize": 8044, "pdfFileId": "7", "pdfFileName": "20200622_111136_meeting_record.White.pdf", "pdfFileSize": 63787, "thumbnailFileId": "6", "thumbnailFileName": "20200622_111136_meeting_record.White.jpg", "thumbnailFileSize": 62816, "topic": "20200622_111136_meeting_record.White", "userId": "562ed8350ad5472a807ba41c22e77ae6" }, "limit": 10, "offset": 0 }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量,若超过最大数量,则返回最后一页。 默认值:0 limit 否 Integer Query 查询数量。 默认值:10 searchKey 否 String Query 搜索条件。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总数量。 limit Integer 每页显示的条目数量。 默认值:10。 offset Integer 页面起始页,从0开始。 data Array of ListMeetingFileResponseDTO objects 会议纪要列表。 表5 ListMeetingFileResponseDTO 数据结构 参数 类型 描述 fileCode String 会议纪要文件码。 fileId String 文件Id。 fileName String 文件名。 fileSize Long 文件大小,单位字节。 pdfFileId String pdf文件Id。 pdfFileName String pdf文件名。 pdfFileSize Long pdf文件大小,单位字节。 thumbnailFileId String 缩略图文件Id。 thumbnailFileName String 缩略图文件名。 thumbnailFileSize Long 缩略图文件大小,单位字节。 topic String 文件主题。 creationTimestamp Long 文件创建时间戳。 userId String 用户UUID。
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 0 Connection: keep-alive http_proxy_id: 40c9d32a92b43f85e5cd12617b49535b Server: api-gateway X-Request-Id: a02164ff20cbc841c6c0e9ab38a07e5b
  • 请求消息示例 DELETE /v1/mmc/management/conferences/cyclesubconf?conferenceID=985325849 Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "cycleSubConfIDs": [ "04eb5acd0a0511ec8546359413178027", "04eb5ace0a0511ec854667fcfbf3d9a9" ] }
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN, 英文为en-US。 [数组元素] 是 Array of strings Body 云会议室ID列表。 maxLength:100 minLength:1
  • 请求消息示例 POST /v1/usg/dcs/corp/vmr/delete Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 36 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["ff8080816b9ec3ab016ba125aca20082"]
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: fbbc91569f0efed914e0427fc2a9c4ac
  • CURL命令示例 curl -k -i -v -X POST -H "content-type:application/json" -H "X-Access-Token:cnrYgnb27xFYyyYu4HNdmZ0zJL8WcKc3M6ir" -d "[\"ff8080816b9ec3ab016ba125aca20082\"]" https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/vmr/delete
  • 请求消息示例 GET /v1/metrics/dashboard/statistic/conference/participant?timeUnit=D&startTime=2021-04-01&endTime=2021-04-30&category=user_participate_info&offset=0&limit=4 Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应参数 表4 响应参数 参数 类型 描述 count Integer 总记录数。 limit Integer 查询条目数量。 offset Integer 查询偏移量。 data Array of StatisticParticipateDataItem objects 会议与会数据按时间点统计的查询结果数组。 表5 StatisticParticipateDataItem数据结构 参数名称 参数类型 描述 time String 日期/月份。 confUserName String 与会用户名称。 category = user_participate_info时有效。 confUserAccount String 与会用户账户。 category = user_participate_info时有效。 confUserDeptName String 与会用户所属部门。 category = user_participate_info时有效。 confUserCount String 用户与会数。 category = user_participate_info时有效。 confUserDuration String 用户与会时长(秒)。 category = user_participate_info时有效。 confHardTerminalName String 与会硬件终端名称。 category = hard_terminal_participate_info时有效。 confHardTerminalModel String 与会硬件终端型号。 category = hard_terminal_participate_info时有效。 confHardTerminalUserId String 与会硬件终端的用户ID。 category = hard_terminal_participate_info时有效。 confHardTerminalCount String 硬件终端与会数。 category = hard_terminal_participate_info时有效。 confHardTerminalDuration String 硬件终端与会时长(秒)。 category = hard_terminal_participate_info时有效。 deviceType String 与会设备类型。 category = participant_type_info时有效。 deviceVersion String 与会设备版本。 category = participant_type_info时有效。 deviceAttendanceCount String 设备与会数。 category = participant_type_info时有效。
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 2450 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c Server: api-gateway X-Request-Id: ac9f75ec3c97c823f128526a924532b2 { "count": 3, "limit": 4, "offset": 0, "data": [{ "time": "2021-04-18", "confUserName": "linghaiwen", "confUserAccount": "lingwenhai", "confUserDeptName": "1", "confUserCount": "1", "confUserDuration": "53" }, { "time": "2021-04-19", "confUserName": "zhaoyuwei", "confUserAccount": "haiwenling", "confUserDeptName": "lingwenhai", "confUserCount": "3", "confUserDuration": "33" }, { "time": "2021-04-19", "confUserName": "linghaiwen", "confUserAccount": "lingwenhai", "confUserDeptName": "lingwenhai", "confUserCount": "2", "confUserDuration": "22" } ] }
  • CURL命令示例 curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -s "https://api.meeting.huaweicloud.com/v1/metrics/dashboard/statistic/conference/participant?timeUnit=D&startTime=2021-04-01&endTime=2021-04-30&category=user_participate_info&offset=0&limit=4"
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量。 取值:大于等于0,默认值为0 若offset大于等于最大条目数量,则返回最后一页数据,页数根据总条目数和limit计算得出 limit 否 Integer Query 查询的条目数量。 取值:1-500,默认值为20 timeUnit 是 String Query 查询时间维度,取值: D: 按日查询 M: 按月查询 startTime 是 String Query 查询时间范围的开始时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 endTime 是 String Query 查询时间范围的结束时间,格式根据timeUnit的取值而定。 timeUnit = D,格式:yyyy-MM-dd,此情况下startTime与endTime间隔最多31日 timeUnit = M,格式:yyyy-MM,此情况下startTime与endTime间隔最多12个月 category 是 String Query 查询分类,取值: user_participate_info: 用户与会统计数据 hard_terminal_participate_info: 硬件终端与会统计数据 participant_type_info: 与会设备统计数据 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。
  • 请求消息示例 PUT /v1/mmc/control/conferences/wsToken?conferenceID=900825541 Connection: keep-alive content-type: application/json user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) X-Conference-Authorization: cnr351949b429a0b74b032fc2e40977ce77a2037f0391a7a122
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 571b4dfceff545fae29aa14cea761079 Server: api-gateway X-Request-Id: f78b007ec2dabf1498620131c7bc19e0 { "webSocketToken": "cnr6e88712f1c89a7b4e3b989596fc420fd43b45bf8ef35c1db" }
  • 请求消息示例 DELETE /v1/mmc/management/webhook/link-config?id=b21e0291639911ecb31073dbfc5b38fa Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 39 Connection: keep-alive http_proxy_id: 40c9d32a92b43f85e5cd12617b49535b Server: api-gateway X-Request-Id: a02164ff20cbc841c6c0e9ab38a07e5b
  • 请求消息示例 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": "656324", "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": "656324","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 参数说明 参数 是否必须 类型 位置 描述 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 直播观看地址
  • 请求参数 表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:按会议开始时间降序排序
  • 响应参数 表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/ff63e686eebc76818e9d936b62887c5aca7bf4bf9e528069", "chairPasswd": "3629433819", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/900818751/313570aca67728816382f6caf06f378ac869ea5741d6c65d", "guestPasswd": "843469", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/900818751/56796cd379e5f38f7fe721e09e36aba3162841a9a1bf2afe", "audiencePasswd": "1103497522" }, { "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/ff63e686eebc76818e9d936b62887c5aca7bf4bf9e528069", "chairPasswd": "3629433819", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/900132199/313570aca67728816382f6caf06f378ac869ea5741d6c65d", "guestPasswd": "843469", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/900132199/56796cd379e5f38f7fe721e09e36aba3162841a9a1bf2afe", "audiencePasswd": "1103497522" }, { "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/32a4a91bbf088c6164bbb35131be44ed9ebaeafc071b92e8", "chairPasswd": "651852", "guestJoinUri": "https://meeting.huaweicloud.com/#/j/987610448/b7018a765dc4b0b331a215a98d5a4e8760a316397bdf59a2", "guestPasswd": "733353", "audienceJoinUri": "https://meeting.huaweicloud.com/#/j/987610448/06134f170bdbb83d46bae8e73a0f25d75ce228b067354622", "audiencePasswd": "235949" }] }
  • CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9' -d '{"contact": "+86136********","country": "chinaPR","verificationCode": "685348"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/contact
  • 请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用UUID,若不携带,则后台自动生成。 Accept-Language 否 String Header 语言参数,默认为中文zh-CN,英文为en-US。 contact 是 String Body 后台自动识别是手机号还是邮箱。 如果为手机号,必须加上国家码,例如中国大陆手机为“+86xxxxxxxxxxx”,当填写手机号时 “country”参数必填。 maxLength:255 minLength:1 country 否 String Body 手机号所属的国家。 默认值:chinaPR。 长度:0-255。 verificationCode 否 String Body 验证码,在校验的场景时需要携带。
  • 请求消息示例 PUT /v1/usg/dcs/member/contact Connection: keep-alive X-Access-Token: stb3te1tKXh5mDfICbiSOP0GOoqwkWEDgfB9 Content-Type: application/json Content-Length: 68 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "contact": "+86136********", "country": "chinaPR", "verificationCode": "226607" }
  • 响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 143 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf
共100000条