# Send a one-time subscription message
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 Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
access_token | string | yes | ACCESS_TOKEN | Interface invocation credentials, using access_token , authorizer_access_token |
# Request BodyRequest Payload
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
touser | string | yes | OPENID | The user receiving the message openid |
template_id | string | yes | TEMPLATE_ID | Subscribe Message Template ID |
url | string | no | https://example.com | Click on the message jump link (ICP filing required) |
miniprogram | object | no | - | Jump Weixin Mini Program Configuration |
scene | string | yes | 1000 | Subscription scenario value |
title | string | yes | Subscribe to Notifications | Message Title (15 words or less) |
data | object | yes | - | Message content |
# Body.miniprogramObject Payload
Jump Weixin Mini Program Configuration
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
appid | string | yes | xiaochengxuappid12345 | Weixin Mini Program AppID |
pagepath | string | yes | index?foo=bar | Weixin Mini Program Page path |
# Body.dataObject Payload
Message content
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
content | object | no | Content Information |
# Body.data.contentObject Payload
Content Information
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
value | string | no | Hello! | Message Text (200 words in) |
color | string | no | #FF0000 | Font color |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error message |
# 4. Note
- 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 code | Error Description | Solutions |
---|---|---|
-1 | system error | The system is busy, so the developer is asked to try again in a few minutes. |
0 | ok | success |
40001 | invalid credential access_token isinvalid or not latest | AppSecret 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 |
40003 | invalid openid | Invalid OpenID. Please confirm if the OpenID is following Official Account, or if it is another OpenID from the Official Account message template. |
40013 | invalid appid | Invalid AppID |
40037 | invalid template_id | Invalid template ID |
40062 | invalid title size |
# 7. Scope of application
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;