华为云用户手册

请求参数 表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 验证码，在校验的场景时需要携带。

请求消息示例 POST /v1/usg/dcs/member/verification-code/verify 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": "753927" }

请求消息示例 POST /v1/usg/dcs/member/verification-code Connection: keep-alive X-Access-Token: stbmRCbnRpo5IVy9SiOMVVogwnm5iIccjYho Content-Type: application/json Content-Length: 35 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "contact": "+86136********", "country": "chinaPR" }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbmRCbnRpo5IVy9SiOMVVogwnm5iIccjYho' -d '{"contact": "+86136********","country": "chinaPR",}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member/verification-code

请求参数 表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 验证码，在校验的场景时需要携带。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y' -d '{"name": "user8001"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/member

请求消息示例 PUT /v1/usg/dcs/member Connection: keep-alive X-Access-Token: stbLRonxHFt7jfbMHSY2UufNZewbPwb8TP8y Content-Type: application/json Content-Length: 25 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "name": "user8001" }

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 desc 否 String Body 备注。 maxLength：128 minLength：0 englishName 否 String Body 英文名称。 maxLength：64 minLength：0 name 是 String Body 名称。 maxLength：64 minLength：1 signature 否 String Body 签名。 maxLength：512 minLength：0 title 否 String Body 职位。 maxLength：32 minLength：0

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 812 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache http_proxy_id: c94f64967745b0670c299c0688479078 Server: api-gateway X-Request-Id: de796b739528b6a1f72c283a107bdb02 { "id": "ff808081699b56cb0169b81a06ee00d9", "userAccount": "user8001@corpnew", "name": "test008", "englishName": null, "phone": null, "country": null, "email": "******", "sipNum": "+991116003840", "vmrList": [ { "id": "ff808081699b56cb0169b81a06f400db", "vmrId": "913371462", "vmrName": "user8001的云会议室", "vmrMode": 0, "vmrPkgId": null, "vmrPkgName": null, "vmrPkgParties": null, "vmrPkgLength": null, "status": 0 }, { "id": "ff808081699b56cb0169b92b45ab0111", "vmrId": "919728047", "vmrName": "云会议室:919728047", "vmrMode": 1, "vmrPkgId": "ff808081680d5b8601682b3436070030", "vmrPkgName": "运营VMR专用_25", "vmrPkgParties": 25, "vmrPkgLength": 0, "status": 0 } ], "deptCode": "1", "deptName": "wangyue", "deptNamePath": "wangyue", "userType": 2, "adminType": 2, "signature": null, "title": null, "desc": null, "corp": { "id": "15659", "name": "华为技术有限公司", "address": "hangzhou", "adminName": "wlj", "account": "d74cf0a5c7804860a131ec6067a10fc6", "phone": "+86********", "country": "chinaPR", "email": "********@huawei.com", "enable SMS ": true, "enablePstn": false, "autoUserCreate": true }, "function": { "enableRoom": false }, "status": 0, "sortLevel": 10000, "hidePhone": false }

