com.lark.oapi.service.contact.v3

类 ContactService.Department

java.lang.Object

com.lark.oapi.service.contact.v3.ContactService.Department

封闭类:

ContactService

public static class ContactService.Department
extends Object

构造器概要

构造器

构造器和说明
Department(Config config)

方法概要

限定符和类型	方法和说明
ChildrenDepartmentResp	children(ChildrenDepartmentReq req) 获取子部门列表，通过部门ID获取部门的子部门列表。
ChildrenDepartmentResp	children(ChildrenDepartmentReq req, RequestOptions reqOptions) 获取子部门列表，通过部门ID获取部门的子部门列表。
CreateDepartmentResp	create(CreateDepartmentReq req) 创建部门，该接口用于向通讯录中创建部门。
CreateDepartmentResp	create(CreateDepartmentReq req, RequestOptions reqOptions) 创建部门，该接口用于向通讯录中创建部门。
DeleteDepartmentResp	delete(DeleteDepartmentReq req) 删除部门，该接口用于向通讯录中删除部门。
DeleteDepartmentResp	delete(DeleteDepartmentReq req, RequestOptions reqOptions) 删除部门，该接口用于向通讯录中删除部门。
GetDepartmentResp	get(GetDepartmentReq req) 获取单个部门信息，该接口用于向通讯录获取单个部门信息。
GetDepartmentResp	get(GetDepartmentReq req, RequestOptions reqOptions) 获取单个部门信息，该接口用于向通讯录获取单个部门信息。
ListDepartmentResp	list(ListDepartmentReq req) ， 官网API文档链接:	ListDepartmentResp	list(ListDepartmentReq req, RequestOptions reqOptions) ， 官网API文档链接:	ParentDepartmentResp	parent(ParentDepartmentReq req) 获取父部门信息，该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。
ParentDepartmentResp	parent(ParentDepartmentReq req, RequestOptions reqOptions) 获取父部门信息，该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。
PatchDepartmentResp	patch(PatchDepartmentReq req) 修改部门部分信息，该接口用于更新通讯录中部门的信息中的任一个字段。
PatchDepartmentResp	patch(PatchDepartmentReq req, RequestOptions reqOptions) 修改部门部分信息，该接口用于更新通讯录中部门的信息中的任一个字段。
SearchDepartmentResp	search(SearchDepartmentReq req) 搜索部门，搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。
SearchDepartmentResp	search(SearchDepartmentReq req, RequestOptions reqOptions) 搜索部门，搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。
UnbindDepartmentChatDepartmentResp	unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req) 部门群转为普通群，通过该接口将部门群转为普通群。
UnbindDepartmentChatDepartmentResp	unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req, RequestOptions reqOptions) 部门群转为普通群，通过该接口将部门群转为普通群。
UpdateDepartmentResp	update(UpdateDepartmentReq req) 更新部门所有信息，该接口用于更新当前部门所有信息。
UpdateDepartmentResp	update(UpdateDepartmentReq req, RequestOptions reqOptions) 更新部门所有信息，该接口用于更新当前部门所有信息。

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Department

public Department(Config config)

方法详细资料

children

public ChildrenDepartmentResp children(ChildrenDepartmentReq req,
                                       RequestOptions reqOptions)
                                throws Exception

获取子部门列表，通过部门ID获取部门的子部门列表。

- 部门ID 必填，根部门的部门ID 为0。;- 使用 `user_access_token` 时，返回该用户组织架构可见性范围（[登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility)）内的所有可见部门。当进行递归查询时，最多1000个部门对该用户可见。;;- 使用 ;`tenant_access_token` 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0，会检验应用是否有全员通讯录权限，如果是非0 部门ID，则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码，有权限则返回部门下子部门列表（根据fetch_child决定是否递归）。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ChildrenDepartmentSample.java ;

抛出:

Exception

children

public ChildrenDepartmentResp children(ChildrenDepartmentReq req)
                                throws Exception

获取子部门列表，通过部门ID获取部门的子部门列表。

