华为云用户手册

响应消息示例 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": { "adminInfo": { "account": "zhangsan@corp", "adminType": 0, "country": "chinaPR", "email": "******", "id": "58eed901985149899b966242e0a7d644", "name": "zhangsan", "phone": "+86191****9092" }, "basicInfo": { "address": "浙江杭州", "country": "chinaPR", "description": "description", "email": "******", "fax": "+123456789", "name": "华为技术有限公司", "phone": "+86191****9092", "spId": "8a8d1384700be6870170117caca923af" }, "id": 818803911, "resInfo": { "corpVcRes": { "confCallCount": 100, "hwVisionCount": 0, "ideaHubCount": 0, "liveCount": 0, "recordCapability": 0, "roomCount": 0, "te1080pHardCount": 100, "te720pHardCount": 100, "teSoftCount": 100, "thirdPartyHardCount": 100, "vmrPkgList": [ { "vmrName": "大型云会议室-50方", "vmrPkgCount": 10, "vmrPkgId": "ff808081699b56cb0169c411a0980152", "vmrPkgParties": 50, "vmrPkgUsedCount": 0 } ] } } }, "limit": 5, "offset": 0 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量，若超过最大数量，则返回最后一页。 默认值：0 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 Integer Query 搜索条件，支持名称、手机、邮箱、账号模糊搜索。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

请求消息示例 PUT /v1/usg/dcs/sp/corp/818803911 Connection: keep-alive Content-Type: application/json X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Length: 173 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "adminInfo": { "country": "chinaPR", "email": "******", "name": "zhangsan@corp", "phone": "+86191****9092" }, "basicInfo": { "country": "chinaPR", "description": "description", "email": "******", "fax": "+123456789", "name": "华为技术有限公司", "phone": "+86191****9092" }, "groupId": "297e87ec7713734b01771458c2d80000", }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"adminInfo": {"country": "chinaPR","email": "******","name": "zhangsan@corp","phone": "+86191****9092"},"basicInfo": {"country": "chinaPR","description": "description","email": "******","fax": "+123456789","name": "华为技术有限公司","phone": "+86191****9092"}"groupId": "297e87ec7713734b01771458c2d80000"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911

响应消息示例 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: 539e8b710378987ffc5eb844b5e5c290 { "adminInfo": { "account": "zhangsan@corp", "adminType": 0, "country": "chinaPR", "email": "******", "id": "58eed901985149899b966242e0a7d644", "name": "zhangsan", "phone": "+86191****9092" }, "basicInfo": { "address": "浙江杭州", "country": "chinaPR", "description": "description", "email": "******", "fax": "+123456789", "name": "华为技术有限公司", "phone": "+86191****9092", "spId": "8a8d1384700be6870170117caca923af" }, "resInfo": { "corpVcRes": { "confCallCount": 100, "hwVisionCount": 0, "ideaHubCount": 0, "liveCount": 0, "recordCapability": 0, "roomCount": 0, "te1080pHardCount": 100, "te720pHardCount": 100, "teSoftCount": 100, "thirdPartyHardCount": 100, "vmrPkgList": [ { "vmrName": "大型云会议室-50方", "vmrPkgCount": 10, "vmrPkgId": "ff808081699b56cb0169c411a0980152", "vmrPkgParties": 50, "vmrPkgUsedCount": 0 } ] } } }

请求消息示例 GET /v1/usg/dcs/sp/corp/818803911 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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。

