华为云用户手册

响应参数 表4 QueryDeptResultDTO数据结构 参数 类型 描述 deptCode String 部门编码。 deptName String 部门名称。 isLeafNodes Boolean 是否为叶子节点(没有子部门的称为叶子节点)。 childDepts Array of ChildDeptDTO objects 子部门详情。 表5 ChildDeptDTO数据结构 参数 类型 描述 deptCode String 部门编码。 deptName String 部门名称。 isLeafNodes Boolean 是否为叶子节点(没有子部门的称为叶子节点)。

请求消息示例 GET /v1/usg/abs/departments/1 Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

推送会议关闭事件示例 请求消息： POST /openapi/meetingevent Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache X-Request-ID: 539e8b710378987ffc5eb844b5e5c290 { "appID": "123456789", "timestamp": 1629813991351, "nonce": "60426560", "signature": "e3945cab9c583f394ae5e4957b83905e779cacaa2377d9542e19e011cc60a139", "eventInfo": { "event": "meeting.conclude", "timestamp": 1629813991351, "payload": { "meetingInfo": { "meetingID": "987446316", "meetingUUID": "0307e0400f0a11eca58a9fcb8e69dde8", "meetingCycleSubID": "6038a614321511ecaf39ffbe33ed54dc" } } } } 响应消息： 响应： HTTP/1.1 200 Date: Tue, 17 Dec 2019 09:32:47 GMT Content-Type: application/json;charset=UTF-8 Connection: keep-alive X-Request-ID: 539e8b710378987ffc5eb844b5e5c290

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

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1811 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: acf5bd2cc7c7f90fe7ab6b95a8c753d5 Server: api-gateway X-Request-Id: e2bc0a1429cb2fd52db88ba6fa2c44a8 { "id": "b958adc3639b11ecb310e97279c39e66", "subscriberId": "12345678", "url": "https://meeting.huaweicloud.com", "status": 1 }

请求消息示例 GET /v1/mmc/management/webhook/link-config?corpId=1387317060 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)

业务流程 图1 企业级会议事件推送配置及启用推送流程图 获取鉴权token，请参考接口执行App ID鉴权或执行鉴权。 在“设置事件推送”接口中设置企业事件推送配置成功。 在调用“开启事件推送”接口后，华为云会议后台会给指定的URL发送一个“启用验证”请求，第三方服务端需要按照要求返回响应，响应中带的nonce必须跟上述请求中保持一致。请参考接口启用验证事件。 启用成功后，企业内的会议事件产生后，华为云会议后台会给指定的URL推送相应的事件。请参考接口会议开始事件、会议结束事件和会议关闭事件。 第三方服务端收到事情推送的POST请求后，都应响应200 OK消息。

响应消息示例 HTTP/1.1 200 OK Content-Length: 141 Cache-Control: no-store Connection: keep-alive Content-Type: application/json Date: Thu, 24 Dec 2020 06:25:59 GMT Server: api-gateway X-APIG-Latency: 261 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: 259 X-Envoy-Upstream-Service-Time: 210 X-Request-Id: f991eeec77df1692c74f253d765ca146 { "uuid": "stb7fe307f8971e44acc5cf8be2112575ff8387ff6ddea68a5e", "regionIP": "100.94.23.40" }

请求消息示例 POST /v1/mmc/management/conferences/start HTTP/1.1 Connection: keep-alive X-Access-Token: ******* user-agent: WeLink-desktop Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "conferenceID": "986030665", "password": "******" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceID": "986030665","password": "******"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences/start'

