com.lark.oapi.service.im.v1.resource

类 ChatMembers

java.lang.Object

com.lark.oapi.service.im.v1.resource.ChatMembers

public class ChatMembers
extends Object

构造器概要

构造器

构造器和说明
ChatMembers(Config config)

方法概要

限定符和类型	方法和说明
CreateChatMembersResp	create(CreateChatMembersReq req) 将用户或机器人拉入群聊，把指定的用户或机器人拉入指定群聊内。
CreateChatMembersResp	create(CreateChatMembersReq req, RequestOptions reqOptions) 将用户或机器人拉入群聊，把指定的用户或机器人拉入指定群聊内。
DeleteChatMembersResp	delete(DeleteChatMembersReq req) 将用户或机器人移出群聊，将指定的用户或机器人从群聊中移出。
DeleteChatMembersResp	delete(DeleteChatMembersReq req, RequestOptions reqOptions) 将用户或机器人移出群聊，将指定的用户或机器人从群聊中移出。
GetChatMembersResp	get(GetChatMembersReq req) 获取群成员列表，获取指定群组的成员信息，包括成员名字与 ID。
GetChatMembersResp	get(GetChatMembersReq req, RequestOptions reqOptions) 获取群成员列表，获取指定群组的成员信息，包括成员名字与 ID。
IsInChatChatMembersResp	isInChat(IsInChatChatMembersReq req) 判断用户或机器人是否在群里，根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。
IsInChatChatMembersResp	isInChat(IsInChatChatMembersReq req, RequestOptions reqOptions) 判断用户或机器人是否在群里，根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。
MeJoinChatMembersResp	meJoin(MeJoinChatMembersReq req) 用户或机器人主动加入群聊，将当前调用接口的操作者（用户或机器人）加入指定群聊。
MeJoinChatMembersResp	meJoin(MeJoinChatMembersReq req, RequestOptions reqOptions) 用户或机器人主动加入群聊，将当前调用接口的操作者（用户或机器人）加入指定群聊。

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

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

构造器详细资料

ChatMembers

public ChatMembers(Config config)

方法详细资料

create

public CreateChatMembersResp create(CreateChatMembersReq req,
                                    RequestOptions reqOptions)
                             throws Exception

将用户或机器人拉入群聊，把指定的用户或机器人拉入指定群聊内。

## 前提条件;;- 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用该接口的应用或者用户，必须在相应的群组中。;- 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。;;## 使用限制;;- 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。;- 操作内部群时，当前操作者必须与群组在同一租户内。;- 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。;- 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。;- 操作同一个群组时，如果同时多次调用当前接口，可能会出现 232019 错误码，建议你串行调用，即等待当前调用完成后再进行下一次调用。;; ;

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

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

抛出:

Exception

create

public CreateChatMembersResp create(CreateChatMembersReq req)
                             throws Exception

将用户或机器人拉入群聊，把指定的用户或机器人拉入指定群聊内。

## 前提条件;;- 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 调用该接口的应用或者用户，必须在相应的群组中。;- 如需拉机器人进群，则该机器人必须开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 如果以应用身份拉用户进群，则该用户需要在应用的[可用范围](https://open.feishu.cn/document/home/introduction-to-scope-and-authorization/availability)内。;;## 使用限制;;- 外部租户不能被拉入内部群，但可以被拉入外部群。通过机器人拉外部租户的用户进群，需要先为机器人配置对外共享能力，详情参考[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。;- 操作内部群时，当前操作者必须与群组在同一租户内。;- 如果群组配置了 **仅群主和群管理员可添加群成员**，则仅有群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以拉用户或机器人进群。;- 如果群组没有配置 **仅群主和群管理员可添加群成员**，则所有群成员都可以拉用户或机器人进群。;- 操作同一个群组时，如果同时多次调用当前接口，可能会出现 232019 错误码，建议你串行调用，即等待当前调用完成后再进行下一次调用。;; ;

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

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

抛出:

Exception

delete

public DeleteChatMembersResp delete(DeleteChatMembersReq req,
                                    RequestOptions reqOptions)
                             throws Exception

将用户或机器人移出群聊，将指定的用户或机器人从群聊中移出。

