程序包 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)	获取群成员列表，获取用户/机器人所在群的群成员列表。
GetChatMembersResp	get(GetChatMembersReq req, RequestOptions reqOptions)	获取群成员列表，获取用户/机器人所在群的群成员列表。
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/home/introduction-to-scope-and-authorization/availability); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时，操作者须与群组在同一租户下; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时，仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时，所有群成员都可以拉用户或机器人进群 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create ;

使用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/home/introduction-to-scope-and-authorization/availability); - 机器人或授权用户必须在群组中;- 外部租户不能被加入到内部群中;- 操作内部群时，操作者须与群组在同一租户下; - 在开启 ==仅群主和群管理员可添加群成员== 的设置时，仅有群主/管理员 或 创建群组且具备 ==更新应用所创建群的群信息== 权限的机器人，可以拉用户或者机器人进群; - 在未开启 ==仅群主和群管理员可添加群成员== 的设置时，所有群成员都可以拉用户或机器人进群 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create ;

使用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);- 用户或机器人在任何条件下均可移除自己出群（即主动退群）;- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人，可以移除其他用户或者机器人;- 每次请求，最多移除50个用户或者5个机器人;- 操作内部群时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete ;

使用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);- 用户或机器人在任何条件下均可移除自己出群（即主动退群）;- 仅有群主/管理员 或 创建群组并且具备 ==更新应用所创建群的群信息== 权限的机器人，可以移除其他用户或者机器人;- 每次请求，最多移除50个用户或者5个机器人;- 操作内部群时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/delete ;

使用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

获取群成员列表，获取用户/机器人所在群的群成员列表。

注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get ;

使用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

获取群成员列表，获取用户/机器人所在群的群成员列表。

注意事项：; - 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - 机器人或授权用户必须在群组中; - 该接口不会返回群内的机器人成员; - 由于返回的群成员列表会过滤掉机器人成员，因此返回的群成员个数可能会小于指定的page_size; - 如果有同一时间加入群的群成员，会一次性返回，这会导致返回的群成员个数可能会大于指定的page_size;- 获取内部群信息时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/get ;

使用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/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat ;

使用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/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/is_in_chat ;

使用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);- 目前仅支持加入公开群;- 操作内部群时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join ;

使用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);- 目前仅支持加入公开群;- 操作内部群时，操作者须与群组在同一租户下 ;

官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/me_join ;

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

抛出:

Exception