WeChat Mini Game Subscribe Messages

Introduction to the Subscribe Message Feature

#

Official documentation: https://developers.weixin.qq.com/minigame/dev/guide/open-ability/subscribe-message.html

In WeChat Mini Games / WeChat Mini Programs, after a user subscribes to messages, actively pushed messages will be delivered to the user via the “Service Notifications” channel.

There are three types of subscribe messages: one-time subscribe messages, social interaction reminders, and game update reminders.

One-Time Subscribe Messages

#

Client Side

#

Subscribe to Messages

#

Official documentation: https://developers.weixin.qq.com/minigame/dev/api/open-api/subscribe-message/wx.requestSubscribeMessage.html

// In mini games, this can only be used normally within the callbacks of the following APIs,
// i.e., in response to a user's tap action:
wx.onTouchEnd
wx.showModal
wx.showActionSheet

Note: For one-time subscribe messages, after subscribing once (i.e., calling wx.requestSubscribeMessage() once), the user can only receive one message (i.e., the cumulative number of receivable messages +1).

To push multiple messages, developers have the following two options:

Option 1: Guide players to check “Always keep the above choice, don’t ask again”, and silently trigger the subscription via the relevant button on each login.

Option 2: Explicitly add a button to increase the subscribe count. When the user taps the button, the subscribe count can be increased (refer to the WeChat Mini Program: Huyou).

Query Subscribe Message Status

#

Official documentation: https://developers.weixin.qq.com/minigame/dev/api/open-api/setting/wx.getSetting.html

wx.getSetting()
// Pass withSubscriptions to also obtain the user's subscribe message status.
// Note: It only returns subscribe messages for which the user has checked
// "Always keep the above choice, don't ask again" in the subscription panel.

Server Side

#

Send Subscribe Messages

#

Official documentation: https://developers.weixin.qq.com/minigame/dev/api-backend/subscribe-message/api_sendmessage.html

Interface query parameter (required): access_token, the API call credential.

Request body parameters:

Error Codes

#

Recommended Solution

#

Maintain User Subscribe Status

#

1. The server only maintains the subscribe count of each user for different template messages.

The server provides two APIs to the client:

1. Subscribe success report (subscribe count +1), reported when the client successfully subscribes to messages.

2. Refuse message report (reset subscribe count to zero), reported when the client queries the subscribe message status and finds the “subscribe message master switch is off” or the “subscribe status has changed to refuse”.

After turning off the subscribe message master switch in the WeChat Mini Game settings, or refusing a certain subscribe message template, the cumulative subscribe count for that template will be reset to zero.

Send Messages

#

1. Validate the template parameter specifications.

2. Validate the subscribe count.

3. Deduct the subscribe count after a successful send.

WeChat APIs

#

openid — Unique User Identifier (independent per mini game / mini program)

#

How to obtain: After the client calls login() to obtain a code, pass it to the server which calls code2Session() to obtain it.

Official documentation: https://developers.weixin.qq.com/minigame/dev/api/open-api/login/wx.login.html

API Call Credential access_token

#

Official documentation: https://developers.weixin.qq.com/doc/oplatform/developers/dev/AccessToken.html

There are two APIs to obtain the access_token API call credential; the stable version interface is recommended. Call the API with appid and secret to obtain the access_token. The access_token is valid for 2 hours and needs to be refreshed periodically. Repeatedly calling the stable version interface within the validity period will not update the access_token (no forced refresh). If a forced refresh is needed, you can include the force_refresh parameter; the minimum interval for a forced refresh is 30s.

Encapsulated SDK

#

GitHub repository: https://github.com/muzimu/wechat-sdk

Basic usage:

import (
    "github.com/muzimu/wechat-sdk/cache"
    "github.com/muzimu/wechat-sdk/client"
    "github.com/muzimu/wechat-sdk/config"
    "github.com/muzimu/wechat-sdk/subscribe"
)

func main() {
    // Create configuration
    cfg := &config.Config{
        AppID:     "your_app_id",
        AppSecret: "your_app_secret",
        Cache:     cache.NewMemory(), // Use the built-in in-memory cache
    }

    // Create client
    cli := client.NewClient(cfg)
    sub := cli.GetSubscribe()

    // Send subscribe message
    msg := &subscribe.Message{
        ToUser:     "user_openid",
        TemplateID: "template_id",
        Page:       "pages/index/index",
        Data: map[string]*subscribe.DataItem{
            "thing1":  {Value: "Order content"},
            "amount2": {Value: "100.00"},
        },
    }

    err := sub.Send(msg)
    if err != nil {
        // Handle error
    }
}