华为云用户手册

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

请求参数 表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 云会议室列表。

响应参数 表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 云会议室列表。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"country": "chinaPR","deptCode": "1","desc": "modDesc","email": "******","englishName": "modEnglishName","hidePhone": true,"name": "modName","phone": "+86173****9807","signature": "modSignature","sortLevel": 1,"status": 1,"title": "modTitle","vmrId": ""}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0

请求消息示例 PUT /v1/usg/dcs/corp/member/3e48b79b660e403cb5e0208f7be83961?accountType=0 Connection: keep-alive Content-Type: application/json X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Length: 173 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "country": "chinaPR", "deptCode": "1", "desc": "modDesc", "email": "******", "englishName": "modEnglishName", "hidePhone": true, "name": "modName", "phone": "+86173****9807", "signature": "modSignature", "sortLevel": 1, "status": 1, "title": "modTitle", "vmrId": "" }

响应消息示例 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: 26701eb8f982b175b70776316d46e33e { "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 } ] }

请求参数 表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。 country 否 String Body 手机号所属的国家。 默认值：chinaPR。 maxLength：255 minLength：0 deptCode 否 String Body 部门编码，若不携带则默认根部门。 默认值：1 desc 否 String Body 备注。 maxLength：128 minLength：0 email 否 String Body 邮箱。 englishName 否 String Body 企业用户的英文名称。 maxLength：64 minLength：0 hidePhone 否 Boolean Body 是否隐藏手机号码。 默认值：false name 否 String Body 企业用户名称。 maxLength：64 minLength：1 phone 否 String Body 手机号，必须加上国家码。 例如中国大陆手机为“+86xxxxxxxxxxx”。当填写手机号时 “country”参数必填。 手机号只允许输入纯数字。 说明：手机号或者邮箱至少填写一个。 signature 否 String Body 签名。 maxLength：512 minLength：0 sortLevel 否 Integer Body 通讯录排序等级，序号越低优先级越高。 默认值：10000 maximum：10000 minimum：1 status 否 Integer Body 用户状态。 0：正常 1：停用 默认值：0 title 否 String Body 职位。 maxLength：32 minLength：0 vmrId 否 String Body 个人会议ID，若不携带则后台默认生成。

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9' -d '{"account": "test963","country": "chinaPR","deptCode": "1","email": "******","name": "test963","phone": "+86136********","pwd": "******"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/member

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

请求消息示例 POST /v1/usg/dcs/corp/member Connection: keep-alive Content-Type: application/json X-Access-Token: stb7PzruAmA6d3JJD578jlAHczGfN4SIaup9 Content-Length: 173 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "englishName": "englishName", "country": "chinaPR", "signature": "signature-info", "hidePhone": false, "sendNotify": "0", "title": "manager", "sortLevel": 100000, "phone": "+86173****9807", "function": { "enableRoom": true }, "name": "name", "pwd": "******", "account": "3e48b79b660e403cb5e0208f7be83961", "email": "******", "deptCode": "1", "desc": "desc", "status": "status" }

响应参数 表5 响应参数 参数 类型 描述 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 用户UUID。 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：普通用户 12：智慧屏用户 13：IdeaHub用户 14：SmartRooms用户 visionAccount String 智慧屏唯一账号 vmrList Array of UserVmrDTO objects 云会议室列表。 表6 QueryDeviceInfoResultDTO 数据结构 参数 类型 描述 deviceSize String 设备终端产品尺寸。 model String 终端型号。 purchaseChannel String 终端设备购买渠道。

响应消息示例 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 [ { "deptCode": "1", "deptLevel": 1, "deptName": "wangyue", "deptNamePath": "wangyue", "isLeafNode": false, "parentDeptCode": null, "deptCodePath": "1", "note": null, "corpId": "15659", "inPermission": "UNLIMITED", "outPermission": "UNLIMITED", "sortLevel": 10000, "designatedOutDeptCodes": [] } ]

请求消息示例 GET /v1/usg/dcs/member/dept?deptName=wangyue Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

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

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of QueryDeptResultDTO 部门列表 表5 QueryDeptResultDTO数据结构 参数 类型 描述 corpId String 企业ID。 deptCode String 部门编码，企业内唯一。 deptCodePath String 部门编码路径。 deptLevel Integer 部门层级。 deptName String 部门名称。 deptNamePath String 部门名路径。 designatedOutDeptCodes Array of IdMarkDTO objects 允许访问的部门列表。 inPermission String 其他用户对该部门下用户的访问权限。 isLeafNode Boolean 是否叶子节点。 note String 备注。 outPermission String 该部门下用户访问权限控制。 parentDeptCode String 父部门编码。 sortLevel Integer 部门排序号。

响应消息示例 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 { "corpId": "15659", "deptCode": "1", "deptLevel": 1, "deptName": "wangyue", "deptNamePath": "wangyue", "isLeafNode": false, "parentDeptCode": null, "deptCodePath": "1", "note": null, "inPermission": "UNLIMITED", "outPermission": "UNLIMITED", "designatedOutDeptCodes": [], "sortLevel": 1000, "childDepts": [ { "deptCode": "U5b", "deptLevel": 2, "deptName": "openTest001", "deptNamePath": "wangyue#openTest001", "isLeafNode": true, "parentDeptCode": "1", "deptCodePath": "1#U5b", "note": null, "corpId": "15659", "inPermission": "UNLIMITED", "outPermission": "UNLIMITED", "sortLevel": 10000, "designatedOutDeptCodes": [] } ] }

请求消息示例 GET /v1/usg/dcs/member/dept/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)

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

