1 产品概述

邮件(Email Service)沉淀Kewail多年邮件服务技术和经验,帮助广大开发者快速灵活的接入高质量的通知和营销服务。

 
1. 总览

Kewail邮件推送(技术接入、邮件触发、邮件接口、邮件验证码)服务接入流程:

邮件推送服务接入流程

1.下载Demo(java/php)
    ↓
2.添加发信域名(测试阶段可直接跳过)
    ↓
3.添加发信地址(测试阶段可直接跳过)
    ↓
4.生成AccessKeys
    ↓
5.使用Demo或编写程序,测试发信
    ↓
6.购买投递量,正式使用

2. 注册Kewail账号

3. 进入控制台

1) 第一步,登录后台,创建Access Key,生成Access Key ID和Secret Access Key;用于调用接口和识别区分用户数据。

2) 第二步,添加发信域名,该域名为公用域名,用户绑定自己的域名后,生成自己专属的发件人。

3) 第三步,添加发信地址,添加发信地址后,收件人可以看到是你的发件地址。

4. 调用邮件接口

https://live.kewail.com/directmail/v1/singleSendMail
参数名称参数类型是否必填说明
accesskey String 用户控制台中对应的accesskey
random int 随机整数
参数名称参数类型是否必填说明
sig String 签名,用于校验用户的合法性;签名用SHA加密,加密的参数顺序为(secretkey=%s&random=%d&time=%d&fromEmail=%s)
time long unix时间
type int 邮件类型,0事务投递,其他值的为商业投递量,默认是0
fromEmail String 发送邮件地址,管理控制台中配置的发信地址(登陆后台查看发信地址)
needToReply boolean 是否显示回复邮件地址,如果为true是的时候,replyEmail必填,false的时候replyEmail可以为空
replyEmail String 回复邮件地址,如果为needToReply值true是的时候,replyEmail必填,false的时候replyEmail可以为空
toEmail String 接收邮件地址
subject String 邮件主题
htmlBody String 邮件正文
clickTrace String 数据跟踪功能 1 为打开邮件点击链接跟踪功能; 0 为关闭数据跟踪功能。该参数默认值为0。
readTrace String 数据跟踪功能 1 为打开阅读邮件跟踪功能; 0 为关闭数据跟踪功能。该参数默认值为0。
fromAlias String 发信人昵称
ext String 扩展字段

名称 类型 返回值
result int 返回结果码,0代表成功,其他值为失败,具体可以参考错误码
errmsg string 错误的信息,如果是成功则为OK
surplus int 剩余投递量
sequnceId string 成功返回唯一的序列,如果失败则为空

请求协议 HTTP POST
编码格式 UTF8

请求的样例如下: https://live.kewail.com/directmail/v1/singleSendMail?accesskey=5a780b410cf2ff9c8896cca6&random=104696
包体为json字符串
{
"sig": "D9544A3D290571425C8C5094542A76C2A19A84745F1DDFFA72F112A58E563517",
"ext": "",
"replyEmail": "xxxx@qq.com",
"fromAlias": "张三",
"htmlBody": "test email",
"needToReply": true,
"subject": "测试邮件",
"clickTrace": "0",
"readTrace": "0",
"time": 1519378109,
"type": 0,
"toEmail": "xxxxx@qq.com",
"fromEmail": "service@xxx.com"
}
 


错误码原因解决方案
0成功表示成功
500参数错误请核对传入的参数是否正确
1001accesskey非法请核对accesskey是否正确
1002用户不存在请核对accesskey是否是当前用户的
1003用户被禁止请联系客服
1004传入的参数不正确请核对参数是否正确
1005签名sig为空请查看sig是否正确
1006fromEmail值不正确请核对fromEmail的值,这个值必须是控制台配置好的发信地址
1007needToReply值不能为空needToReply需要传值
1008toEmail值不正确请填合法的email值
1009邮件主题不能为空请填写邮件主题
1010邮件内容不能为空请填写邮件内容
1011sig签名不正确请按照要求填写合适的签名
1012发送邮件的域名没有认证成功请登录系统控制台进行认证域名,如果不懂可联系客服解决
1013fromEmail 没有认证成功请登录系统控制台进行认证
1014邮件的发送量不足请登录系统进行购买发送量
1015回复的邮件不合法请填写合法的回复邮件地址
1016每天的邮件发送量超限,默认每天发500条。如果需要比较大发送量,请联系客服进行修改
 


1 签名sig不正确

签名用SHA加密,加密的参数顺序为(secretkey=%s&random=%d&time=%d&fromEmail=%s),具体可以查看下demo

2 怎么添加发信域名

登录系统,在邮件服务-->邮件接口-->发信域名里面添加 ,具体请联系客服

 


如有其它疑问,请@Kewail短信技术支持,QQ 2403602442,电子邮箱member@notice.kewail.com