响应参数 表4 响应参数 参数 类型 描述 adminInfo QueryAdminResultDTO object 管理员信息。 basicInfo QueryCorpBasicResultDTO object 企业基本信息。 groupDTO OrgGroupDTO object 媒体接入(包括SBC和MCU)分组信息。 id String 企业id。 resInfo QueryCorpResResultDTO object 查询企业资源的返回结果。 表5 QueryAdminResultDTO 数据结构 参数 类型 描述 account String 用户华为云会议账号。 adminType Integer 管理员类型。 0：默认管理员 1：普通管理员 country String 联系电话所在的国家。 email String 邮箱。 id String 用户UUID。 name String 名称。 phone String 联系电话。 表6 QueryCorpBasicResultDTO数据结构 参数 类型 描述 address String 地址。 country String 联系号码所属的国家。 description String 备注。 email String 邮箱地址。 fax String 传真号码。 name String 企业名称。 phone String 联系号码。 spId String 企业所属SP ID。 表7 OrgGroupDTO 数据结构 参数 类型 描述 groupId String 分组Id。 groupName String 分组名称。 表8 QueryCorpResResultDTO 数据结构 参数 类型 描述 corpVcRes QueryCorpVcResResultDTO object 企业资源信息。 表9 QueryCorpVcResResultDTO数据结构 参数 类型 描述 confCallCount Integer 会议并发方数量。 hwVisionCount Integer 智慧屏终端接入账号数量。 ideaHubCount Integer IdeaHub终端接入账号数量。 liveCount Integer 直播端口数量。 recordCapability Integer 录播存储空间 (单位:G)。 roomCount Integer 电子白板（SmartRooms）接入账号数量。 te1080pHardCount Integer 1080P硬终端接入账号数量。 te720pHardCount Integer 720P硬终端接入账号数量。 teSoftCount Integer 软终端账户数量。 thirdPartyHardCount Integer 第三方硬终端接入账号数量。 vmrPkgList Array of QueryVmrPkgResResultDTO objects 云会议室类型列表。 表10 QueryVmrPkgResResultDTO 数据结构 参数 类型 描述 vmrName String 云会议室套餐包名称。 vmrPkgCount Integer 该云会议室套餐分配的总数。 vmrPkgId String 云会议室套餐包id。 vmrPkgParties Integer 云会议室套餐方数。 vmrPkgUsedCount Integer 该套餐对应的云会议室已分配数量。

请求消息示例 DELETE https://{endpoint}/v1/usg/dcs/sp/corp/818803911 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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。

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 21 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 43689056504b4ff22663262d44e141aa { "value": "818803911" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' -d '{"account": "zhangsan@corp","country": "chinaPR","email": "******","name": "zhangsan","phone": "+86191****9092","pwd": "******","sendNotify": false},"basicInfo": {"address": "浙江杭州","country": "chinaPR","description": "description","domain": "huawei.com","email": "******","fax": "+123456789","language": "zh-CN","name": "华为技术有限公司","phone": "+86191****9092","spId": "","timeZoneId": "56"},"groupId": "297e87ec7713734b01771458c2d80000","resInfo": {"resource": [{"count": 10,"expireDate": 2549030400000,"id": "36f2c0117cf14c3db61a7880eb73cee6","type": "VMR","typeId": "2c90bb2871e577590171e57bfec908b2"}]}}' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp

请求消息示例 POST /v1/usg/dcs/sp/corp Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 561 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "adminInfo": { "account": "zhangsan@corp", "country": "chinaPR", "email": "******", "name": "zhangsan", "phone": "+86191****9092", "pwd": "******" }, "basicInfo": { "address": "浙江杭州", "country": "chinaPR", "description": "description", "domain": "huawei.com", "email": "******", "fax": "+123456789", "language": "zh-CN", "name": "华为技术有限公司", "phone": "+86191****9092", "spId": "", "timeZoneId": "56" }, "groupId": "297e87ec7713734b01771458c2d80000", "resInfo": { "resource": [ { "count": 10, "expireDate": 2549030400000, "id": "36f2c0117cf14c3db61a7880eb73cee6", "type": "VMR", "typeId": "2c90bb2871e577590171e57bfec908b2" } ] } }

