邮件相关

1. 发送全服邮件（分批）

1.1 说明
  • 运用于 GM系统-操作工具-邮件管理-添加&修改全服邮件
  • 该接口是分批请求接口，当渠道或游戏服数量大于1000，会以每批1000条进行发送
  • 有渠道或游戏服追加时，会增量请求
  • 注：在到达设定时间时才会调用此接口
1.2 请求方式
  • POST
  • Content-Type：application/x-www-form-urlencoded
1.3 请求参数
参数名 类型 长度 说明 是否必传
email_id string 64 邮件ID，最长64位，唯一 是
email_type int 1 邮件类型，固定为1，表示全服邮件 是
title string 50 邮件标题 是
sender string 50 发件人 否
content string，json格式 - 邮件内容，富文本json，参见“请求参数说明”关于富文本的说明 是
pid_deny_list string，json格式 - 角色id黑名单 否
channel_id_list string，json格式 - 多个渠道id，和游戏服id二选一 否
sid_list string，json格式 - 多个游戏服id，和渠道id二选一 否
prop_list string，json格式 - 可选，发送道具 否
batch_id string 64 批次id，唯一 是
send_time string - 发送时间，格式YYYY-MM-DD hh:mm:ss 是
end_time string - 失效时间，格式YYYY-MM-DD hh:mm:ss 否

pid_deny_list请求示例：

["aa","bb","cc"]

channel_id_list请求示例：

["1","2"]

sid_list请求示例：

["a111","a222"]

prop_list参数说明：

参数名 类型 长度 说明 是否必传
id string 50 道具id 是
num int 11 道具数量 是

prop_list请求示例：

[
    {
        "id": "xx",
        "num": 10
    },
    {
        "id": "yy",
        "num": 1
    }
]
1.4 返回参数

a 异步通知邮件发送结果，需要调用发送全服邮件回调接口（同一个请求同步返回和异步返回格式二选一）

{
    "status":1,
    "msg":"success",
    "data":{

    }
}

b 同步通知邮件发送结果（同一个请求同步返回和异步返回格式二选一）

{
    "status":1,
    "msg":"success",
    "data":{
         "list":[
            {"item_id":"aaaa","result":1,"note":""},
            {"item_id":"bbb","result":2,"note":"ID不存在"}
        ]
    }
}
参数名 类型 注释 是否必填
list array 发送结果列表，可选 是
list.item_id string 游戏服ID或者渠道ID 是
list.result int 发送情况，1成功 2失败 是
list.note string 备注，可为空 是

2. 发送角色邮件（分批）

2.1 说明
  • 运用于 GM系统-操作工具-邮件管理-添加&修改角色邮件
  • 该接口是分批请求接口，当角色数量大于1000，会以每批1000条进行发送
  • 注：在到达设定时间时才会调用此接口
2.2 请求方式
  • POST
  • Content-Type：application/x-www-form-urlencoded
2.3 请求参数
参数名 类型 长度 说明 是否必传
email_id string 64 邮件ID，最长64位，唯一 是
email_type int 1 邮件类型，固定为2，表示角色邮件 是
source int 1 来源，1-后台 2-礼包码 3-微信小游戏礼包 4-支付宝小游戏礼包 5-抖音小游戏礼包 6-华为小游戏礼包 是
exchange_id string 255 礼包码兑换记录id，source=2平台礼包回调接口需要传回，其它类型不需要。有传入时需要根据exchange_id做幂等，避免一次兑换多次发送邮件。 否
title string 50 邮件标题 是
sender string 50 发件人 否
content string，json格式 - 邮件内容，富文本json，参见“请求参数说明”关于富文本的说明，注意：微信小游戏礼包（source=3）、支付宝小游戏礼包（source=4）、抖音小游戏礼包（source=5）、华为小游戏礼包（source=6），不使用富文本方式解析，直接进行内容展示 是
sid string 32 服务器id，1、字段为可选参数，星云开放平台不进行预置，有需要自行新增自定义参数。2、微信礼包码下发道具邮件该字段有值，需要进行校验 否
pid_list string，json格式 - 角色id列表 是
prop_list string，json格式 - 可选，发送道具列表 否
batch_id string 64 批次id，唯一 是
send_time string - 发送时间，格式YYYY-MM-DD hh:mm:ss 是
end_time string - 失效时间，格式YYYY-MM-DD hh:mm:ss 否

pid_list请求示例：

["aa","bb","cc"]

prop_list参数说明：

参数名 类型 长度 说明 是否必传
id string 50 道具id 是
num int 11 道具数量 是

prop_list请求示例：

[
    {
        "id": "xx",
        "num": 10
    },
    {
        "id": "yy",
        "num": 1
    }
]
2.4 返回参数

a 异步通知邮件发送结果，需要调用发送角色邮件回调接口（同一个请求同步返回和异步返回格式二选一）

{
    "status":1,
    "msg":"success",
    "data":{

    }
}

b 同步通知邮件发送结果（同一个请求同步返回和异步返回格式二选一）

{
    "status":1,
    "msg":"success",
    "data":{
         "list":[
            {"pid":"aaaa","result":1,"note":""},
            {"pid":"bbb","result":2,"note":"ID不存在"}
        ]
    }
}
参数名 类型 注释 是否必填
list array 发送结果列表，可选 是
list.pid string 角色id 是
list.result int 发送情况，1成功 2失败 是
list.note string 备注，可为空 是

3. 撤回邮件

3.1 说明
  • 运用于 GM系统-操作工具-邮件管理-撤回全服邮件&角色邮件
  • 注：在-撤回全服邮件&角色邮件调用此接口，道具是否撤回由接入方自行处理
3.2 请求方式
  • POST
  • Content-Type：application/x-www-form-urlencoded
3.3 请求参数
参数名 类型 长度 说明 是否必传
email_id string 64 邮件ID，最长64位，唯一 是
email_type int 1 邮件类型，1全服邮件 2角色邮件 是
3.4 返回参数
  • 响应示例：
{
    "status":1,
    "msg":"success",
    "data":{

    }
}
文章目录