Chat (larksuite-oapi 2.8.5 API)

java.lang.Object
- com.lark.oapi.service.im.v1.resource.Chat

```
public class Chat
extends Object
```

构造器概要

构造器
构造器和说明

Chat(Config config)

构造器
构造器和说明
`Chat(Config config)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreateChatResp`	`create(CreateChatReq req)` 创建群，创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。
`CreateChatResp`	`create(CreateChatReq req, RequestOptions reqOptions)` 创建群，创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。
`DeleteChatResp`	`delete(DeleteChatReq req)` 解散群，通过 chat_id 解散指定群组。
`DeleteChatResp`	`delete(DeleteChatReq req, RequestOptions reqOptions)` 解散群，通过 chat_id 解散指定群组。
`GetChatResp`	`get(GetChatReq req)` 获取群信息，获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。
`GetChatResp`	`get(GetChatReq req, RequestOptions reqOptions)` 获取群信息，获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。
`LinkChatResp`	`link(LinkChatReq req)` 获取群分享链接，获取指定群的分享链接，他人点击分享链接后可加入群组。
`LinkChatResp`	`link(LinkChatReq req, RequestOptions reqOptions)` 获取群分享链接，获取指定群的分享链接，他人点击分享链接后可加入群组。
`ListChatResp`	`list(ListChatReq req)` 获取用户或机器人所在的群列表，获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。
`ListChatResp`	`list(ListChatReq req, RequestOptions reqOptions)` 获取用户或机器人所在的群列表，获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。
`SearchChatResp`	`search(SearchChatReq req)` 搜索对用户或机器人可见的群列表，获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。
`SearchChatResp`	`search(SearchChatReq req, RequestOptions reqOptions)` 搜索对用户或机器人可见的群列表，获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。
`UpdateChatResp`	`update(UpdateChatReq req)` 更新群信息，更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。
`UpdateChatResp`	`update(UpdateChatReq req, RequestOptions reqOptions)` 更新群信息，更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Chat
```
public Chat(Config config)
```
- 方法详细资料
  - create
```
public CreateChatResp create(CreateChatReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    创建群，创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。
    ## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;商店应用无法使用用户的 user_id，因此使用商店应用调用本接口时用户 ID 类型请选择 open_id 或者 union_id。;;## 注意事项;;- 如果你需要在已创建的群聊内邀请用户或机器人入群，可调用[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口。;- 调用 API 只能创建普通消息群，消息形式可以选择对话消息或者话题消息。如果你需要直接创建话题群，请通过飞书客户端创建群组，创建时群模式选择 **话题**。;- 已添加外部共享能力的机器人，允许在创建群时将外部企业用户和内部用户同时添加到群组中，这样创建的群为外部群。详情参见[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/CreateChatSample.java ;
    
    抛出:
    
    Exception
  - create
```
public CreateChatResp create(CreateChatReq req)
                      throws Exception
```
    创建群，创建群聊，创建时支持设置群头像、群名称、群主以及群类型等配置，同时支持邀请群成员、群机器人入群。
    ## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;商店应用无法使用用户的 user_id，因此使用商店应用调用本接口时用户 ID 类型请选择 open_id 或者 union_id。;;## 注意事项;;- 如果你需要在已创建的群聊内邀请用户或机器人入群，可调用[将用户或机器人拉入群聊](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat-members/create)接口。;- 调用 API 只能创建普通消息群，消息形式可以选择对话消息或者话题消息。如果你需要直接创建话题群，请通过飞书客户端创建群组，创建时群模式选择 **话题**。;- 已添加外部共享能力的机器人，允许在创建群时将外部企业用户和内部用户同时添加到群组中，这样创建的群为外部群。详情参见[机器人支持外部群和外部用户单聊](https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/develop-robots/add-bot-to-external-group)。 ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/CreateChatSample.java ;
    
    抛出:
    
    Exception
  - delete
```
public DeleteChatResp delete(DeleteChatReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    解散群，通过 chat_id 解散指定群组。通过 API 解散群组后，群聊天记录将不会保存。
    ## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 如果以应用身份（tenant_access_token）解散群，则应用机器人需要符合以下任一情况。;; - 应用机器人是群主。; - 应用机器人是群的创建者，且应用已开通 **更新应用所创建群的群信息**（im:chat:operate_as_owner）权限。;;- 如果以用户身份（user_access_token）解散群，需要该用户是群主。;; ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/DeleteChatSample.java ;
    
    抛出:
    
    Exception
  - delete
```
public DeleteChatResp delete(DeleteChatReq req)
                      throws Exception
```
    解散群，通过 chat_id 解散指定群组。通过 API 解散群组后，群聊天记录将不会保存。
    ## 前提条件;;应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;;## 使用限制;;- 如果以应用身份（tenant_access_token）解散群，则应用机器人需要符合以下任一情况。;; - 应用机器人是群主。; - 应用机器人是群的创建者，且应用已开通 **更新应用所创建群的群信息**（im:chat:operate_as_owner）权限。;;- 如果以用户身份（user_access_token）解散群，需要该用户是群主。;; ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/DeleteChatSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetChatResp get(GetChatReq req,
                       RequestOptions reqOptions)
                throws Exception
