快应用消息开放 API 接口文档（服务端)

更新时间：

公共

推送超量说明

服务消息：

• 针对用户授权的一个模板消息，模板消息推送数量没有限制，只要用户允许授权即可推送，在消息有效期内只能发送一条（发送条数 1.1 版本会调整，针对个别行业开放授权一次推送多条。但不影响 1.0 版本的开发，只需后台配置即可）。
• 单次可授权最多 3 条模板。

订阅消息：

• 针对用户授权的一个模板消息，模板消息的订阅数量没有上限，且 CP 可配置推送消息的人群，在用户订阅下即可推送，单个用户 24 小时内不同模板消息发送总数量一天最多 5 条。
• 单次可授权最多 3 条模板。

vivo 服务器地址

tips：由于测试环境整个链路打通对CP来说比较繁琐，所以建议CP接入时直接对接线上环境

V订阅测试环境域名：jovi-msgcenter-test.vivo.com.cn

V订阅线上环境域名：jovi-msgcenter.vivo.com.cn

公共传入参数

HTTP Header 中（ 推送鉴权接口除外 ）。

全局公共返回码详解

对接完成上线前请一定在群里面跟我们开发确认几个线上参数：client_id、client_secret、在 rpk 的 manifest.json 文件钟添加的参数 appId 和 appKey。

接口定义

鉴权

获取 accesstoken 接口

接口说明

要想调用V订阅相关接口，任何接入方都要有个鉴权操作。其他接口 header 中必须携带该接口返回的参数 accessToken 。

注意:需要对 url 参数进行转义处理

限制：一天限制调用不超过 1000 次。

注意：GET请求需要对url参数进行转义处理，POST不需要 传入的参数 client_secret 需要 client_secret = URLEncoder.encode(client_secret,"utf-8") 一次

接口定义

模板消息推送

关键字长度限制；

一次性服务消息推送接口

接口说明

服务消息仅用于向用户发送重要的服务通知，只能用于符合其要求的服务场景中，如信用卡刷卡通知，商品购买成功通知等。不支持广告等营销类消息以及其它所有可能对用户造成骚扰的消息。

接口定义

内容消息推送接口

接口说明

内容消息用于向用户发送已经订阅的频道通知；

接口定义

长期服务消息推送接口

接口说明

长期服务消息用于发送需要持续推送服务状态的订单通知，如机票值机、延误、起飞等。不支持广告等营销类消息以及其它所有可能对用户造成骚扰的消息。

接口定义

事件回传配置

订阅解订阅事件回传

接口说明

用户触发订阅或者解订阅，服务器处理业务完成之后，能够将处理结果回传给开发者；

开发者需要在服务消息管理后台回传配置里配置

服务器地址：vivo 回传数据的服务器地址，HTTPS 访问

密钥：secretKey 数据签名算法需要的密钥；vivo 服务器会根据这个密钥对数据进行签名，开发者服务器根据密钥对签名进行校验；

ps：建议长度为 256 位的 AES 密钥

注意：这里会一次回传多条数据，但是只会使用第一条数据进行签名校验，也就是 CP 服务器收到回传之后也只需要使用第一条数据进行验签即可。

加密算法

相关代码

dto 为 list 报文第一个元素 ，调用 getCpSign 方法即可

public static String getCpSign(Map<String, Object> dto, Long timestamp, String scrit) {
StringBuilder sb = new StringBuilder();
    sb.append(converDto(dto)).append("&").append(scrit);
    String str1 = sb.toString();
    String str2 = getSHA256Str(str1);
    String toSignStr = getStringToSign(timestamp.toString(), str2);
    return sha256_HMAC(toSignStr, scrit);
}

private static String converDto(Map<String, Object> dto){
StringBuilder sb = new StringBuilder(dto.get("event").toString());
Collection array = (Collection)dto.get("templateIds");
for(Object tmpId:array){
    sb.append(tmpId);
}

return sb.append(dto.get("userId"))
    .append(dto.get("scene")).toString();
}

/***
 * 利用Apache的工具类实现SHA-256加密 并转小写
 * @param str 加密后的报文
 * @return
 */

private static String getSHA256Str(String str) {
    MessageDigest messageDigest;
    String encdeStr = "";
    try {
        messageDigest = MessageDigest.getInstance("SHA-256");
        byte[] hash = messageDigest.digest(str.getBytes("UTF-8"));
        encdeStr = Hex.encodeHexString(hash);
    } catch (NoSuchAlgorithmException e) {
        e.printStackTrace();
    } catch (UnsupportedEncodingException e) {
        e.printStackTrace();
    }
    return encdeStr.toLowerCase();
}

private static String getStringToSign(String timestamp, String sHA256Str) {
    return new StringBuilder(timestamp).append(sHA256Str).toString();
}

/**
 * sha256_HMAC加密
 * @param message 消息
 * @param secret  秘钥
 * @return 加密后字符串
 */
private static String sha256_HMAC(String message, String secret) {
    String hash = "";
    try {
        Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
        SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
        sha256_HMAC.init(secret_key);
        byte[] bytes = sha256_HMAC.doFinal(message.getBytes());
        hash = byteArrayToHexString(bytes);
    } catch (Exception e) {
        e.printStackTrace();
    }
    return hash;
}

/**
 * 将加密后的字节数组转换成字符串
 * @param b 字节数组
 * @return 字符串
 */

private static String byteArrayToHexString(byte[] b) {
    StringBuilder hs = new StringBuilder();
    String stmp;
    for (int n = 0; b != null && n < b.length; n++) {
        stmp = Integer.toHexString(b[n] & 0XFF);
        if (stmp.length() == 1) {
            hs.append('0');
        }
        hs.append(stmp);
    }
    return hs.toString().toLowerCase();