## 前提条件;;调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。;- 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。;- 每次请求，最多移除 50 个用户或者 5 个机器人。;- 操作内部群时，操作者须与群组在同一租户下。;- 操作同一个群组时，如果同时多次调用当前接口，可能会出现 232019 错误码，建议你串行调用，即等待当前调用完成后再进行下一次调用。 ;

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

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

抛出:

Exception

delete

public DeleteChatMembersResp delete(DeleteChatMembersReq req)
                             throws Exception

将用户或机器人移出群聊，将指定的用户或机器人从群聊中移出。

## 前提条件;;调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 仅群主、群管理员，或者是创建群组且具有 **更新应用所创建群的群信息（im:chat:operate_as_owner）** 权限的机器人，可以将其他群成员移出群组。;- 用户或机器人在任何条件下均可将自己移出群组（即主动退群）。;- 每次请求，最多移除 50 个用户或者 5 个机器人。;- 操作内部群时，操作者须与群组在同一租户下。;- 操作同一个群组时，如果同时多次调用当前接口，可能会出现 232019 错误码，建议你串行调用，即等待当前调用完成后再进行下一次调用。 ;

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

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

抛出:

Exception

get

public GetChatMembersResp get(GetChatMembersReq req,
                              RequestOptions reqOptions)
                       throws Exception

获取群成员列表，获取指定群组的成员信息，包括成员名字与 ID。

## 前提条件;;- 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 当前接口的操作者（机器人或用户）必须在被查询的群组内。;;## 使用限制;;- 该接口不会返回群组内的机器人成员。;- 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。;- 获取内部群信息时，操作者须与群组在同一租户下。 ;

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

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

抛出:

Exception

get

public GetChatMembersResp get(GetChatMembersReq req)
                       throws Exception

获取群成员列表，获取指定群组的成员信息，包括成员名字与 ID。

## 前提条件;;- 调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 当前接口的操作者（机器人或用户）必须在被查询的群组内。;;## 使用限制;;- 该接口不会返回群组内的机器人成员。;- 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的 page_size。; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的 page_size。;- 获取内部群信息时，操作者须与群组在同一租户下。 ;

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

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

抛出:

Exception

isInChat

public IsInChatChatMembersResp isInChat(IsInChatChatMembersReq req,
                                        RequestOptions reqOptions)
                                 throws Exception

判断用户或机器人是否在群里，根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。

## 前提条件;;调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;获取内部群信息时，操作者须与群组在同一租户下。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=is_in_chat&project=im&resource=chat.members&version=v1 ;

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

抛出:

Exception

isInChat

public IsInChatChatMembersResp isInChat(IsInChatChatMembersReq req)
                                 throws Exception

判断用户或机器人是否在群里，根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。

## 前提条件;;调用该接口的应用，需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;获取内部群信息时，操作者须与群组在同一租户下。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=is_in_chat&project=im&resource=chat.members&version=v1 ;

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

抛出:

Exception

meJoin

public MeJoinChatMembersResp meJoin(MeJoinChatMembersReq req,
                                    RequestOptions reqOptions)
                             throws Exception

用户或机器人主动加入群聊，将当前调用接口的操作者（用户或机器人）加入指定群聊。

## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 调用该接口仅支持加入公开群。;; 公开群是指的群类型，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_type ` 参数取值是否为 `public`。;;- 操作内部群时，操作者必须与相应的群组在同一租户内。;; 内部群是指的群标签，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_tag ` 参数取值是否为 `inner `。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=me_join&project=im&resource=chat.members&version=v1 ;

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

抛出:

Exception

meJoin

public MeJoinChatMembersResp meJoin(MeJoinChatMembersReq req)
                             throws Exception

用户或机器人主动加入群聊，将当前调用接口的操作者（用户或机器人）加入指定群聊。

## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 调用该接口仅支持加入公开群。;; 公开群是指的群类型，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_type ` 参数取值是否为 `public`。;;- 操作内部群时，操作者必须与相应的群组在同一租户内。;; 内部群是指的群标签，你可以调用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)接口，在返回结果中查看 `chat_tag ` 参数取值是否为 `inner `。 ;

官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=me_join&project=im&resource=chat.members&version=v1 ;

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

抛出:

Exception