public class Chat extends Object
| 限定符和类型 | 方法和说明 |
|---|---|
CreateChatResp |
create(CreateChatReq req)
创建群,创建群并设置群头像、群名、群描述等。
|
CreateChatResp |
create(CreateChatReq req,
RequestOptions reqOptions)
创建群,创建群并设置群头像、群名、群描述等。
|
DeleteChatResp |
delete(DeleteChatReq req)
解散群,解散群组。
|
DeleteChatResp |
delete(DeleteChatReq req,
RequestOptions reqOptions)
解散群,解散群组。
|
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)
获取用户或机器人所在的群列表,获取用户或者机器人所在群列表。
|
ListChatResp |
list(ListChatReq req,
RequestOptions reqOptions)
获取用户或机器人所在的群列表,获取用户或者机器人所在群列表。
|
SearchChatResp |
search(SearchChatReq req)
搜索对用户或机器人可见的群列表,搜索对用户或机器人可见的群列表,包括:用户或机器人所在的群、对用户或机器人公开的群。
|
SearchChatResp |
search(SearchChatReq req,
RequestOptions reqOptions)
搜索对用户或机器人可见的群列表,搜索对用户或机器人可见的群列表,包括:用户或机器人所在的群、对用户或机器人公开的群。
|
UpdateChatResp |
update(UpdateChatReq req)
更新群信息,更新群头像、群名称、群描述、群配置、转让群主等。
|
UpdateChatResp |
update(UpdateChatReq req,
RequestOptions reqOptions)
更新群信息,更新群头像、群名称、群描述、群配置、转让群主等。
|
public Chat(Config config)
public CreateChatResp create(CreateChatReq 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-members/create)接口 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create ;
Exceptionpublic CreateChatResp create(CreateChatReq 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-members/create)接口 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/create ;
Exceptionpublic DeleteChatResp delete(DeleteChatReq req, RequestOptions reqOptions) throws Exception
注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 如果使用tenant_access_token,需要机器人符合以下任一情况才可解散群:; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token,需要对应的用户是群主才可解散群 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete ;
Exceptionpublic DeleteChatResp delete(DeleteChatReq req) throws Exception
注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability);- 如果使用tenant_access_token,需要机器人符合以下任一情况才可解散群:; - 机器人是群主; - 机器人是群的创建者且具备==更新应用所创建群的群信息==权限;- 如果使用user_access_token,需要对应的用户是群主才可解散群 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/delete ;
Exceptionpublic GetChatResp get(GetChatReq 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/get ;
Exceptionpublic GetChatResp get(GetChatReq 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/get ;
Exceptionpublic LinkChatResp link(LinkChatReq req, RequestOptions reqOptions) throws Exception
注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - access_token所对应的 **机器人** 或 **授权用户** 必须在`chat_id`参数指定的群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时,仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时,操作者须与群组在同一租户下 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link ;
Exceptionpublic LinkChatResp link(LinkChatReq req) throws Exception
注意事项:;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability); - access_token所对应的 **机器人** 或 **授权用户** 必须在`chat_id`参数指定的群组中;- 单聊、密聊、团队群不支持分享群链接;- 当Bot被停用或Bot退出群组时,Bot生成的群链接也将停用;- 当群聊开启了 ==仅群主和群管理员可添加群成员/分享群== 设置时,仅**群主**和**群管理员**可以获取群分享链接;- 获取内部群分享链接时,操作者须与群组在同一租户下 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/link ;
Exceptionpublic ListChatResp list(ListChatReq 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)的请求 URL;- 获取的群列表不包含P2P单聊 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list ;
Exceptionpublic ListChatResp list(ListChatReq 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)的请求 URL;- 获取的群列表不包含P2P单聊 ;
官网API文档链接:https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/list ;
Exceptionpublic 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/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search ;
Exceptionpublic 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/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/search ;
Exceptionpublic UpdateChatResp update(UpdateChatReq 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/update ;
Exceptionpublic UpdateChatResp update(UpdateChatReq 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/update ;
ExceptionCopyright © 2024. All rights reserved.