public class Message extends Object
| 限定符和类型 | 方法和说明 |
|---|---|
CreateMessageResp |
create(CreateMessageReq req)
发送消息,调用该接口向指定用户或者群聊发送消息。
|
CreateMessageResp |
create(CreateMessageReq req,
RequestOptions reqOptions)
发送消息,调用该接口向指定用户或者群聊发送消息。
|
DeleteMessageResp |
delete(DeleteMessageReq req)
撤回消息,调用该接口撤回指定消息。
|
DeleteMessageResp |
delete(DeleteMessageReq req,
RequestOptions reqOptions)
撤回消息,调用该接口撤回指定消息。
|
ForwardMessageResp |
forward(ForwardMessageReq req)
转发消息,调用该接口将一条指定的消息转发给用户、群聊或话题。
|
ForwardMessageResp |
forward(ForwardMessageReq req,
RequestOptions reqOptions)
转发消息,调用该接口将一条指定的消息转发给用户、群聊或话题。
|
GetMessageResp |
get(GetMessageReq req)
获取指定消息的内容,调用该接口通过消息的 `message_id` 查询消息内容。
|
GetMessageResp |
get(GetMessageReq req,
RequestOptions reqOptions)
获取指定消息的内容,调用该接口通过消息的 `message_id` 查询消息内容。
|
ListMessageResp |
list(ListMessageReq req)
获取会话历史消息,获取指定会话(包括单聊、群组)内的历史消息(即聊天记录)。
|
ListMessageResp |
list(ListMessageReq req,
RequestOptions reqOptions)
获取会话历史消息,获取指定会话(包括单聊、群组)内的历史消息(即聊天记录)。
|
MergeForwardMessageResp |
mergeForward(MergeForwardMessageReq req)
合并转发消息,将来自同一个会话内的多条消息,合并转发给指定的用户、群聊或话题。
|
MergeForwardMessageResp |
mergeForward(MergeForwardMessageReq req,
RequestOptions reqOptions)
合并转发消息,将来自同一个会话内的多条消息,合并转发给指定的用户、群聊或话题。
|
PatchMessageResp |
patch(PatchMessageReq req)
更新已发送的消息卡片,通过消息 ID(message_id)更新已发送的消息卡片的内容。
|
PatchMessageResp |
patch(PatchMessageReq req,
RequestOptions reqOptions)
更新已发送的消息卡片,通过消息 ID(message_id)更新已发送的消息卡片的内容。
|
PushFollowUpMessageResp |
pushFollowUp(PushFollowUpMessageReq req)
添加跟随气泡,调用该接口在最新一条消息下方添加气泡样式的内容,当消息接收者点击气泡或者新消息到达后,气泡消失。
|
PushFollowUpMessageResp |
pushFollowUp(PushFollowUpMessageReq req,
RequestOptions reqOptions)
添加跟随气泡,调用该接口在最新一条消息下方添加气泡样式的内容,当消息接收者点击气泡或者新消息到达后,气泡消失。
|
ReadUsersMessageResp |
readUsers(ReadUsersMessageReq req)
消息发送者查询消息已读状态,作为消息发送者,查询指定消息是否已读。
|
ReadUsersMessageResp |
readUsers(ReadUsersMessageReq req,
RequestOptions reqOptions)
消息发送者查询消息已读状态,作为消息发送者,查询指定消息是否已读。
|
ReplyMessageResp |
reply(ReplyMessageReq req)
回复消息,调用该接口回复指定消息。
|
ReplyMessageResp |
reply(ReplyMessageReq req,
RequestOptions reqOptions)
回复消息,调用该接口回复指定消息。
|
SearchMessageResp |
search(SearchMessageReq req)
搜索消息,用户可以通过关键字搜索可见消息,可见性和套件内搜索一致。
|
SearchMessageResp |
search(SearchMessageReq req,
RequestOptions reqOptions)
搜索消息,用户可以通过关键字搜索可见消息,可见性和套件内搜索一致。
|
UpdateMessageResp |
update(UpdateMessageReq req)
编辑消息,调用该接口编辑已发送的消息内容,支持编辑文本、富文本消息。
|
UpdateMessageResp |
update(UpdateMessageReq req,
RequestOptions reqOptions)
编辑消息,调用该接口编辑已发送的消息内容,支持编辑文本、富文本消息。
|
UrgentAppMessageResp |
urgentApp(UrgentAppMessageReq req)
发送应用内加急,调用该接口把指定消息加急给目标用户,加急仅在飞书客户端内通知。
|
UrgentAppMessageResp |
urgentApp(UrgentAppMessageReq req,
RequestOptions reqOptions)
发送应用内加急,调用该接口把指定消息加急给目标用户,加急仅在飞书客户端内通知。
|
UrgentPhoneMessageResp |
urgentPhone(UrgentPhoneMessageReq req)
发送电话加急,调用该接口把指定消息加急给目标用户,加急将通过飞书客户端和电话进行通知。
|
UrgentPhoneMessageResp |
urgentPhone(UrgentPhoneMessageReq req,
RequestOptions reqOptions)
发送电话加急,调用该接口把指定消息加急给目标用户,加急将通过飞书客户端和电话进行通知。
|
UrgentSmsMessageResp |
urgentSms(UrgentSmsMessageReq req)
发送短信加急,调用该接口把指定消息加急给目标用户,加急将通过飞书客户端和短信进行通知。
|
UrgentSmsMessageResp |
urgentSms(UrgentSmsMessageReq req,
RequestOptions reqOptions)
发送短信加急,调用该接口把指定消息加急给目标用户,加急将通过飞书客户端和短信进行通知。
|
public Message(Config config)
public CreateMessageResp create(CreateMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=message&version=v1 ;
Exceptionpublic CreateMessageResp create(CreateMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=create&project=im&resource=message&version=v1 ;
Exceptionpublic DeleteMessageResp delete(DeleteMessageReq 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)内。;- 撤回群组内的消息时,机器人需要在该群组中。;;;## 使用限制;- 无法撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息,撤回该接口发送的消息需要使用[批量撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete)接口。;- 撤回的消息需要符合由企业管理员设置的撤回时限。详情了解[管理员设置撤回和编辑消息权限](https://www.feishu.cn/hc/zh-CN/articles/325339752183)。;- 在群聊内的机器人如需撤回他人发送的消息,则该机器人必须是该群的群主、管理员或者创建者,且消息发送时间不超过 1 年。; ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=message&version=v1 ;
Exceptionpublic DeleteMessageResp delete(DeleteMessageReq 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)内。;- 撤回群组内的消息时,机器人需要在该群组中。;;;## 使用限制;- 无法撤回通过[批量发送消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口发送的消息,撤回该接口发送的消息需要使用[批量撤回消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/delete)接口。;- 撤回的消息需要符合由企业管理员设置的撤回时限。详情了解[管理员设置撤回和编辑消息权限](https://www.feishu.cn/hc/zh-CN/articles/325339752183)。;- 在群聊内的机器人如需撤回他人发送的消息,则该机器人必须是该群的群主、管理员或者创建者,且消息发送时间不超过 1 年。; ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=delete&project=im&resource=message&version=v1 ;
Exceptionpublic ForwardMessageResp forward(ForwardMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=forward&project=im&resource=message&version=v1 ;
Exceptionpublic ForwardMessageResp forward(ForwardMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=forward&project=im&resource=message&version=v1 ;
Exceptionpublic GetMessageResp get(GetMessageReq 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=get&project=im&resource=message&version=v1 ;
Exceptionpublic GetMessageResp get(GetMessageReq 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=get&project=im&resource=message&version=v1 ;
Exceptionpublic ListMessageResp list(ListMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=im&resource=message&version=v1 ;
Exceptionpublic ListMessageResp list(ListMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=list&project=im&resource=message&version=v1 ;
Exceptionpublic MergeForwardMessageResp mergeForward(MergeForwardMessageReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic MergeForwardMessageResp mergeForward(MergeForwardMessageReq req) throws Exception
Exceptionpublic PatchMessageResp patch(PatchMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=patch&project=im&resource=message&version=v1 ;
Exceptionpublic PatchMessageResp patch(PatchMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=patch&project=im&resource=message&version=v1 ;
Exceptionpublic PushFollowUpMessageResp pushFollowUp(PushFollowUpMessageReq req, RequestOptions reqOptions) throws Exception
;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 跟随气泡的效果在飞书客户端 v7.20 及以上版本生效。;- 仅支持在当前机器人与用户单聊的消息上添加跟随气泡,且消息需要符合:;; - 消息是机器人发送的。; - 消息是会话内最新的消息。; - 消息发送后未超过 600 秒。;;## 注意事项;;添加跟随气泡后,会话内的用户点击气泡会自动转换为该用户发送的一条消息,你可以为应用订阅[接收消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive)事件,接收用户发送的消息并判断是否为跟随气泡的内容。 ;
Exceptionpublic PushFollowUpMessageResp pushFollowUp(PushFollowUpMessageReq req) throws Exception
;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)。;- 跟随气泡的效果在飞书客户端 v7.20 及以上版本生效。;- 仅支持在当前机器人与用户单聊的消息上添加跟随气泡,且消息需要符合:;; - 消息是机器人发送的。; - 消息是会话内最新的消息。; - 消息发送后未超过 600 秒。;;## 注意事项;;添加跟随气泡后,会话内的用户点击气泡会自动转换为该用户发送的一条消息,你可以为应用订阅[接收消息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/message/events/receive)事件,接收用户发送的消息并判断是否为跟随气泡的内容。 ;
Exceptionpublic ReadUsersMessageResp readUsers(ReadUsersMessageReq req, RequestOptions reqOptions) throws Exception
## 前提条件;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 查询消息已读信息时,机器人需要在待查询消息所在的会话内。;;## 使用限制;- 只能查询由当前机器人自己发送的、发送时间不超过 7 天的消息已读信息。;- 一次请求只能查询一条消息,不支持批量查询。 ;
Exceptionpublic ReadUsersMessageResp readUsers(ReadUsersMessageReq req) throws Exception
## 前提条件;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 查询消息已读信息时,机器人需要在待查询消息所在的会话内。;;## 使用限制;- 只能查询由当前机器人自己发送的、发送时间不超过 7 天的消息已读信息。;- 一次请求只能查询一条消息,不支持批量查询。 ;
Exceptionpublic ReplyMessageResp reply(ReplyMessageReq 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)内。;- 回复群消息时,机器人需要在群中,且拥有发言权限。;;## 使用限制;为避免消息发送频繁对用户造成打扰,向同一用户发送消息的限频为 ==5 QPS==、向同一群组发送消息的限频为群内机器人共享 ==5 QPS==。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=reply&project=im&resource=message&version=v1 ;
Exceptionpublic ReplyMessageResp reply(ReplyMessageReq 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)内。;- 回复群消息时,机器人需要在群中,且拥有发言权限。;;## 使用限制;为避免消息发送频繁对用户造成打扰,向同一用户发送消息的限频为 ==5 QPS==、向同一群组发送消息的限频为群内机器人共享 ==5 QPS==。 ;
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=reply&project=im&resource=message&version=v1 ;
Exceptionpublic SearchMessageResp search(SearchMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=search&project=im&resource=message&version=v1 ;
Exceptionpublic SearchMessageResp search(SearchMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=search&project=im&resource=message&version=v1 ;
Exceptionpublic UpdateMessageResp update(UpdateMessageReq req, RequestOptions reqOptions) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=update&project=im&resource=message&version=v1 ;
Exceptionpublic UpdateMessageResp update(UpdateMessageReq req) throws Exception
官网API文档链接:https://open.feishu.cn/api-explorer?from=op_doc_tab&apiName=update&project=im&resource=message&version=v1 ;
Exceptionpublic UrgentAppMessageResp urgentApp(UrgentAppMessageReq req, RequestOptions reqOptions) throws Exception
Exceptionpublic UrgentAppMessageResp urgentApp(UrgentAppMessageReq req) throws Exception
Exceptionpublic UrgentPhoneMessageResp urgentPhone(UrgentPhoneMessageReq req, RequestOptions reqOptions) throws Exception
**注意**:电话加急将消耗企业的加急额度(可通过[管理后台](https://admin.feishu.cn/) > **费用中心** > **权益数据** > **短信/电话加急** 查看当前额度),请慎重调用。;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 确保机器人在被加急消息所属会话中。如果是群组,还需要确保群管理中设置了 **所有群成员可以加急**,或者设置了 **仅群主或管理员可以加急** 且机器人是管理员。;;## 使用限制;;- 只能加急当前机器人自己发送的消息。;- 加急用户的未读加急总数不能超过 200 条。;- 不支持加急[批量发送的消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)。;- 加急[折叠会话](https://www.feishu.cn/hc/zh-CN/articles/360025267393)内的消息时,仅会在应用内推送提醒通知。 ;
Exceptionpublic UrgentPhoneMessageResp urgentPhone(UrgentPhoneMessageReq req) throws Exception
**注意**:电话加急将消耗企业的加急额度(可通过[管理后台](https://admin.feishu.cn/) > **费用中心** > **权益数据** > **短信/电话加急** 查看当前额度),请慎重调用。;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 确保机器人在被加急消息所属会话中。如果是群组,还需要确保群管理中设置了 **所有群成员可以加急**,或者设置了 **仅群主或管理员可以加急** 且机器人是管理员。;;## 使用限制;;- 只能加急当前机器人自己发送的消息。;- 加急用户的未读加急总数不能超过 200 条。;- 不支持加急[批量发送的消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)。;- 加急[折叠会话](https://www.feishu.cn/hc/zh-CN/articles/360025267393)内的消息时,仅会在应用内推送提醒通知。 ;
Exceptionpublic UrgentSmsMessageResp urgentSms(UrgentSmsMessageReq req, RequestOptions reqOptions) throws Exception
**注意**:短信加急将消耗企业的加急额度(可通过[管理后台](https://admin.feishu.cn/) > **费用中心** > **权益数据** > **短信/电话加急** 查看当前额度),请慎重调用。;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 确保机器人在被加急消息所属会话中。如果是群组,还需要确保群管理中设置了 **所有群成员可以加急**,或者设置了 **仅群主或管理员可以加急** 且机器人是管理员。;;## 使用限制;;- 只能加急当前机器人自己发送的消息。;- 加急用户的未读加急总数不能超过 200 条。;- 不支持加急[批量发送的消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)。;- 加急[折叠会话](https://www.feishu.cn/hc/zh-CN/articles/360025267393)内的消息时,仅会在应用内推送提醒通知。 ;
Exceptionpublic UrgentSmsMessageResp urgentSms(UrgentSmsMessageReq req) throws Exception
**注意**:短信加急将消耗企业的加急额度(可通过[管理后台](https://admin.feishu.cn/) > **费用中心** > **权益数据** > **短信/电话加急** 查看当前额度),请慎重调用。;;## 前提条件;;- 应用需要开启[机器人能力](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability) 。;- 确保机器人在被加急消息所属会话中。如果是群组,还需要确保群管理中设置了 **所有群成员可以加急**,或者设置了 **仅群主或管理员可以加急** 且机器人是管理员。;;## 使用限制;;- 只能加急当前机器人自己发送的消息。;- 加急用户的未读加急总数不能超过 200 条。;- 不支持加急[批量发送的消息](https://open.feishu.cn/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)。;- 加急[折叠会话](https://www.feishu.cn/hc/zh-CN/articles/360025267393)内的消息时,仅会在应用内推送提醒通知。 ;
ExceptionCopyright © 2026. All rights reserved.