# 查询拦截的模板消息

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:queryBlockTmplMsg

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
tmpl_msg_idstringf9KbMio42Ks3kzLwPP1aDkl2k98avIFbPtdLJ_yY7QY被拦截的模板消息id
largest_idnumber0上一页查询结果最大的id,用于翻页,第一次传0
limitnumber100单页查询的大小,最大100

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
msginfoobject消息信息

# Res.msginfo Object Payload

消息信息

参数名类型说明
idstring记录唯一ID,用于多次查询的largest_id
tmpl_msg_idstring被拦截的模板消息id
titlestring模板消息的标题
contentstring模板消息的内容
send_timestampnumber下发的时间戳
openidstring下发目标用户的openid

# 4. 注意事项

单页查询的最大条数是100

# 5. 代码示例

请求示例

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

返回示例

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

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0ok成功

# 7. 适用范围

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