建立部门与单位的绑定关系
调用该接口建立部门与单位的绑定关系。一个部门同时只能绑定一个单位。
注意事项
操作的部门需要在应用的通讯录权限范围内。了解通讯录权限范围,可参见权限范围资源介绍。
使用限制
- 单个单位可关联的部门数量上限为 1,000。
- 同一个部门只能关联一个单位。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/contact/v3/unit/bind_department |
| HTTP Method | POST |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | contact:unit 更新单位信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
unit_id | string | 是 | 单位 ID。 当你在创建单位时,可以在返回结果中获取单位 ID。你也可以调用获取单位列表接口,获取单位 ID。 示例值:"BU121" |
department_id | string | 是 | 单位关联的部门 ID,ID 类型与 department_id_type 的取值保持一致。 部门 API 提供了多种获取部门 ID 的方式,如获取子部门列表、获取父部门信息、搜索部门,你可以选择合适的 API 进行查询。 示例值:"od-4e6ac4d14bcd5071a37a39de902c7141" |
department_id_type | string | 否 | 此次调用中的部门 ID 类型。关于部门 ID 的详细介绍,可参见部门 ID 说明。 示例值:"open_department_id" 可选值有: - department_id: 支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id,因此在未删除的部门范围内 department_id 具有唯一性。 - open_department_id: 由系统自动生成的部门 ID,ID 前缀固定为 od-,在租户内全局唯一。默认值: open_department_id |
请求体示例
json
{
"unit_id": "BU121",
"department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
"department_id_type": "open_department_id"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 40003 | internal error | 内部错误,请获取请求的 X-Request-Id,并向技术支持进行反馈。 |
| 400 | 43050 | unit feature is prohibited | 单位是旗舰版功能,需企业开通相应版本。了解更多,可参见单位管理。 |
| 400 | 43051 | unit_id invalid | 非法的单位 ID。调用获取单位列表接口,获取正确的单位 ID 后重试。 |
| 400 | 43058 | department_id invalid | 非法的部门 ID。请参考接口文档的参数描述,设置正确的部门 ID 类型以及部门 ID。 |
| 400 | 43054 | department has been bound to other unit | 部门已经绑定其它单位。目前,部门只能同时绑定一个单位。 |
| 403 | 40004 | no dept authority error | 无部门操作权限。操作的部门需要在应用的通讯录权限范围内。了解通讯录权限范围,可参见权限范围资源介绍。 |
更多错误码信息,参见通用错误码。
