SDK对接文档

主题

订阅接口 ​

介绍 ​

是否是渠道必接：可选

基于微信的通知渠道，我们为开发者提供了可以高效触达用户的订阅消息能力，以便实现服务的闭环并提供更佳的体验。

开发者在游戏内，可向用户发起消息订阅。开发者需后台自行记录用户是否订阅成功及订阅成功的次数。

用户在小游戏中订阅指定的消息内容后，开发者可以在后台通过下发消息的 api 把一条模版消息发送给用户，用户最终在微信的“服务通知”中收到。开发者可通过场景值（1014）区分从模版消息进入游戏的用户。

用户成功订阅一次，开发者可在游戏认为场景合适的时机，向该用户发下一条模版消息。

功能简介 ​

接口整合到小游戏公共库统一代码风格，减少理解成本和接入成本

对应功能截图 ​

接入 ​

接入流程 ​

1. 游戏更新提醒 ​

调用指定接口即可调起微小的订阅消息弹窗。

只有第一次会调起弹窗，其他时候只会根据用户对消息提醒的设置返回对应的bool值

sql
ZMYSDKManager.I.Sdk.SubGameUpdateTip(((bool success) =>
{
    LogUI.Log("订阅结果：" + success);
}));

2. 自定义消息订阅 ​

调用指定接口订阅运营配置好的消息模板，需要提前在微小后台配置好

sql
ZMYSDKManager.I.Sdk.RequestSubscribe("消息模板ID");

3. 自定义消息模板在微信后台配置方法 ​

不需要研发配置，发布在渠道后台配置。但是需要了解，方便沟通和调试

  1. 在微信后台配置消息模板

  • 根据配置的消息模板内容填写配置信息

（1）keyword在左侧找到，messageStruct在右侧

（2）sendTime或者id填写不太清楚填写规则的话 可以询问下服务器同学

json
{
    "appId": "wx2607dd9e747bdc66",
    "createTime": "",
    "id": 1,
    "keyword1": "2023-8-1",
    "keyword2": "12:12",
    "keyword3": "提示",
    "keyword4": "某某",
    "keyword5": "好玩的",
    "messageStruct": "date3,time4,thing5,thing6,thing7",
    "modifyTime": "",
    "sendTime": "0 12 12 * * ?",
    "status": 0,
    "templateId": "U-o7olDqDvKdfrVJDK1SF45WvplDAONiEXriCHNRQTg",
    "userType": 1
}
  • demo项目的配置参考

通过http post的形式，向微信的api发送 以下json传，来更新推送的时间。，每条推送，一个send。

https://minigame.weplaybubble.com/MiniGameServer/subMessage/update

json
//update
{
    "appId": "wx2607dd9e747bdc66",
    "createTime": "",
    "id": 1,
    "keyword1": "紫色装备、稀有战机和僚机。",
    "keyword2": "登录游戏即可领取签到奖励。",
    "keyword3": "登录游戏即可领取。",
    "messageStruct": "thing3,thing8,thing5",
    "modifyTime": "",
    "sendTime": "0 0 12 * * ?",
    "status": 0,
    "templateId": "3IP1vWr8ACw5jNCOItU_ArAXEiS2rGb6K0YldZs1OiQ",
    "userType": 1
}

//update
{
    "appId": "wx2607dd9e747bdc66",
    "createTime": "",
    "id": 2,
    "keyword1": "2023-4-28",
    "keyword2": "10:00",
    "keyword3": "新战机上线，操作乐趣提高",
    "keyword4": "全新版本 射击与闪躲 已上线，多样化战机和僚机已更新。",
    "keyword5": "新上线8款战机和8款僚机；新增无尽rogue割草玩法",
    "messageStruct": "date3,time4,thing5,thing6,thing7",
    "modifyTime": "",
    "sendTime": "0 35 10 * * ?",
    "status": 0,
    "templateId": "U-o7olDqDvKdfrVJDK1SF45WvplDAONiEXriCHNRQTg",
    "userType": 1
}

//update
{
    "appId": "wx2607dd9e747bdc66",
    "createTime": "",
    "id": 3,
    "keyword1": "海量金币和经验，稀有材料及装备。",
    "keyword2": "您的离线收益已满，赶紧上线领取吧。",
    "messageStruct": "thing5,thing4",
    "modifyTime": "",
    "sendTime": "0 0 9 * * ?",
    "status": 0,
    "templateId": "yogetwnOsWoUsnhtupnW7WcDF8jwxTC1DcP_ez7TphY",
    "userType": 1
}

//save
{
    "appId": "wx2607dd9e747bdc66",
    "createTime": "",
    "id": 4,
    "keyword1": "终生免广告功能",
    "keyword2": "领取卡包后即可终生免广告。",
    "keyword3": "一次购买，终生受用。",
    "messageStruct": "phrase1,thing2,thing4",
    "modifyTime": "",
    "sendTime": "0 0 18 * * ?",
    "status": 0,
    "templateId": "CsnkEB1xxm0UZAc9SFUXTuUuACkAkhwkC6EOGwUb2Iw",
    "userType": 1
}

注意 ​

申请弹窗只会弹出一次！后续需要在 设置->通知管理 里面设置开关状态

自测 ​

  1. 打包后在真机预览中，确认能否调起微小的订阅消息面板

  2. 确认订阅消息面板中的内容是否符合策划、运营的要求

点我快速对接