contact-lookup
飞书通讯录查询:查找用户、列出部门成员、查询组织架构。
调用
通过 channel tool 的 action 参数调用:
| Action |
说明 |
get_user |
查询用户信息 |
list_users |
列出部门下的用户 |
get_department |
查询部门信息 |
list_departments |
列出子部门 |
参数
get_user
| 参数 |
类型 |
必填 |
说明 |
| user_id |
string |
否 |
用户 open_id。省略时自动使用当前发送者的 open_id,查询"我是谁"时无需提供。仅在查询其他人时才需指定。 |
| user_id_type |
string |
否 |
ID 类型 (open_id/union_id/user_id,默认 open_id) |
list_users
| 参数 |
类型 |
必填 |
说明 |
| department_id |
string |
是 |
部门 ID |
| user_id_type |
string |
否 |
返回的用户 ID 类型 |
| page_size |
integer |
否 |
每页数量(默认 50) |
| page_token |
string |
否 |
分页 token |
get_department
| 参数 |
类型 |
必填 |
说明 |
| department_id |
string |
是 |
部门 ID |
list_departments
| 参数 |
类型 |
必填 |
说明 |
| parent_department_id |
string |
否 |
父部门 ID(默认根部门) |
| page_size |
integer |
否 |
每页数量(默认 50) |
| page_token |
string |
否 |
分页 token |
示例
查看我的信息(自动使用当前用户)
-> channel(action="get_user")
查找其他用户信息(需指定 user_id)
-> channel(action="get_user", user_id="ou_xxx")
列出工程部成员
-> channel(action="list_users", department_id="dept_xxx")
查看部门信息
-> channel(action="get_department", department_id="dept_xxx")
列出所有顶级部门
-> channel(action="list_departments")
自动执行原则
- user_id 自动解析:省略时从当前发送者的 open_id 自动获取,不要向用户询问。
- user_id_type 自动默认:默认使用
open_id,不要问用户选哪种 ID 类型。
- 零参数调用:用户说"我是谁"/"查看我的信息"时,直接调用
channel(action="get_user"),不需要任何参数。
- 部门浏览自动执行:用户说"看看部门"时,直接调用
channel(action="list_departments") 列出根部门,不要问父部门 ID。
- 禁止交互式菜单:不要给出 [1] [2] [3] 选项让用户选择身份类型,直接使用最合理的默认值。
- 链式自动执行:查到用户信息后,如果包含部门 ID,可以自动查询部门详情丰富结果。
安全等级