请求消息示例 GET /v1/metrics/conference/threshold?thresholdType=AUDIO 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 响应参数 参数 类型 描述 latency ThresholdData object 延迟阈值信息，单位为毫秒(ms) thresholdType = CPU时无效 jitter ThresholdData object 抖动阈值信息，单位为毫秒(ms) thresholdType = CPU时无效 packetLoss PacketThresholdData object 丢包率阈值信息，单位为百分比(%) thresholdType = CPU时无效 clientCpuMax CPUThresholdData object 会议最大CPU阈值信息，单位为百分比(%) 仅当thresholdType = CPU时有效 systemCpuMax CPUThresholdData object 系统最大CPU阈值信息，单位为百分比(%) 仅当thresholdType = CPU时有效 表5 ThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 自定义接收方向阈值，单位为毫秒(ms)。 receivingDefault Integer 默认接收方向阈值，单位为毫秒(ms)。 sending Integer 自定义发送方向阈值，单位为毫秒(ms)。 sendingDefault Integer 默认发送方向阈值，单位为毫秒(ms)。 表6 PacketThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 自定义接收方向阈值，单位为百分比(%)。 receivingDefault Integer 默认接收方向阈值，单位为百分比(%)。 sending Integer 自定义发送方向阈值，单位为百分比(%)。 sendingDefault Integer 默认发送方向阈值，单位为百分比(%)。 表7 CPUThresholdData 数据结构 参数名称 参数类型 描述 cpu Integer 自定义CPU阈值，单位为百分比(%)。 cpuDefault Integer 默认CPU阈值，单位为百分比(%)。

响应消息示例 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 { "latency": { "receiving": 500, "receivingDefault": 800, "sending": 500, "sendingDefault": 800 }, "jitter": { "receiving": 500, "receivingDefault": 800, "sending": 500, "sendingDefault": 800 }, "packetLoss": { "receiving": 20, "receivingDefault": 50, "sending": 20, "sendingDefault": 50 } }

请求消息示例 POST /v1/metrics/conference/threshold?thresholdType=AUDIO 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) { "latency": { "receiving": 500, "sending": 500 }, "jitter": { "receiving": 500, "sending": 500 }, "packetLoss": { "receiving": 20, "sending": 20 } }

CURL命令示例 curl -k -i -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'thresholdType=AUDIO' https://api.meeting.huaweicloud.com/v1/metrics/conference/threshold -d'{"latency":{"receiving":500,"sending":500},"jitter":{"receiving":500,"sending":500},"packetLoss":{"receiving":20,"sending":20}}'

响应消息示例 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 { "code": "0", "message": "OK" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 thresholdType 是 String Query 阈值类型。 AUDIO：音频相关阈值 VIDEO：视频相关阈值 SCREEN：屏幕共享相关阈值 CPU：CPU相关阈值 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 latency 否 SetThresholdData object Body 延迟阈值设置值，单位为毫秒(ms) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 jitter 否 SetThresholdData object Body 抖动阈值设置值，单位为毫秒(ms) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 packetLoss 否 SetPacketThresholdData object Body 丢包率阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时必填 thresholdType = CPU时无效 clientCpuMax 否 SetCPUThresholdData object Body 会议最大CPU阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时无效 thresholdType = CPU时必填 systemCpuMax 否 SetCPUThresholdData object Body 系统最大CPU阈值设置值，单位为百分比(%) thresholdType = AUDIO/VIDEO/SCREEN时无效 thresholdType = CPU时必填 表3 SetThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 接收方向阈值设定值，单位为毫秒(ms)。 取值范围：0 - 10000。 sending Integer 发送方向阈值设定值，单位为毫秒(ms)。 取值范围：0 - 10000。 表4 SetPacketThresholdData 数据结构 参数名称 参数类型 描述 receiving Integer 接收方向阈值设定值，单位为百分比(%)。 取值范围：0 - 100。 sending Integer 发送方向阈值设定值，单位为百分比(%)。 取值范围：0 - 100。 表5 SetCPUThresholdData 数据结构 参数名称 参数类型 描述 cpu Integer CPU阈值设定值，单位为百分比(%)。 取值范围：0 - 100。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"enableSSO": true,"domain": "clouddragon.huawei.com","authorizeUrl": "http://127.0.0.1:8444/sns/userinfo","getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token","clientId": "18bc94a643bd4b93aab3179726120943","clientSecret": null,"scope": null,"accFieldName": "openid","getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo","oauth2ServerType": 0,"pcSchemaUrl": "http://127.0.0.1:8444/schema/pc","androidSchemaUrl": "http://127.0.0.1:8444/schema/android","iosSchemaUrl": "http://127.0.0.1:8444/schema/ios","thirdName": "openid","thirdEmail": null,"thirdMobile": null,"thirdAccessToken": "access_token","thirdHeadImgUrl": null}' 'https://api.meeting.huaweicloud.com/v1/usg/acs/authorizeconfig'

