# 查询拦截的模板消息

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：queryBlockTmplMsg

本接口用于查询被拦截的模板消息

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/sec/queryblocktmplmsg?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：7、100-101

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "tmpl_msg_id",
    "类型": "string",
    "必填": "是",
    "示例": "f9KbMio42Ks3kzLwPP1aDkl2k98avIFbPtdLJ_yY7QY",
    "说明": "被拦截的模板消息id"
  },
  {
    "参数名": "largest_id",
    "类型": "number",
    "必填": "是",
    "示例": "0",
    "说明": "上一页查询结果最大的id，用于翻页，第一次传0"
  },
  {
    "参数名": "limit",
    "类型": "number",
    "必填": "是",
    "示例": "100",
    "说明": "单页查询的大小，最大100"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "msginfo",
    "类型": "object",
    "说明": "消息信息"
  }
]
```

### Res.msginfo `Object Payload`

消息信息

```json
[
  {
    "参数名": "id",
    "类型": "string",
    "说明": "记录唯一ID，用于多次查询的largest_id"
  },
  {
    "参数名": "tmpl_msg_id",
    "类型": "string",
    "说明": "被拦截的模板消息id"
  },
  {
    "参数名": "title",
    "类型": "string",
    "说明": "模板消息的标题"
  },
  {
    "参数名": "content",
    "类型": "string",
    "说明": "模板消息的内容"
  },
  {
    "参数名": "send_timestamp",
    "类型": "number",
    "说明": "下发的时间戳"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "下发目标用户的openid"
  }
]
```

## 4. 注意事项

单页查询的最大条数是100

## 5. 代码示例

请求示例

``` json
{
  "tmpl_msg_id": "f9KbMio42Ks3kzLwPP1aDkl2k98avIFbPtdLJ_yY7QY",
  "largest_id": 0,
  "limit": 100
}
```

返回示例

``` json
{
  "errcode": 0,
  "errmsg": "ok",
  "msginfo": {
    "id": 2,
    "tmpl_msg_id": "HFmHVgm58MAURBrS71k41100-MaDOWVdjAGaBrgLIls",
    "title": "测试标题",
    "content": "测试内容",
    "send_timestamp": 1788796187,
    "openid": "oxx6ZuPvZLe1VC-jdQSBPAGS-KUQ"
  }
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "成功"
  }
]
```

## 7. 适用范围

本接口支持「服务号（仅认证）」账号类型调用。其他账号类型如无特殊说明，均不可调用。