通讯录接口

爱搭贝
更新于2025-06-26
  • 本期提供通讯录查询接口功能,重点用于实现用户、组织体系的关联。
  • 注意:所有响应数据中data里应该为加密字符串,本文档为了方便演示显示为明文。

1、组织查询

接口地址:/orgs 请求方式:GET

请求参数

参数类型必输说明
parentIdstring组织id,可以为空
recursionbool是否查询组织下级

响应参数

参数类型说明
namestring名称
idstring应用id
pidstring父级id
childrenarray子级

样例:

{
  "errcode": 0,
  "errmsg": "success",
  "data": "[{\"children\":[{\"children\":[{\"id\":\"953cbb6d836f48e3a9f8baad9f310404\",\"name\":\"部门1\",\"pid\":\"2b1ec07234c74e369fbe705e6b400787\"},{\"id\":\"9bb08a408a0b4d19b4588d5ecaadca58\",\"name\":\"部门2\",\"pid\":\"2b1ec07234c74e369fbe705e6b400787\"},{\"id\":\"b7c27aa1cc904af08f88718a1c58911f\",\"name\":\"部门3\",\"pid\":\"2b1ec07234c74e369fbe705e6b400787\"}],\"id\":\"2b1ec07234c74e369fbe705e6b400787\",\"name\":\"部门4\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"},{\"id\":\"2bf475b9efa4404e939afffa096d5f70\",\"name\":\"产品部\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"},{\"children\":[{\"id\":\"256ee934004b4424a916779152b7576a\",\"name\":\"研发组\",\"pid\":\"b1f1bdfe0ee04b1da93d6677c936313e\"},{\"children\":[{\"id\":\"2f9c9258e79c4e91b82907ab04e76f90\",\"name\":\"三组\",\"pid\":\"fcf86e869c124f759f0baef4b98cef88\"},{\"id\":\"3f9366618cb843c287b3290ec3b8e2a1\",\"name\":\"二组\",\"pid\":\"fcf86e869c124f759f0baef4b98cef88\"},{\"id\":\"97e667610042472d8bad3c3ebd468c98\",\"name\":\"四组\",\"pid\":\"fcf86e869c124f759f0baef4b98cef88\"},{\"id\":\"aa2dd0b0b94c4dcbab3923efc437cf75\",\"name\":\"一组\",\"pid\":\"fcf86e869c124f759f0baef4b98cef88\"}],\"id\":\"fcf86e869c124f759f0baef4b98cef88\",\"name\":\"前端组\",\"pid\":\"b1f1bdfe0ee04b1da93d6677c936313e\"}],\"id\":\"b1f1bdfe0ee04b1da93d6677c936313e\",\"name\":\"研发部\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"},{\"id\":\"eafe3106e13a4496ab3b30dd994d04d8\",\"name\":\"测试部\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"},{\"id\":\"f158ba6076af418e97c86e15c21fd5e2\",\"name\":\"运维部\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"}],\"id\":\"d990d4bf1a494c0aba7c4d5d8625c20d\",\"name\":\"平头兄弟科技有限公司\",\"pid\":\"a4dc85c6f760413181c994a65af095a5\"}]",
  "success": true
}

2、组织详情

接口地址:/orgs/{org_id} 请求方式:GET

请求参数

参数类型必输说明
org_idstring组织id

响应参数

参数类型说明
namestring名称
idstringid

样例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "{\"id\":\"b1f1bdfe0ee04b1da93d6677c936313e\",\"name\":\"研发部\",\"pid\":\"d990d4bf1a494c0aba7c4d5d8625c20d\"}"
}

3、组织下用户

接口地址:/users 请求方式:GET

请求参数

参数类型必输说明
org_idstring组织id
recursionbool是否查询组织下级用户

响应参数

参数类型说明
namestring名称
idstring用户id

样例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "[{\"departmentId\":\"3f9366618cb843c287b3290ec3b8e2a1\",\"departmentIds\":[\"3f9366618cb843c287b3290ec3b8e2a1\"],\"id\":\"572517a1940941debc51f6515fe9342d\",\"name\":\"梅兰芳\"},{\"departmentId\":\"3f9366618cb843c287b3290ec3b8e2a1\",\"departmentIds\":[\"3f9366618cb843c287b3290ec3b8e2a1\"],\"id\":\"46e9258b7205453697e381c9b4b5477c\",\"name\":\"李易峰\"},{\"departmentId\":\"3f9366618cb843c287b3290ec3b8e2a1\",\"departmentIds\":[\"3f9366618cb843c287b3290ec3b8e2a1\"],\"id\":\"5f2a58f31bc344fea5c8393545019f5f\",\"name\":\"魏海\"}]",
    "success": true
}

4、用户信息

接口地址:/users/{user_id} 请求方式:GET

请求参数

参数类型必输说明
user_idstring用户id

样例:

{
    "errcode": 0,
    "errmsg": "success",
    "data": "{\"departmentId\":\"3f9366618cb843c287b3290ec3b8e2a1\",\"departmentIds\":[\"3f9366618cb843c287b3290ec3b8e2a1\"],\"id\":\"46e9258b7205453697e381c9b4b5477c\",\"name\":\"李易峰\"}",
    "success": true
}