请求消息示例 POST /v1/usg/acs/authorizeconfig Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "enableSSO": true, "domain": "clouddragon.huawei.com", "authorizeUrl": "http://127.0.0.1:8444/sns/userinfo", "getTokenUrl": "http://127.0.0.1:8444/sns/oauth2/access_token", "clientId": "18bc94a643bd4b93aab3179726120943", "clientSecret": null, "scope": null, "accFieldName": "openid", "getUserInfoUrl": "http://127.0.0.1:8444/sns/userinfo", "oauth2ServerType": 0, "pcSchemaUrl": "http://127.0.0.1:8444/schema/pc", "androidSchemaUrl": "http://127.0.0.1:8444/schema/android", "iosSchemaUrl": "http://127.0.0.1:8444/schema/ios", "thirdName": "openid", "thirdEmail": null, "thirdMobile": null, "thirdAccessToken": "access_token", "thirdHeadImgUrl": null }

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 Content-Type 是 String Header Body的媒体格式。取值:application/json; charset=UTF-8 enableSSO 是 Boolean Body 是否开启SSO登录。 domain 否 String Body 企业 域名 。 说明： 开启SSO登录时必填。 authorizeUrl 否 String Body 鉴权中心URL。 说明： 开启SSO登录时必填。 getTokenUrl 否 String Body 获取Token URL。 说明： 开启SSO登录时必填。 clientId 否 String Body APPID。 说明： 开启SSO登录时必填。 clientSecret 否 String Body APP密钥。 说明： 开启SSO登录时，当getTokenUrl或者getUserInfoUrl有变更时必填。 开启SSO登录时，当getTokenUrl和getUserInfoUrl未变更时，且不修改APP密钥，则置空即可。 scope 否 String Body 授权范围。 openid：OAuth2.0的OIDC accFieldName 否 String Body 第三方账号的字段名称。 说明： 开启SSO登录时必填。 getUserInfoUrl 否 String Body 用户信息查询URL。 oauth2ServerType 否 Integer Body 鉴权类型。 0：OAuth2.0鉴权 pcSchemaUrl 否 String Body 拉起PC端终端的schema。 androidSchemaUrl 否 String Body 拉起安卓端终端的schema。 iosSchemaUrl 否 String Body 拉起ios端终端的schema。 thirdName 否 String Body 第三方名称的字段名称。 thirdEmail 否 String Body 第三方邮箱的字段名称。 thirdMobile 否 String Body 第三方手机号的字段名称。 thirdAccessToken 否 String Body 第三方accessToken的字段名称。 说明： 开启SSO登录时必填。 thirdHeadImgUrl 否 String Body 第三方头像链接的字段名称。

请求消息示例 PUT /v1/mmc/management/webhook/change-status?id=b21e0291639911ecb31073dbfc5b38fa&status=1 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

CURL命令示例 curl -k -i -X PUT -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' 'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/change-status?id=b21e0291639911ecb31073dbfc5b38fa&status=1'

请求参数 表2 参数说明 名称 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 corpId 否 String Body 企业ID。按企业注册回调时需要填写。 spId 否 String Body SP ID。多租户场景下，按SP注册回调时需要填写。 subscriberId 是 String Body 订阅者ID subscriberKey 是 String Body 订阅者秘钥 url 是 String Body 订阅url。 说明： 必须使用HTTPS。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1157 Connection: keep-alive http_proxy_id: 462abfcfa8a41c2c5450eb7648bf5ad2 Server: api-gateway X-Request-Id: 7ba6f742610c03a64262b126fb336a5d

请求消息示例 POST /v1/mmc/management/webhook/link-config Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC Content-Type: application/json user-agent: WeLink-desktop Content-Length: 372 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "corpId": "1387317060", "subscriberId": "12345678", "subscriberKey": "123465", "url": "https://meeting.huaweicloud.com" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"corpId": "1387317060","subscriberId": "12345678","subscriberKey": "123465","url": "https://meeting.huaweicloud.com"}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/webhook/link-config'

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 type 否 Integer Query 取消会议操作类型。默认已召开的会议不能取消。 1：需要结束正在召开的会议 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个H CS O站点鉴权。 说明： 该参数将废弃，请勿使用。