调用邮件接口教程
- 请求参数：
参数名称 参数类型 是否必填 说明
accesskey String 是 用户控制台中对应的accesskey
random int 是 随机整数 3) 请求包体：
参数名称 参数类型 是否必填 说明
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 否 扩展字段 4) 返回值：
名称 类型 返回值
result int 返回结果码，0代表成功，其他值为失败，具体可以参考错误码
errmsg string 错误的信息，如果是成功则为OK
surplus int 剩余投递量
sequnceId string 成功返回唯一的序列，如果失败则为空 5) 请求方式：
请求协议 HTTP POST
编码格式 UTF8 5) 样例demo:
请求的样例如下： https://live.kewail.com/directmail/v1/singleSendMail?accesskey=5a780b410cf2ff9c8896cca6&random=104696
包体为json字符串
{
“sig”: “D9544A3D290571425C8C5094542A76C2A19A84745F1DDFFA72F112A58E563517”,
“ext”: “”,
“replyEmail”: "[email protected]",
“fromAlias”: “张三”,
“htmlBody”: “test email”,
“needToReply”: true,
“subject”: “测试邮件”,
“clickTrace”: “0”,
“readTrace”: “0”,
“time”: 1519378109,
“type”: 0,
“toEmail”: "[email protected]",
“fromEmail”: "[email protected]"
}
错误码
错误码 原因 解决方案
0 成功 表示成功
500 参数错误 请核对传入的参数是否正确
1001 accesskey非法 请核对accesskey是否正确
1002 用户不存在 请核对accesskey是否是当前用户的
1003 用户被禁止 请联系客服
1004 传入的参数不正确 请核对参数是否正确
1005 签名sig为空 请查看sig是否正确
1006 fromEmail值不正确 请核对fromEmail的值，这个值必须是控制台配置好的发信地址
1007 needToReply值不能为空 needToReply需要传值
1008 toEmail值不正确 请填合法的email值
1009 邮件主题不能为空 请填写邮件主题
1010 邮件内容不能为空 请填写邮件内容
1011 sig签名不正确 请按照要求填写合适的签名
1012 发送邮件的域名没有认证成功 请登录系统控制台进行认证域名，如果不懂可联系客服解决
1013 fromEmail 没有认证成功 请登录系统控制台进行认证
1014 邮件的发送量不足 请登录系统进行购买发送量
1015 回复的邮件不合法 请填写合法的回复邮件地址
1016 每天的邮件发送量超限，默认每天发500条。 如果需要比较大发送量，请联系客服进行修改
我们为开发者封装了多个平台的 API 供开发者直接使用，以节省开发时间，点击这里查看。
接入简单快速接入可以参考api文档https://www.kewail.com/doc/email/index.html