推送订阅消息

业务场景

  1. 用户离线时长达到 N 小时（比如：3小时），才开始推送消息数据
  2. 目前适用的小游戏，包括但不限：微信小游戏、支付宝小游戏、抖音小游戏

注意事项

  1. 完整的请求地址，需要游戏服务端拼接
  2. 接口限流：当前 QPS 是 100/s

流程图

接口地址

https://cp.gzxianc.com/user/v1/offline/push/{appId}/{channelId}

Path参数：

字段类型必需参与签名说明
appIdlong是否游戏包中SDK实际使用的appId
channelIdlong是否游戏包中SDK实际使用的渠道Id

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
openIdstring是是SDK用户唯一标识
templateIdstring是是模板id
templateParamstring是是模板参数 , 格式:{"字段名":"字段值"}
offlineTimestring否不一定离线时间，格式：yyyy-MM-dd HH:mm:ss
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码
msgstring是响应描述

请求示例

{
        "openId": "12345678912345678912345",
        "templateId": "241120171000934136579",
        "templateParam": "{\"温馨提示\":\"某某奖励未领取\",\"离线收益\":\"某某收益已满\"}",
        "offlineTime": "2022-06-01 10:20:45",
        "timestamp": 1654142913000,
        "sign": "48d9fc51c2052dbc97b0b5db9ca5a719"
}

响应示例

{
        "code": 0,
        "msg": "success"
}

签名规则

  1. 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
  2. 只有值为 null 和名为 sign 的键值对，才不参与签名
  3. 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接
  4. 将生成的签名与入参 sign 值作校验，验签忽略大小写
String sign = md5(k1=v1&k2=v2&k3=v3...&key=appKey);

调试示例

import cn.hutool.crypto.SecureUtil;

import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;

public class SignExample {

    public static String getMd5Sign(Map<String, Object> params, String appKey) {
        TreeMap<String, Object> sortedParams = new TreeMap(params);
        StringBuilder builder = new StringBuilder(512);
        sortedParams.forEach((k, v) -> {
            if (v != null) {
                builder.append(k).append("=").append(v).append("&");
            }
        });
        builder.append("key=").append(appKey);
        return SecureUtil.md5(builder.toString());
    }

    public static void main(String[] args) {
        String appKey = "AaBbCcDdEeFfGgHh";
        Map<String, Object> reqMap = new HashMap<>();
        reqMap.put("openId", "12345678912345678912345");
        reqMap.put("templateId", "241120171000934136579");
        reqMap.put("templateParam", "{\"温馨提示\":\"某某奖励未领取\",\"离线收益\":\"某某收益已满\"}");
        reqMap.put("offlineTime", "2022-06-01 10:20:45");
        reqMap.put("timestamp", 1654142913000L);
        System.out.println(String.format("消息签名:%s", getMd5Sign(reqMap, appKey)));
    }
}

状态码

状态码说明
0Success
11000参数为空
11001无效的参数
11002记录不存在
11003操作失败
11004无效的签名
11720用户未订阅该消息模板
11721消息推送模板不合法
31012系统繁忙，请稍后再试（被限流）