# Send a one-time subscription message

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

Interface name: templateSubscribe

Push subscription template messages to authorized WeChat users

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/cgi-bin/message/template/subscribe?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.

  • The permission set id to which the interface belongs is: 7

  • 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
touserstringyesOPENIDThe user receiving the message openid
template_idstringyesTEMPLATE_IDSubscribe Message Template ID
urlstringnohttps://example.comClick on the message jump link (ICP filing required)
miniprogramobjectno-Jump Weixin Mini Program Configuration
scenestringyes1000Subscription scenario value
titlestringyesSubscribe to NotificationsMessage Title (15 words or less)
dataobjectyes-Message content

# Body.miniprogramObject Payload

Jump Weixin Mini Program Configuration

Parameter NametypeRequired to fill inExampleIntroductions
appidstringyesxiaochengxuappid12345 Weixin Mini Program AppID
pagepathstringyesindex?foo=barWeixin Mini Program Page path

# Body.dataObject Payload

Message content

Parameter NametypeRequired to fill inIntroductions
contentobjectnoContent Information

# Body.data.contentObject Payload

Content Information

Parameter NametypeRequired to fill inExampleIntroductions
valuestringnoHello!Message Text (200 words in)
colorstringno#FF0000Font color

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
errcodenumberError code
errmsgstringError message

# 4. Note

  1. URL and miniprogram are not required fields, if not pass the template without jump;Weixin Mini Program Weixin Mini Program 2.The user has been concerned about Official Account Official Account message template session, not concerned about the current sent to the service notification

# 5. Code examples

Example Requests

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "miniprogram":{
    "appid":"xiaochengxuappid12345",
    "pagepath":"index?foo=bar"    
  },
  "scene": "1000",
  "title": "订阅通知",
  "data": {
    "content": {
      "value": "您好!",
      "color": "#FF0000"
    }
  }
}

Return an example

{
  "errcode": 0,
  "errmsg": "ok"
}

# 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
-1system errorThe system is busy, so the developer is asked to try again in a few minutes.
0oksuccess
40001invalid credential  access_token isinvalid or not latestAppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account
40003invalid openidInvalid OpenID. Please confirm if the OpenID is following Official Account, or if it is another OpenID from the Official Account message template.
40013invalid appidInvalid AppID
40037invalid template_idInvalid template ID
40062invalid title size

# 7. Scope of application

How this interface can be invoked under different account types:
Official Account Service Account Mobile App
Certification only Certification only
  • Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
  • ✔: The account can call this interface
  • Other account types that are not expressly stated may not be called on this interface without special instructions;