获取集成模式部门编号接口 - 简道云

获取集成模式部门编号接口调试

1. 简介

1.1 接口简介

本接口可以通过第三方平台的通讯录部门的 ID 获取其对应的简道云通讯录部门编号。仅支持集成模式。

1.2 接口版本

接口版本	更新时间	版本说明
v1	2018.12.4	使用 _id 作为 id
v2	2019.6.21	使用 dept_no 作为 id
v4	2022.6.30	返回值新增字段 type、status、integrate_id
v5	2022.10.28	在 v4 的基础上，接口请求频率由 5 次每秒提升至 30 次每秒；接口路由修改为 POST corp/department/dept_no/get
v6	2022.08.01	部门实体结构中，新增响应参数 seq，支持对部门进行排序。

2. 接口调用

在集成模式下，企业通讯录的部门是同步自第三方平台通讯录的，因此简道云通讯录的部门与第三方平台的通讯录部门之间存在着一一对应的关系。

本接口可以通过第三方平台的通讯录部门的 ID 获取其对应的简道云通讯录部门编号。仅支持集成模式。

请求地址：https://api.jiandaoyun.com/api/v6/corp/department/dept_no/get

请求频率：30 次/秒

请求方式：POST

请求参数：

参数	是否必需	类型	说明
integrate_id	是	String	第三方平台通讯录的部门 ID，如钉钉/企业微信/飞书的通讯录部门 ID。

请求示例：

{
     "integrate_id": "1005"
}

响应内容：

参数	类型	说明
department	json	返回部门编号。同部门实体结构。

响应示例：

{
  "department": {
    "dept_no": 1005,
    "name": "产品部门",
    "parent_no": 2,
    "type": 0,
    "status": 1,
    "integrate_id": "1005"
    "seq": 1
  }
}

注：由于企业微信/钉钉与简道云通讯录的当前部门规则一致，因此 integrate_id 与 dept_no 的值是保持一致的，并不一定需要使用此接口；而飞书平台的部门 ID 是由字符串组成，因此与简道云通讯录的部门 ID 不一致，需要使用此接口。