# 查询邮件撤回进度

查询指定邮件的撤回结果详情，包括整体撤回进度、成功/失败/处理中的收件人数量，以及每个收件人的撤回状态和失败原因。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/messages/:message_id/recall
HTTP Method | GET
接口频率限制 | [20 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查询用户邮件(mail:user_mailbox.message:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
user_mailbox_id | string | 用户邮箱地址，作为用户邮箱身份标识，最大长度 255 字符。使用 user_access_token 调用时，可使用占位符 `me` 表示当前授权用户的主邮箱。<br>**示例值**："user@example.com"
message_id | string | 需要查询撤回结果的邮件 ID。可通过撤回已发送邮件接口中使用的邮件 ID 获取。<br>**示例值**："om_6f8c3b2d4a9e1f0c"

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
recall_status | string | 整体撤回进度<br>**可选值有**：<br>- in_progress：邮件撤回中<br>- done：邮件撤回结束
recall_result | string | 撤回最终结果，仅recall_status为done时有意义<br>**可选值有**：<br>- all_success：邮件已撤回<br>- all_fail：邮件撤回失败<br>- some_fail：部分撤回失败<br>- processing：邮件撤回中
success_count | int | 撤回成功的收件人数
failure_count | int | 撤回失败的收件人数
processing_count | int | 处理中的收件人数
items | recall_detail_item\[\] | 每个收件人的撤回详情列表
recipient_address | string | 收件人邮箱地址
recipient_name | string | 收件人显示名称
status | string | 该收件人的撤回状态<br>**可选值有**：<br>- success：撤回成功<br>- fail：撤回失败<br>- processing：处理中
fail_reason | string | 撤回失败原因，仅status为fail时有值<br>**可选值有**：<br>- message_has_been_read：邮件已读<br>- not_using_lark_mail：不支持撤回发往外部的邮件<br>- not_in_the_same_tenant：收件人域名为外部域名<br>- invalid_address：地址已失效<br>- unknown：其他原因
is_mailing_list | boolean | 是否为邮件组地址
mailing_list_success_count | int | 邮件组内成功撤回人数，仅is_mailing_list为true时有值
mailing_list_failure_count | int | 邮件组内撤回失败人数，仅is_mailing_list为true时有值
mailing_list_finish_percent | int | 邮件组完成百分比0-100，仅is_mailing_list为true时有值

### 响应体示例
```json
{"code":0,"msg":"success","data":{"recall_status":"done","recall_result":"all_success","success_count":3,"failure_count":0,"processing_count":0,"items":[{"recipient_address":"zhangsan@example.com","recipient_name":"张三","status":"success","is_mailing_list":false}]}}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1234008 | param is invalid | 参数不合法，请检查参数后重试
403 | 1230004 | permission denied: mailbox not found, unsupported mailbox type, or no access to this mailbox | 无权限访问：指定邮箱地址不存在，或传入了不支持的邮箱类型，或无权限访问此邮箱。请检查邮箱或权限后重试。
404 | 1234035 | recall record not found | 指定的撤回记录不存在，请检查参数后重试
500 | 1235000 | internal error | 服务器内部错误，请稍后重试；若仍报错，请携带 request_id 联系飞书技术支持：https://applink.feishu.cn/TLJpeNdW

