批量撤回消息

该接口用于撤回通过批量发送消息接口发送的消息。

前提条件

应用需要启用机器人能力。

使用限制

• 仅支持撤回通过批量发送消息接口发送的消息。如果你需要撤回单条消息，请使用撤回消息接口。
• 不支持撤回时间较久的消息。撤回的消息需要符合由企业管理员设置的撤回时限。详情了解管理员设置撤回和编辑消息权限。
• 该接口为异步接口，会有一定延迟。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/batch_messages/:batch_message_id
HTTP Method	DELETE
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:message:send_multi_depts 给一个或多个部门的成员批量发消息 im:message:send_multi_users 给多个用户批量发消息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
batch_message_id	string	待撤回的批量消息任务 ID，该 ID 为批量发送消息接口返回值中的message_id字段，用于标识一次批量发送消息请求。 示例值："bm-dc13264520392913993dd051dba21dcf"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "data": {},
    "msg": "ok"
}

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	230006	Bot ability is not activated.	应用未开启机器人能力。开启方式参见如何开启机器人能力。
400	230009	Message can only be recalled within one days.	消息发出时间过长，不能执行当前操作。撤回的消息需要符合由企业管理员设置的撤回时限。详情了解管理员设置撤回和编辑消息权限。
400	230026	No permission to recall this message.	机器人没有权限撤回该消息，只能撤回机器人自己发出的消息。
400	230027	Lack of necessary permissions.	无权进行本次操作。可能的原因有： 1. 缺少相应权限，可根据实际的错误信息进行排查。 2. 未检查到用户授权信息。 3. 如果需要机器人在外部群操作，则需要先为机器人开启对外共享能力，详情参见机器人支持外部群和外部用户单聊。
400	230030	The message id is invalid, record not found.	消息 ID 无效，未找到记录。你需要检查并传入正确的 batch_message_id 参数后重试。

更多错误码信息，参见通用错误码。