简要描述

AokSend 邮件API发送接口提供高效稳定的邮件发送服务,支持模板变量、附件发送等功能。

新版 API v2 采用Cloudflare安全防护,由于Cloudflare匿名代理到海外IP,请确保高防服务器放行海外IP等。

请求信息

接口地址

√ 推荐 新版接口 API v2https://apiv2.aoksend.com/index/api/send_email
× 即将下线 旧版接口APIhttps://www.aoksend.com/index/api/send_email

请求方式

POST
提示:发送附件时必须使用 multipart/form-data 进行 POST 提交(表单提交)。

参数说明

参数名 选项 类型 说明
app_key 必填 字符串 API密钥
template_id 必填 字符串 模板ID
to 必填 字符串 收件人地址
reply_to 选填 字符串 默认回复地址
alias 选填 字符串 发件人名称
is_random 选填 1或不填 域名轮播,1为开启 设置多个域名时可用
data 选填 JSON 模板变量
attachment 选填 file 邮件附件, 仅专业版可用;发送附件时, 必须使用 multipart/form-data 进行 post 提交

data参数示例

如果模板中已设置变量 {{name}}{{address}},且在API调用时data参数传了对应数据,则实际发送的邮件中将会显示传递的数据。

注意:没有传递参数的变量将从邮件中移除。

{
  "name": "张三",
  "address": "深圳市"
}

返回参数

参数名 必选 类型 说明
code 数值 返回状态码
message 字符串 返回结果说明
msg_id 字符串 消息ID(请求成功时返回)

返回示例

{
  "code": 200,
  "message": "请求成功",
  "msg_id": "f6d3c6ae2ddf4d9481234d86bea0495c"
}

返回码对照

200 - 请求成功
邮件发送请求已成功处理
40001 - API密钥不能为空
请求中缺少API密钥参数
40002 - 认证失败
API密钥错误或无效
40003 - 模板ID错误
提供的模板ID不存在或无效
40004 - 收件人地址to不能为空
请求中缺少收件人地址参数
40005 - 收件人地址to格式不正确
收件人邮箱地址格式错误
40006 - 默认回复地址reply_to格式不正确
回复地址格式错误
40007 - 余额不足或账号被禁用
账户余额不足或账户已被禁用
40008 - data格式错误
data参数JSON格式不正确
40009 - 不支持的文件类型
只支持: zip, rar, pdf, jpg, png, gif, mp4, txt, doc, xls, ppt, docx, xlsx, pptx, jpeg, csv
40009 - 附件大小不能超过1MB
附件文件大小超过限制