飞书 API

查询批量消息整体进度

GET

/open-apis/im/v1/batch_messages/{batch_message_id}/get_progress

自建应用商店应用

查询批量消息整体进度
注意事项:

该接口是查询批量消息推送和阅读人数接口的加强版

该接口返回的数据为查询时刻的快照数据

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，请根据接口返回的错误信息并参考文档检查输入参数。
400	230006	Bot ability is not activated.	机器人能力未启用。在开发者后台-应用功能-机器人页面开启机器人功能并发布上线。
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是否正确。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/im/v1/batch_messages/bm-0b3d5d1b2df7c6d5dbd1abe2c91e2217/get_progress' \
--header 'Authorization;'

响应示例

{
    "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
        }
    }
}

请求参数

Path 参数

batch_message_id

string

必需

待查询的批量消息的ID 示例值："bm-0b3d5d1b2df7c6d5dbd1abe2c91e2217"

示例值:

bm-0b3d5d1b2df7c6d5dbd1abe2c91e2217

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

batch_message_send_progress

object

消息发送进度

必需

batch_message_recall_progress

object

消息撤回进度

必需

查询批量消息推送和阅读人数

上传图片

查询批量消息整体进度

错误码#

请求参数

返回响应

错误码