业务流程 图1 企业注册信息、资源和业务权限管理流程图 第三方通过企业管理员账号、密码登录， 获取Token 。 第三方向网关APIG发送账号鉴权请求。 网关接收请求后，向CloudPortal发送账号鉴权请求。 CloudPortal鉴权通过后返回Token。 网关APIG将Token信息返回给第三方。 为了查询企业注册信息，第三方向网关APIG发送查询企业注册信息请求。 网关接收请求后，向CloudPortal发送获取企业注册信息请求。 CloudPortal返回企业注册信息给网关APIG。 网关APIG将企业注册信息返回给第三方。 为了查询企业内资源及业务权限，第三方向网关APIG发送查询企业内资源及业务权限请求。 网关接收请求后，向CloudPortal发送获取企业内资源及业务权限请求。 CloudPortal返回企业内资源及业务权限信息给网关APIG。 网关APIG将企业内资源及业务权限信息返回给第三方。 为了修改企业注册信息，填入新企业地址等请求参数，第三方携带该参数向网关APIG发送修改企业注册信息请求。 网关接收请求后，向CloudPortal发送获取企业注册信息请求。 CloudPortal收到请求后，修改企业注册信息。 上图的步骤6-16为企业注册信息、资源和业务权限管理接口，且接口调用无顺序要求，根据第三方自身需求进行调用。

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

请求消息示例 PUT /v1/mmc/control/conferences/inviteWithPwd?conferenceID=914083136 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) { "callNum":"+99111253020382685", "orgID":"115489", "pwd":"******", "numBelongsType":0, "isNotOverlayPidName":false, "confID":"914083136" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -d '{"callNum":"+8688665599", "orgID":"115489", "pwd":"******", "numBelongsType":0, "isNotOverlayPidName":false}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/ inviteWithPwd?conferenceID=914083136

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 callNum 是 String Body 被邀请者的SIP号码。 orgID 否 String Body 被邀请者所属企业ID。 confID 是 String Body 当前会议ID。 pwd 是 string body 会议的密码（主持人或者来宾）。 numBelongsType 否 Integer Body SIP号码类型。默认是0。 0：华为云会议的号码 1：VC会议的号码 isNotOverlayPidName 否 Boolean Body 是否不叠加会场名（VDC场景下适用）。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"manualSet": 0}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789'

请求消息示例 PUT /v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789 Connection: keep-alive X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb Content-Type: application/json Content-Length: 27 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "manualSet": 1, "subscriberInPics":[{ "index": 2, "subscriber": ["+99111252010982686"] }], "imageType":"Six", "multiPicSaveOnly": false }

响应消息示例 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: 6346df97898dcd1e9cb205b75f24fe65 Server: api-gateway X-Request-Id: 0294dd7aedd58db92a23de453cbcde0e

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 conferenceID 是 String Query 会议ID。 X-Conference-Authorization 是 String Header 会控Token，通过获取会控token接口获得。 manualSet 是 Integer Body 是否为手工设置多画面。 0： 系统自动多画面 1： 手工设置多画面 picLayoutInfo 否 PicLayoutInfo object Body 会议自定义多画面布局信息。 说明： 预留参数，当前版本不可用。 imageType 否 String Body 画面类型。手工设置多画面时有效。imageType取值和画面布局的对应关系详见图1。 subscriberInPics 否 Array of SubscriberInPic objects Body 子画面列表（手工设置多画面时必填）。 switchTime 否 Integer Body 表示轮询间隔,取值范围：10-120，默认10。单位：秒。 当同一个子画面中包含有多个与会者时，此参数有效。 说明： 仅针对专业会议终端生效，对软终端不生效。 multiPicSaveOnly 否 Boolean Body 多画面是否仅保存。 true： 仅保存 false： 保存并应用 说明： ”仅保存“效果：仅保存当前画面布局，不进行广播等操作。 ”保存并应用“效果： 1、当会议状态为广播多画面、声控单画面、声控多画面、主持人观看多画面时，保存并应用后，改变画面布局，不改变状态。 2、当会议状态为非广播多画面、声控单画面、声控多画面、主持人观看多画面时，如自动多画面、广播与会者、点名与会者时，保存并应用后，变为广播多画面。 当处于广播多画面、声控多画面、声控单画面状态下，无法设置主持人观看多画面。 图1 imageType（画面类型）参考 imageType取布局图下方的字符串。举例说明：如果需要设置多画面样式为均分四画面，则imageType设置为“Four”。 表3 PicLayoutInfo数据结构 参数 是否必须 类型 描述 x 否 Integer 多画面布局的宽度。 y 否 Integer 多画面布局的高度。 subPicLayoutInfoList 否 Array of SubPicLayoutInfo objects 子画面布局具体列表。 表4 SubPicLayoutInfo数据结构 参数 是否必须 类型 描述 id 否 Integer 画面索引号。 left 否 Integer 画面从左到右的坐标点。 top 否 Integer 画面从上到下的坐标点。 xSize 否 Integer 小画面的宽度。 ySize 否 Integer 小画面的高度。 表5 SubscriberInPic 数据结构 参数 是否必须 类型 描述 index 否 Integer 多画面中每个画面的编号。编号从1开始。 默认值为“1”。 subscriber 否 Array of strings 每个画面中与会者号码，从查询会议实时信息接口返回participants中的phone中获取。 isAssistStream 否 Integer 是否为辅流。默认值为0。 0： 不是辅流 1： 是辅流

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 126 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 2d5d7b5342900131401c88617b8d4c45 Server: api-gateway X-Request-Id: 249ed38c7e8a19017f7a566644483b0e111 { "usedAccountsCount": 5 }