- 部门ID 必填，根部门的部门ID 为0。;- 使用 `user_access_token` 时，返回该用户组织架构可见性范围（[登陆企业管理后台进行权限配置](https://www.feishu.cn/admin/security/permission/visibility)）内的所有可见部门。当进行递归查询时，最多1000个部门对该用户可见。;;- 使用 ;`tenant_access_token` 则基于应用的通讯录权限范围进行权限校验与过滤。;如果部门ID为0，会检验应用是否有全员通讯录权限，如果是非0 部门ID，则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码，有权限则返回部门下子部门列表（根据fetch_child决定是否递归）。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ChildrenDepartmentSample.java ;

抛出:

Exception

create

public CreateDepartmentResp create(CreateDepartmentReq req,
                                   RequestOptions reqOptions)
                            throws Exception

创建部门，该接口用于向通讯录中创建部门。

只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门，则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/CreateDepartmentSample.java ;

抛出:

Exception

create

public CreateDepartmentResp create(CreateDepartmentReq req)
                            throws Exception

创建部门，该接口用于向通讯录中创建部门。

只可在应用的通讯录权限范围内的部门下创建部门。若需要在根部门下创建子部门，则应用通讯录权限范围需要设置为“全部成员”。应用商店应用无权限调用此接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/CreateDepartmentSample.java ;

抛出:

Exception

delete

public DeleteDepartmentResp delete(DeleteDepartmentReq req,
                                   RequestOptions reqOptions)
                            throws Exception

删除部门，该接口用于向通讯录中删除部门。

应用需要同时拥有待删除部门及其父部门的通讯录授权。应用商店应用无权限调用该接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/DeleteDepartmentSample.java ;

抛出:

Exception

delete

public DeleteDepartmentResp delete(DeleteDepartmentReq req)
                            throws Exception

删除部门，该接口用于向通讯录中删除部门。

应用需要同时拥有待删除部门及其父部门的通讯录授权。应用商店应用无权限调用该接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/delete ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/DeleteDepartmentSample.java ;

抛出:

Exception

get

public GetDepartmentResp get(GetDepartmentReq req,
                             RequestOptions reqOptions)
                      throws Exception

获取单个部门信息，该接口用于向通讯录获取单个部门信息。

- 使用`tenant_access_token`时，应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息，则需要拥有全员权限。;- 使用`user_access_token`时，用户需要有待查询部门的可见性，如果需要获取根部门信息，则要求员工可见所有人。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/GetDepartmentSample.java ;

抛出:

Exception

get

public GetDepartmentResp get(GetDepartmentReq req)
                      throws Exception

获取单个部门信息，该接口用于向通讯录获取单个部门信息。

- 使用`tenant_access_token`时，应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息，则需要拥有全员权限。;- 使用`user_access_token`时，用户需要有待查询部门的可见性，如果需要获取根部门信息，则要求员工可见所有人。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/GetDepartmentSample.java ;

抛出:

Exception

list

public ListDepartmentResp list(ListDepartmentReq req,
                               RequestOptions reqOptions)
                        throws Exception

，

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=department&version=v3 ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListDepartmentSample.java ;

抛出:

Exception

list

public ListDepartmentResp list(ListDepartmentReq req)
                        throws Exception

，

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=contact&resource=department&version=v3 ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ListDepartmentSample.java ;

抛出:

Exception

parent

public ParentDepartmentResp parent(ParentDepartmentReq req,
                                   RequestOptions reqOptions)
                            throws Exception

获取父部门信息，该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。

使用`tenant_access_token`时,该接口只返回可见性范围内的父部门信息。;例如：A >>B>>C>>D四级部门，通讯录权限只到B，那么查询D部门的parent，会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ParentDepartmentSample.java ;

抛出:

Exception

parent

public ParentDepartmentResp parent(ParentDepartmentReq req)
                            throws Exception

获取父部门信息，该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。

使用`tenant_access_token`时,该接口只返回可见性范围内的父部门信息。;例如：A >>B>>C>>D四级部门，通讯录权限只到B，那么查询D部门的parent，会返回B和C两级部门。;使用user_access_token时,该接口只返回对于用户可见的父部门信息。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/ParentDepartmentSample.java ;

抛出:

Exception

patch

public PatchDepartmentResp patch(PatchDepartmentReq req,
                                 RequestOptions reqOptions)
                          throws Exception

修改部门部分信息，该接口用于更新通讯录中部门的信息中的任一个字段。

调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/PatchDepartmentSample.java ;

抛出:

Exception

patch

public PatchDepartmentResp patch(PatchDepartmentReq req)
                          throws Exception

修改部门部分信息，该接口用于更新通讯录中部门的信息中的任一个字段。

调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/patch ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/PatchDepartmentSample.java ;

抛出:

Exception

search

public SearchDepartmentResp search(SearchDepartmentReq req,
                                   RequestOptions reqOptions)
                            throws Exception

搜索部门，搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。

部门存在，但用户搜索不到并不一定是搜索有问题，可能是管理员在后台配置了权限控制，导致用户无法搜索到该部门。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/SearchDepartmentSample.java ;

抛出:

Exception

search

public SearchDepartmentResp search(SearchDepartmentReq req)
                            throws Exception

搜索部门，搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。

部门存在，但用户搜索不到并不一定是搜索有问题，可能是管理员在后台配置了权限控制，导致用户无法搜索到该部门。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/SearchDepartmentSample.java ;

抛出:

Exception

unbindDepartmentChat

public UnbindDepartmentChatDepartmentResp unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req,
                                                               RequestOptions reqOptions)
                                                        throws Exception

部门群转为普通群，通过该接口将部门群转为普通群。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UnbindDepartmentChatDepartmentSample.java ;

抛出:

Exception

unbindDepartmentChat

public UnbindDepartmentChatDepartmentResp unbindDepartmentChat(UnbindDepartmentChatDepartmentReq req)
                                                        throws Exception

部门群转为普通群，通过该接口将部门群转为普通群。

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/unbind_department_chat ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UnbindDepartmentChatDepartmentSample.java ;

抛出:

Exception

update

public UpdateDepartmentResp update(UpdateDepartmentReq req,
                                   RequestOptions reqOptions)
                            throws Exception

更新部门所有信息，该接口用于更新当前部门所有信息。

- 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。;; - 没有填写的字段会被置为空值（order字段除外）。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UpdateDepartmentSample.java ;

抛出:

Exception

update

public UpdateDepartmentResp update(UpdateDepartmentReq req)
                            throws Exception

更新部门所有信息，该接口用于更新当前部门所有信息。

- 调用该接口需要具有该部门以及更新操作涉及的部门的通讯录权限。应用商店应用无权限调用此接口。;; - 没有填写的字段会被置为空值（order字段除外）。 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/update ;

使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/contactv3/UpdateDepartmentSample.java ;

抛出:

Exception