响应参数 表4 响应参数 参数 类型 描述 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） corp CorpBasicInfoDTO object 企业注册信息。仅用户查询自己的信息才返回该数据。 country String 联系电话所属的国家。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门完整名称。 desc String 备注。 devType QueryDeviceInfoResultDTO object 绑定设备类型信息。 email String 邮箱。 englishName String 英文名称。 function UserFunctionDTO object 用户功能位。 hidePhone Boolean 是否隐藏手机号码。 id String 用户id。 license Integer 许可证。 0：商用； 1：免费试用。 name String 名称。 phone String 联系电话。 signature String 签名。 sipNum String SIP号码。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 status Integer 用户状态。 0：正常； 1：停用。 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议用户账号。 userType Integer 用户类型。 2：企业成员账户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。 表5 UserVmrDTO数据结构 参数 类型 描述 id String 云会议室的ID。 说明： 对应创建会议接口中的vmrID。 vmrId String 云会议室的固定会议ID。 说明： 对应创建会议接口返回数据的vmrConferenceID。 vmrName String 云会议室名称。 vmrMode Integer VMR模式。 0：个人会议ID 1：云会议室 2：网络研讨会 vmrPkgId String 云会议室套餐包的id，仅云会议室返回。 vmrPkgLength Integer 云会议室套餐包的与会时间，若为0则代表无限时长，仅云会议室返回。 vmrPkgName String 云会议室套餐包的名称，仅云会议室返回。 vmrPkgParties Integer 云会议室套餐包的会议并发方数，仅云会议室返回。 status Integer 云会议室状态。 0：正常 1：停用 2：未分配 表6 CorpBasicInfoDTO 数据结构 参数 类型 描述 account String 管理员账号。 address String 企业所在地。 adminName String 管理员名称。 autoUserCreate Boolean 是否支持自动开户。 country String 管理员手机所属的国家。 email String 管理员邮箱。 enablePstn Boolean 是否具有pstn功能。 enableSMS Boolean 是否通过短信形式发送会议通知。 id String 企业id。 name String 企业名称。 phone String 管理员手机。 enableCloudDisk Boolean 是否开启云盘 corpType Integer 企业类型

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 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/corp/member/status/0?accountType=0 Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 11 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["test010"]

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '["test010"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/status/0?accountType=0

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 value 是 Integer Path 用户的新状态。 0：正常 1：停用 accountType 否 Integer Query 账号类型。默认0。 0：华为云会议账号。用于账号/密码鉴权方式 1：第三方User ID，用于App ID鉴权方式 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 企业用户账号列表。

请求消息示例 GET /v1/usg/dcs/corp/member Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 125 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: 1329 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 63facce44898efa03629afd189da7f0f { "count": 1, "data": [ { "activeCode": null, "activeCodeExpireTime": null, "activeTime": 1601221696783, "adminType": 2, "country": "chinaPR", "deptCode": "1", "deptNamePath": "根部门", "desc": "desc", "email": "******", "englishName": "englishName", "expireTime": null, "hidePhone": false, "id": "a7f78791553d4ec6b3a4b721f0946286", "license": 0, "name": "name", "phone": "+86123456789", "signature": "signature", "sortLevel": 10000, "status": 0, "thirdAccount": "thirdAccount", "title": "manager", "userAccount": "4036ca5e54d144d9b9e3ed25b9368d3a", "userType": 2, "visionAccount": null, "vmrId": "911150978" } ], "limit": 10, "offset": 0 }

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 offset 否 Integer Query 查询偏移量, 若超过最大数量，则返回最后一页。 limit 否 Integer Query 查询数量。 默认值：10 searchKey 否 String Query 搜索条件，支持名称、手机、邮箱、账号、第三方User ID模糊搜索。 sortField 否 String Query 排序字段名称。 支持的取值： userType adminType ldapAccount deptCode status sortLevel isAsc 否 Boolean Query 是否按升序排序。 deptCode 否 String Query 部门编码，不带则查询所有。 enableSubDept 否 Boolean Query 是否查询子部门。 默认值: true adminType 否 Integer Query 根据管理员类型查询。 1：普通管理员 2：非管理员 enableRoom 否 Boolean Query 查询SmartRooms用户。 说明： 该参数将废弃，请勿使用。 userType 否 Array of integers Query 用户类型，若不携带，则默认查询普通用户。 2：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 status 否 Integer Query 用户状态。不带则查询所有。 0：正常 1：停用 containsUnActive 否 Boolean Query 是否查询未激活的终端。 默认值：false 说明： 该参数将废弃，请勿使用。 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 SearchUserResultDTO objects 分页查询企业用户信息。 表5 SearchUserResultDTO 数据结构 参数 类型 描述 activeCode String 激活码。 activeCodeExpireTime Long 激活码到期时间，utc时间戳。 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） country String 手机所属国家。 deptCode String 部门编码。 deptNamePath String 部门完整名称。 desc String 备注。 email String 邮箱。 englishName String 英文名称。 expireTime Long 已激活的终端到期时间，utc时间戳。 hidePhone Boolean 是否隐藏手机号码。 id String 用户UUID。 license Integer 许可证。 0：商用 1：免费试用 name String 名称。 phone String 联系电话。 signature String 签名。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 maximum：10000 minimum：1 status Integer 用户状态。 0：正常 1：停用 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议账号。 userType Integer 用户类型。 2：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 visionAccount String 智慧屏账号。 vmrId String 个人会议ID。

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 accountType 否 Integer Query 账号类型。 0：华为云会议账号。用于账号/密码鉴权方式。 1：第三方User ID，用于App ID鉴权方式。 默认0 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 企业用户账号列表。

