邮件发送通知

业务场景

通知CP服务端，在游戏内给指定角色发送无附件的邮件

注意事项

接口需要注意验签，防止恶意请求

接口地址

地址由CP提供

接口说明

  1. 协议：HTTPS
  2. 方式：POST
  3. ContentType：application/json;charset=utf-8
  4. 请求报文：
字段类型必需参与签名说明
gameIdlong是是SDK的项目ID(并非出包的appId)
serverIdstring是是游戏区服ID
roleIdstring是是游戏角色ID
mailTitlestring是是邮件标题
mailContentstring是是邮件内容
senderstring是是发送者
timestamplong是是毫秒时间戳
signstring是否签名
  1. 响应报文：
字段类型必需说明
codeint是响应状态码, 0代表成功
msgstring否响应描述

请求示例

{
	"gameId": 21573,
	"serverId": "40107",
	"roleId": "2700033751",
	"mailTitle": "邮件标题",
	"mailContent": "邮件内容",
	"sender": "发送者",
	"timestamp": "1654142913840",
	"sign": "02f371bf2c8d53b6f6eddc1646982a8d"
}

响应示例

{
	"code": 0,
	"msg": "成功"
}

签名规则

  1. 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
  2. 只有值为 null 和 参数名不参与签名 的键值对，才不参与签名
  3. 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接，再进行MD5计算
  4. 将生成的签名与入参 sign 值作校验，验签忽略大小写

调试示例

import cn.hutool.crypto.SecureUtil;
import com.alibaba.nacos.shaded.com.google.common.collect.Maps;

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

public class NotifyExample {

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

    public static void main(String[] args) {
        Map<String, Object> params = Maps.newLinkedHashMap();
        params.put("gameId", 21573L);
        params.put("serverId", "40107");
        params.put("roleId", "2700033751");
        params.put("mailTitle", "邮件标题");
        params.put("mailContent", "邮件内容");
        params.put("sender", "发送者");
        params.put("timestamp", 1654142913840L);
        String appKey = "AaBbCcDdEeFfGgHh";
        System.out.println(String.format("邮件签名:%s", getMd5Sign(params, appKey)));
    }
}

响应状态码

状态码说明
0成功
1000未知错误
1001验签失败
1002参数缺失
10001当前无法发邮件，需要重推
10002邮件重复推送
10003角色不存在