请求消息示例 GET /v1/mmc/management/conferences/confOrg?conferenceID=900536108 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)

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 126 Connection: keep-alive Expires: 0 Pragma: No-cache Cache-Control: no-cache http_proxy_id: 2d5d7b5342900131401c88617b8d4c45 Server: api-gateway X-Request-Id: 249ed38c7e8a19017f7a566644483b0e111 { "orgID": "44252" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header token鉴权。 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。

请求消息示例 POST /v1/usg/acs/auth/portal-ref-nonce Connection: keep-alive X-Access-Token: cnrJmYwhPxsnNLky5APQm1hqWfXCDUN3d1lH Content-Type: application/json 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: 745 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block X-Download-Options: noopen X-Content-Type-Options: nosniff strict-transport-security: max-age=16070400; includeSubDomains X-Frame-Options: SAMEORIGIN Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' blob: data: http: https: ; child-src * ; connect-src * x-request-id: 6162fa32dc7e47afafeee39a72a2eec8 Server: CloudPortal { "nonce": "1605496941659KzhX8aNBqyaY7e2esSDMnv3N9DWqpt7yo" }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 Authorization 是 String Header 携带应用鉴权信息。 规则：HMAC-SHA256 signature=HexEncode(HMAC256((appId + ":" + userId + ":" + expireTime + ":" + nonce), appKey)),access=base64(appId) 样例：HMAC-SHA256 signature=07f31aa9eafb06652c6899248b145c1a3264242e2ccf4c81b1b6eb99bb5c,access=ZmRiOGU0Njk5NTg2NDU4YmJkMTBjODM0ODcyZGNjNjI= 说明： 如携带了userId信息，则Body中，也需填写对应的userId信息。 （必填）鉴权头域携带access内容为对应颁发应用id进行base64编码。 X-Token-Type 是 String Header Token类型设置为：LongTicket Content-Type 是 String Header Body的媒体格式。 样例：application/json; charset=UTF-8 X-Request-ID 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 appId 是 String Body App ID。如何获取App ID请参考“App ID的申请”。 clientType 是 Integer Body 登录账号类型。 72：API调用类型 corpId 否 String Body 企业ID。 说明： 当SP应用场景携带，如果corpId和userId字段未携带或值为空字符串时，当作SP默认管理员登录。 仅在SP模式下需要填写，单企业模式不要填写，否则会鉴权失败。 expireTime 是 Long Body 应用鉴权信息过期时间戳，单位秒。 说明： 当收到App ID鉴权请求时服务端的Unix时间戳大于expireTime时，本次鉴权失败。 样例：如果要求App ID鉴权信息10分钟后过期，expireTime = 当前Unix时间戳 + 60*10。 如果要求应用鉴权信息始终不过期，expireTime = 0。 nonce 是 String Body 随机字符串，用于计算应用鉴权信息。 minLength：32 maxLength：64 userEmail 否 String Body email地址。 userId 否 String Body 第三方用户ID。 说明： 当userId字段未携带或值为空字符串时，当作企业默认管理员登录。 userName 否 String Body 用户名称。 userPhone 否 String Body 手机号，例如中国大陆手机+86xxxxxxx deptCode 否 String Body 部门编码。通过“查询部门及其一级子部门列表”接口获取。