com.lark.oapi.service.contact.v3.resource

类 Group

java.lang.Object

com.lark.oapi.service.contact.v3.resource.Group

public class Group
extends Object

构造器概要

构造器

构造器和说明
Group(Config config)

方法概要

限定符和类型	方法和说明
CreateGroupResp	create(CreateGroupReq req) 创建用户组，调用该接口创建一个用户组。
CreateGroupResp	create(CreateGroupReq req, RequestOptions reqOptions) 创建用户组，调用该接口创建一个用户组。
DeleteGroupResp	delete(DeleteGroupReq req) 删除用户组，调用该接口删除指定用户组。
DeleteGroupResp	delete(DeleteGroupReq req, RequestOptions reqOptions) 删除用户组，调用该接口删除指定用户组。
GetGroupResp	get(GetGroupReq req) 查询指定用户组，调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。
GetGroupResp	get(GetGroupReq req, RequestOptions reqOptions) 查询指定用户组，调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。
MemberBelongGroupResp	memberBelong(MemberBelongGroupReq req) 查询用户所属用户组，调用该接口查询指定用户所属的用户组列表。
MemberBelongGroupResp	memberBelong(MemberBelongGroupReq req, RequestOptions reqOptions) 查询用户所属用户组，调用该接口查询指定用户所属的用户组列表。
PatchGroupResp	patch(PatchGroupReq req) 更新用户组，调用该接口更新指定用户组的名称或描述。
PatchGroupResp	patch(PatchGroupReq req, RequestOptions reqOptions) 更新用户组，调用该接口更新指定用户组的名称或描述。
SimplelistGroupResp	simplelist(SimplelistGroupReq req) 查询用户组列表，调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。
SimplelistGroupResp	simplelist(SimplelistGroupReq req, RequestOptions reqOptions) 查询用户组列表，调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。

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

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

构造器详细资料

Group

public Group(Config config)

方法详细资料

create

public CreateGroupResp create(CreateGroupReq req,
                              RequestOptions reqOptions)
                       throws Exception

创建用户组，调用该接口创建一个用户组。用户组是飞书通讯录中基础实体之一，在用户组内可添加用户或部门资源。各类业务权限管控可以与用户组关联，从而实现高效便捷的成员权限管控。

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

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

抛出:

Exception

create

public CreateGroupResp create(CreateGroupReq req)
                       throws Exception

创建用户组，调用该接口创建一个用户组。用户组是飞书通讯录中基础实体之一，在用户组内可添加用户或部门资源。各类业务权限管控可以与用户组关联，从而实现高效便捷的成员权限管控。

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

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

抛出:

Exception

delete

public DeleteGroupResp delete(DeleteGroupReq req,
                              RequestOptions reqOptions)
                       throws Exception

删除用户组，调用该接口删除指定用户组。

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

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

抛出:

Exception

delete

public DeleteGroupResp delete(DeleteGroupReq req)
                       throws Exception

删除用户组，调用该接口删除指定用户组。

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

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

抛出:

Exception

get

public GetGroupResp get(GetGroupReq req,
                        RequestOptions reqOptions)
                 throws Exception

查询指定用户组，调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。

## 注意事项;;- 应用的通讯录权限范围需要符合以下任一设置，才可以成功调用本接口。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;; - 通讯录权限范围设置为 **全部员工**。; - 由企业管理员在管理后台设置应用可见范围内包含当前待查询的用户组，然后应用的通讯录权限范围设置为 **与应用的可用范围一致**。;- 支持查询普通用户组和动态用户组。 ;

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

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

抛出:

Exception

get

public GetGroupResp get(GetGroupReq req)
                 throws Exception

查询指定用户组，调用该接口通过用户组 ID 查询指定用户组的基本信息，包括用户组名称、成员数量和类型等。

## 注意事项;;- 应用的通讯录权限范围需要符合以下任一设置，才可以成功调用本接口。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;; - 通讯录权限范围设置为 **全部员工**。; - 由企业管理员在管理后台设置应用可见范围内包含当前待查询的用户组，然后应用的通讯录权限范围设置为 **与应用的可用范围一致**。;- 支持查询普通用户组和动态用户组。 ;

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

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

抛出:

Exception

memberBelong

public MemberBelongGroupResp memberBelong(MemberBelongGroupReq req,
                                          RequestOptions reqOptions)
                                   throws Exception

查询用户所属用户组，调用该接口查询指定用户所属的用户组列表。

## 注意事项;;- 如果应用的通讯录权限范围设置为 **全部员工**，则通过本接口可查询到用户所属的全部用户组列表，否则，仅会查询到应用通讯录权限范围内该用户所属的用户组。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;;- 支持查询到普通用户组和动态用户组的信息。 ;

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

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

抛出:

Exception

memberBelong

public MemberBelongGroupResp memberBelong(MemberBelongGroupReq req)
                                   throws Exception

查询用户所属用户组，调用该接口查询指定用户所属的用户组列表。

## 注意事项;;- 如果应用的通讯录权限范围设置为 **全部员工**，则通过本接口可查询到用户所属的全部用户组列表，否则，仅会查询到应用通讯录权限范围内该用户所属的用户组。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;;- 支持查询到普通用户组和动态用户组的信息。 ;

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

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

抛出:

Exception

patch

public PatchGroupResp patch(PatchGroupReq req,
                            RequestOptions reqOptions)
                     throws Exception

更新用户组，调用该接口更新指定用户组的名称或描述。

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

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

抛出:

Exception

patch

public PatchGroupResp patch(PatchGroupReq req)
                     throws Exception

更新用户组，调用该接口更新指定用户组的名称或描述。

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

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

抛出:

Exception

simplelist

public SimplelistGroupResp simplelist(SimplelistGroupReq req,
                                      RequestOptions reqOptions)
                               throws Exception

查询用户组列表，调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。

## 注意事项;;- 如果应用的通讯录权限范围设置为 **全部员工**，则通过本接口可查询到租户内所有用户组的信息，否则，仅会查询到应用通讯录权限范围内的用户组信息。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;;- 支持查询到普通用户组和动态用户组的信息。 ;

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

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

抛出:

Exception

simplelist

public SimplelistGroupResp simplelist(SimplelistGroupReq req)
                               throws Exception

查询用户组列表，调用该接口查询当前租户下的用户组列表，列表内包含用户组的 ID、名字、成员数量和类型等信息。

## 注意事项;;- 如果应用的通讯录权限范围设置为 **全部员工**，则通过本接口可查询到租户内所有用户组的信息，否则，仅会查询到应用通讯录权限范围内的用户组信息。了解应用通讯录权限范围，可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。;;- 支持查询到普通用户组和动态用户组的信息。 ;

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

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

抛出:

Exception