更新时间:2023-12-29 GMT+08:00

添加部门

描述

企业管理员通过该接口添加部门,最多支持10级部门,每级子部门最多支持100个,默认企业最大部门数量为10000个。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

POST

请求地址

/v1/usg/dcs/corp/dept

传输协议

HTTPS

请求参数

表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

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

value

String

部门编码。

请求消息示例

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"
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

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