请求消息示例 POST /v1/usg/dcs/corp/member/delete?accountType=0 Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Type: application/json Content-Length: 11 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) ["test963"]

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '["test963"]' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/delete?accountType=0

响应消息示例 HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 646 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 551aeb8cafbbaa7bbbdc7b1c76bba8ac { "activeTime": 1601221696783, "adminType": 2, "corp": null, "country": "chinaPR", "deptCode": "1", "deptName": "根部门", "deptNamePath": "根部门", "desc": "modDesc", "devType": { "deviceSize": null, "model": null, "purchaseChannel": null }, "email": "******", "englishName": "modEnglishName", "function": { "enableRoom": true }, "hidePhone": true, "id": "f521bebcbb27422cb3241c4cb19942c5", "license": 0, "name": "modName", "phone": "+86173****9807", "signature": "modSignature", "sipNum": "+8657198480", "sortLevel": 1, "status": 1, "thirdAccount": "thirdAccount", "title": "modTitle", "userAccount": "3e48b79b660e403cb5e0208f7be83961", "userType": 2, "visionAccount": null, "vmrList": [ { "id": "2c908bc76f61a5f2016f61bbfdf5039b", "status": "0", "vmrId": "912992631", "vmrName": "name的云会议室", "vmrPkgId": null, "vmrPkgLength": null, "vmrPkgName": null, "vmrPkgParties": null } ] }

请求消息示例 GET /v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0 Connection: keep-alive X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

响应参数 表4 响应参数 参数 类型 描述 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） corp CorpBasicInfoDTO object 企业注册信息。仅用户查询自己的信息才返回该数据。 country String 联系电话所属的国家。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门完整名称。 desc String 备注。 devType QueryDeviceInfoResultDTO object 绑定设备类型信息。 email String 邮箱。 englishName String 英文名称。 function UserFunctionDTO object 用户功能位。 hidePhone Boolean 是否隐藏手机号码。 id String 用户id。 license Integer 许可证。 0：商用； 1：免费试用。 name String 名称。 phone String 联系电话。 signature String 签名。 sipNum String SIP号码。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 status Integer 用户状态。 0：正常； 1：停用。 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议用户账号。 userType Integer 用户类型。 2：企业成员账户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 account 是 String Path 账号。 如果是账号/密码鉴权方式，是指华为云会议账号 如果是App ID鉴权方式，是指第三方User ID accountType 否 Integer Query 账号类型。默认0。 0：华为云会议账号。用于账号/密码鉴权方式 1：第三方User ID，用于App 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 响应参数 参数 类型 描述 activeTime Long 激活时间，utc时间戳。 adminType Integer 管理员类型。 0：默认（超级）管理员 1：普通管理员 2：非管理员（即为普通企业成员，UserType是2时有效） corp CorpBasicInfoDTO object 企业注册信息。仅用户查询自己的信息才返回该数据。 country String 联系电话所属的国家。 deptCode String 部门编码。 deptName String 部门名称。 deptNamePath String 部门完整名称。 desc String 备注。 devType QueryDeviceInfoResultDTO object 绑定设备类型信息。 email String 邮箱。 englishName String 英文名称。 function UserFunctionDTO object 用户功能位。 hidePhone Boolean 是否隐藏手机号码。 id String 用户id。 license Integer 许可证。 0：商用； 1：免费试用。 name String 名称。 phone String 联系电话。 signature String 签名。 sipNum String SIP号码。 sortLevel Integer 通讯录排序等级，序号越低优先级越高。 status Integer 用户状态。 0：正常； 1：停用。 thirdAccount String 第三方User ID。 title String 职位。 userAccount String 华为云会议用户账号。 userType Integer 用户类型。 2：企业成员账户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。