服务端 API/消息/批量消息/查询批量消息整体进度
# 查询批量消息整体进度

该接口在[查询批量消息推送和阅读人数](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/batch_message/read_user)查询结果的基础上，增加了批量请求中有效的user id数量以及消息撤回进度数据。

**注意事项**：注意事项:
- 只能查询**30天内**通过[批量发送消息](https://open.larksuite.com/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)接口产生的消息
- 该接口返回的数据为查询时刻的快照数据

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.larksuite.com/open-apis/im/v1/batch_messages/:batch_message_id/get_progress
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.larksuite.com/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 给一个或多个部门的成员批量发消息(im:message:send_multi_depts)<br>给多个用户批量发消息(im:message:send_multi_users)

### 请求头

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

### 路径参数

名称 | 类型 | 描述
---|---|---
batch_message_id | string | 待查询的批量消息任务ID，通过调用[批量发送消息接口](	https://open.larksuite.com/document/ukTMukTMukTM/ucDO1EjL3gTNx4yN4UTM)的返回值`message_id`中得到<br>**示例值**："bm-0b3d5d1b2df7c6d5dbd1abe2c91e2217"

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
batch_message_send_progress | batch_message_send_progress | 消息发送进度
valid_user_ids_count | int | 批量请求中有效的userid数量(包含机器人不可见用户)<br>**注意**： <br>当valid_user_ids_count为0有两种情况：<br>* 批量任务还没有开始被调度（请等待一会再调用该接口）<br>* 批量发送消息时传入的所有openIDs、employeID、departmentiIDs都不包含有效的用户
success_user_ids_count | int | 已经成功给用户发送成功的消息数量<br>**注意**：最终success_user_ids_count不一定等于valid_user_ids_count, 因为valid_user_ids_count包含了对机器人不可见的用户
read_user_ids_count | int | 已读信息用户数量
batch_message_recall_progress | batch_message_recall_progress | 消息撤回进度
recall | boolean | 该条批量消息是否被执行过撤回操作
recall_count | int | 已经成功撤回的消息数量

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "batch_message_send_progress": {
            "valid_user_ids_count": 204,
            "success_user_ids_count": 200,
            "read_user_ids_count": 150
        },
        "batch_message_recall_progress": {
            "recall": true,
            "recall_count": 100
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 230001 | Your request contains an invalid request parameter. | 参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400 | 230006 | Bot ability is not activated. | [机器人能力](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-enable-bot-ability)未启用 。可在[开发者后台](https://open.larksuite.com/app) -> 应用能力 -> 添加应用能力页面添加机器人功能，发布新版本后生效。
400 | 230012 | Bot is NOT the sender of the message. | 机器人不是消息的发送者。
400 | 230027 | Lack of necessary permissions. | 请根据本文档中的权限要求部分补充所需权限。
400 | 230030 | The message id is invalid, record not found. | 检查传入的batch_message_id是否正确。