游戏内邮件接入说明文档

1. 接入必读

该文档主要包含游戏内邮件发送任务接收接口的定义，接入后可通过掌趣统一后台进行游戏内邮件推送；

2. 准备工作

1. 在掌趣MIS平台上创建需要接入邮件推送的产品和游戏服；
2. 在掌趣MIS平台配置统一的邮件推送任务接收地址（支持单个游戏服配置）；

   3. 接口说明

• 接口协议:HTTP POST;
• 交互数据格式:JSON格式（以UTF-8进行编码）; 数据直接通过HTTP消息体传输（非KEY-VALUE模式）;

4. 接口

4.1 游戏内邮件发送任务接收接口

该接口主要实现：统一由掌趣后台提交游戏内邮件发送任务至游戏服， 发送任务由掌趣后台管理，通过调用该接口通知各个游戏服进行发送给具体玩家； 发送规则需要支持邮件有效期、 按角色等级范围、 按角色VIP等级范围、 按角色列表 的方式进行发送；

• 4.1.1 接口地址
  该接口由游戏服按接口规范实现， 提供接口地址给运营人员进行配置；

• 4.1.2 请求参数

• 4.1.3 返回参数

• 4.1.4 请求示例

  {
  　　"attachment":"[{\"propId\":\"1\",\"propNum\":\"10\",\"customParam\":\"扩展数据\"},{\"propId\":\"4\",\"propNum\":\"10\",\"customParam\":\"扩展数据2\"}]",
  　　"beginTime":1522512000000,
  　　"content":"祝游戏愉快",
  　　"emailId":"8a838ab3628af06401628ea790b30003",
  　　"endTime":1525017600000,
  　　"serverId":"1010",
  　　"roleLevel":"1-20",
  　　"roleVipLevel":"1-19",
  　　"roles":"",
  　　"subject":"发送邮件",
  　　"checkSum":"935AFF72B50B79007D664AB223EF9829"
  }

• 4.1.5 返回示例

  {
    "status":"0",
    "desc":"成功",
    "reset":"000"
  }

  4.2 游戏内邮件撤回接口

  该接口主要实现：统一由掌趣后台提交游戏邮件撤回任务至游戏服， 发送任务由掌趣后台管理，通过调用该接口通知各个游戏服进行游戏邮件撤回操作； 发后时可通过emailId撤回上次发送的邮件。

• 4.2.1 接口地址
  该接口和游戏内邮件发送任务接收接口为同一个地址，只是请求参数会多加一个字段rollback,具体可参考请求示例。

• 4.2.2 请求参数

• 4.2.3 返回参数

• 4.2.4 请求示例

  {
  　　"attachment":"[{\"propId\":\"1\",\"propNum\":\"10\",\"customParam\":\"扩展数据\"},{\"propId\":\"4\",\"propNum\":\"10\",\"customParam\":\"扩展数据2\"}]",
  　　"beginTime":1522512000000,
  　　"content":"祝游戏愉快",
  　　"emailId":"8a838ab3628af06401628ea790b30003",
  　　"endTime":1525017600000,
  　　"serverId":"1010",
  　　"roleLevel":"1-20",
  　　"roleVipLevel":"1-19",
  　　"roles":"",
  　　"subject":"发送邮件",
  　　"checkSum":"935AFF72B50B79007D664AB223EF9829"
  }

• 4.2.5 返回示例

  {
    "status":"0",
    "desc":"成功",
    "reset":"000"
  }

附录一 （游戏邮件通知接口响应编码定义表）

附录二 （接口交互数据checkSum校验规则）

校验规则
参数(除checkSum外)按照字典顺序依次取值,如示例的json

{
　　"attachment":"[{\"propId\":\"1\",\"propNum\":\"10\",\"customParam\":\"扩展数据\"},{\"propId\":\"4\",\"propNum\":\"10\",\"customParam\":\"扩展数据2\"}]",
　　"beginTime":1522512000000,
　　"content":"祝游戏愉快",
　　"emailId":"8a838ab3628af06401628ea790b30003",
　　"endTime":1525017600000,
　　"roleLevel":"1-20",
　　"roleVipLevel":"1-19",
　　"roles":"",
       "serverId":"1010",
　　"subject":"发送邮件",
　　"checkSum":"4E0CA6F89D05FEB1F3804256E043A107"
}

需要校验的参数字符串为:
[{"propId":"1","propNum":"10","customParam":"扩展数据"},{"propId":"4","propNum":"10","customParam":"扩展数据2"}]1522512000000祝游戏愉快8a838ab3628af06401628ea790b3000315250176000001-201-191010发送邮件

最后需添加产品密钥(产品密匙可从MIS上获取),此处为测试密钥,如:12345453i1rm129rf2s8fy5j80ao0626

最后计算
MD5([{"propId":"1","propNum":"10","customParam":"扩展数据"},{"propId":"4","propNum":"10","customParam":"扩展数据2"}]1522512000000祝游戏愉快8a838ab3628af06401628ea790b3000315250176000001-201-191010发送邮件12345453i1rm129rf2s8fy5j80ao0626)

结果为:4E0CA6F89D05FEB1F3804256E043A107