响应参数 表4 响应参数 参数 类型 描述 childDepts Array of QueryDeptResultDTO objects 子部门列表。 corpId String 企业ID。 deptCode String 部门编码。 deptCodePath String 部门编码路径。 deptLevel Integer 部门层级。 deptName String 部门名称。 deptNamePath String 部门名路径。 designatedOutDeptCodes Array of IdMarkDTO objects 允许访问的部门列表。 inPermission String 其他用户对该部门下用户的访问权限。 isLeafNode Boolean 是否叶子节点。 note String 备注。 outPermission String 该部门下用户访问权限控制。 parentDeptCode String 父部门编码。 sortLevel Integer 部门排序号。 表5 QueryDeptResultDTO 数据结构 参数 类型 描述 corpId String 企业ID。 deptCode String 部门编码，企业内唯一。 deptCodePath String 部门编码路径。 deptLevel Integer 部门层级。 deptName String 部门名称。 deptNamePath String 部门名路径。 designatedOutDeptCodes Array of IdMarkDTO objects 允许访问的部门列表。 inPermission String 其他用户对该部门下用户的访问权限。 isLeafNode Boolean 是否叶子节点。 note String 备注。 outPermission String 该部门下用户访问权限控制。 parentDeptCode String 父部门编码。 sortLevel Integer 部门排序号。 表6 IdMarkDTO 数据结构 参数 类型 描述 id String 部门编码。 mark String id对应的回显描述，一般为名称等。

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

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

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 deptCode 是 String Path 部门编码。 长度： 0-32位。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 deptName 否 String Body 部门名称。 maxLength：128 minLength：1 designatedOutDeptCodes 否 Array of strings Body 允许访问的部门列表，仅outPermission为DESIGNATED_DEPARTMENT时有效，最多支持配置150 inPermission 否 String Body 其他用户对该部门下用户的访问权限： UNLIMITED：默认，不做限制 OPEN：公开，其他部门都可访问（无论对方权限如何配置） note 否 String Body 备注。 maxLength：96 minLength：0 outPermission 否 String Body 该部门下用户访问权限控制 UNLIMITED：不限制 ONLY_SELF：仅能查询自己 SELF_AND_CHILD_DEPARTMENT：该部门下用户能查询本部门及子部门通讯 DESIGNATED_DEPARTMENT：该部门下用户能查询指定部门通讯录 parentDeptCode 否 String Body 父部门编码 maxLength：32 sortLevel 否 Integer Body 部门排序号，序号越小，部门排序越靠前。 minimum: 1 maximum: 10000

请求消息示例 PUT /v1/usg/dcs/corp/dept/s4f Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Content-Type: application/json Content-Length: 53 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "deptName": "111111", "note": "string" }

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

CURL命令示例 curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '{"deptName": "111111","note": "string"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/dept/s4f

请求消息示例 POST /v1/usg/dcs/corp/dept Connection: keep-alive X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki Content-Type: application/json Content-Length: 31 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "deptName": "test999" }

响应消息示例 HTTP/1.1 200 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 Server: api-gateway X-Request-Id: 539e8b710378987ffc5eb844b5e5c290 { "value": "s4f" }

CURL命令示例 curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token: stbvmKo5lr6vT7QIzKHg4iqicUBcYMb3qlki' -d '{"deptName": "test999"}' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/dept

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Request-Id 否 String Header 请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 Accept-Language 否 String Header 语言参数，默认为中文zh-CN，英文为en-US。 deptCode 否 String Body 部门编码，企业内唯一，若携带则以携带为准，不支持修改。 maxLength：32 deptName 是 String Body 部门名称。 maxLength：128 minLength：1 parentDeptCode 否 String Body 父部门编码，默认为根部门。 默认值：1 maxLength：32 note 否 String Body 备注。 maxLength：96 minLength：0 inPermission 否 String Body 其他用户对该部门下用户的访问权限。 UNLIMITED：默认，不做限制 OPEN：公开，其他部门都可访问（无论对方权限如何配置） outPermission 否 String Body 该部门下用户访问权限控制。 UNLIMITED：不限制 ONLY_SELF：仅能查询自己 SELF_AND_CHILD_DEPARTMENT：该部门下用户能查询本部门及子部门通讯录 DESIGNATED_DEPARTMENT：该部门下用户能查询指定部门通讯录 designatedOutDeptCodes 否 Array of strings Body 允许访问的部门列表，仅outPermission为DESIGNATED_DEPARTMENT时有效，最多支持配置150个部门。 sortLevel 否 Integer Body 部门排序号，序号越小，部门排序越靠前。 minimum: 1 maximum: 10000