# Query intercepted template messages

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

QueryBlockTmplMsg

This interface is used to query intercepted template messages

# 1. How to call

# HTTPS calls

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

# Cloud Calls

  • This interface does not support cloud calls

# Third party invocation

  • This interface supports Third Party Platform generation business call.

  • This interface belongs to the permission set id: 7,100-101

  • When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

Parameter NametypeRequired to fill inExampleIntroductions
access_tokenstringyesACCESS_TOKENInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
tmpl_msg_idstringyesf9KbMio42Ks3kzLwPP1aDkl2k98avIFbPtdLJ_yY7QYIntercepted template message id
largest_idnumberyes0The largest id of the query results on the previous page, for turning pages, the first pass 0
limitnumberyes100Size of a single page query, maximum 100

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
errcodenumberError code
errmsgstringError message
msginfoobjectMessage Information

# Res.msginfoObject Payload

Message Information

Parameter NametypeIntroductions
idstringRecord unique ID, largest_id for multiple queries
tmpl_msg_idstringIntercepted template message id
titlestringThe title of the template message
contentstringThe content of a template message
send_timestampnumbertimestamp of the post
openidstringThe openid of the target user

# 4. Note

The maximum number of entries for a single page query is 100

# 5. Code examples

Example Requests

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

Return an example

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

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
0oksuccess

# 7. Scope of application

This interface supports "Service Account (authentication only)" account type calls.None of the other account types can be invoked without special instructions.