```
    获取群信息，获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。
    ## 前提条件;;应用需要开启[机器人能力](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=get&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/GetChatSample.java ;
    
    抛出:
    
    Exception
  - get
```
public GetChatResp get(GetChatReq req)
                throws Exception
```
    获取群信息，获取指定群的基本信息，包括群名称、群描述、群头像、群主 ID 以及群权限配置等。
    ## 前提条件;;应用需要开启[机器人能力](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=get&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/GetChatSample.java ;
    
    抛出:
    
    Exception
  - link
```
public LinkChatResp link(LinkChatReq req,
                         RequestOptions reqOptions)
                  throws Exception
```
    获取群分享链接，获取指定群的分享链接，他人点击分享链接后可加入群组。
    ## 前提条件;;应用需要开启[机器人能力](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=link&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/LinkChatSample.java ;
    
    抛出:
    
    Exception
  - link
```
public LinkChatResp link(LinkChatReq req)
                  throws Exception
```
    获取群分享链接，获取指定群的分享链接，他人点击分享链接后可加入群组。
    ## 前提条件;;应用需要开启[机器人能力](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=link&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/LinkChatSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListChatResp list(ListChatReq req,
                         RequestOptions reqOptions)
                  throws Exception
```
    获取用户或机器人所在的群列表，获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。
    ## 前提条件;;应用需要开启[机器人能力](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)的请求 URL。;- 获取到的群列表中，不包含单聊（群模式为 `p2p`）。;- 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型，如果是获取机器人所在群列表该值可以不填。; ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/ListChatSample.java ;
    
    抛出:
    
    Exception
  - list
```
public ListChatResp list(ListChatReq req)
                  throws Exception
```
    获取用户或机器人所在的群列表，获取 [access_token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) 所代表的用户或者机器人所在的群列表。
    ## 前提条件;;应用需要开启[机器人能力](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)的请求 URL。;- 获取到的群列表中，不包含单聊（群模式为 `p2p`）。;- 查询参数 **user_id_type** 用于控制响应体中 owner_id 的类型，如果是获取机器人所在群列表该值可以不填。; ;
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/ListChatSample.java ;
    
    抛出:
    
    Exception
  - search
```
public SearchChatResp search(SearchChatReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    搜索对用户或机器人可见的群列表，获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。
    ## 前提条件;;应用需要开启[机器人能力](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=search&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/SearchChatSample.java ;
    
    抛出:
    
    Exception
  - search
```
public SearchChatResp search(SearchChatReq req)
                      throws Exception
```
    搜索对用户或机器人可见的群列表，获取当前身份（用户或机器人）可见的群列表，包括当前身份所在的群、对当前身份公开的群。支持关键词搜索、分页搜索。
    ## 前提条件;;应用需要开启[机器人能力](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=search&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/SearchChatSample.java ;
    
    抛出:
    
    Exception
  - update
```
public UpdateChatResp update(UpdateChatReq req,
                             RequestOptions reqOptions)
                      throws Exception
```
    更新群信息，更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=update&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/UpdateChatSample.java ;
    
    抛出:
    
    Exception
  - update
```
public UpdateChatResp update(UpdateChatReq req)
                      throws Exception
```
    更新群信息，更新指定群的信息，包括群头像、群名称、群描述、群配置以及群主等。
    官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=update&project=im&resource=chat&version=v1 ;
    使用Demo链接: https://github.com/larksuite/oapi-sdk-java/tree/v2_main/sample/src/main/java/com/lark/oapi/sample/apiall/imv1/UpdateChatSample.java ;
    
    抛出:
    
    Exception

类 Chat

构造器概要

方法概要

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

构造器详细资料

Chat

方法详细资料

create

create

delete

delete

get

get

link

link

list

list

search

search

update

update