发送事务邮件

更新时间：2024-01-05 09:50

本接口可以用于发送单封的事务类的邮件，可以直接传递完整的邮件内容，也可以调用已存在的模板并添加个性化内容。

身份验证

验证方式看这里。

建立发送任务

POST /v5/transactional/mail/sends_customised

请求参数

名称类型必填描述示例值
subjectstring是邮件主题欢迎邮件
contentstring是邮件内容欢迎邮件_邮件内容
senderMailstring是发送方邮箱norply@market.domain.com
senderNamestring否发送方名称亿业科技
replyTostring否回复地址reply@market.domain.com
sendDatestring否发送时间。不填时为立即发送。使用UTC时间按照ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ。如，北京时间2023年1月10日20点0分0秒表示为2023-01-10T12:00:00Z。
toobject是邮件收件人
to.emailstring是收件人邮箱zhangsan@easeye.com.cn
to.namestring否收件人名称张三
categorystring否邮件类别。用以标识一封邮件所属类别，方便报表查询。最长100 byte，只支持大小写字母和阿拉伯数字设置邮件类别为触发场景名称，比如账单邮件的类别可以是：bill；注册邮件的类别可以是：registration;
campaignstring否邮件任务名称。最长100 byte，只支持大小写字母和阿拉伯数字设置任务名称为用户传入的任务名称（如果有的话），或者“类别名称+触发日期”，比如bill_201607或者registration_20170207;
trackOpenint否是否跟踪邮件打开为1时跟踪，其他值不跟踪
trackClickint否是否跟踪邮件点击为1时跟踪，其他值不跟踪
uniqueMsgIDstring否用以唯一标识一封邮件（对请求方），在系统中作为外键存在。最大长度50 byte；sendseqid-89897254234
sandboxModeboolean否是否使用沙盒模式取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"subject": "欢迎邮件",
	"content": "欢迎邮件_邮件内容",
	"senderMail": "norply@market.domain.com",
	"senderName": "亿业科技",
	"replyTo": "reply@market.domain.com",
	"sendDate": "2023-03-10T12:00:00Z",
	"to": {
		"email": "zhangsan@easeye.com.cn",
		"name": "张三"
	},
	"category": "bill",
	"campaign": "registration_20170207",
	"trackOpen": 1,
	"trackClick": 1,
	"uniqueMsgID": "sendseqid-89897254234"
}

返回参数

名称类型描述
codeint返回码
messagestring对返回码的文本描述内容

返回示例

{
	"code": 200,
	"message": ""
}

常见返回值说明

codemessage说明
400参数不足有必填参数未填写
400发送时间值格式不正确sendDate参数值的格式不正确
400category字段值超长category参数值超过允许的最大长度
400campaign字段值超长campaign参数值超过允许的最大长度
400uniqueMsgID字段值超长uniqueMsgID参数值超过允许的最大长度
400请填写收件人未填写参数值to
400收件人中邮箱未填写未填写to中的email参数值
400收件人中邮箱不合法to中的email参数值未通过邮箱格式校验
400发送方名称超长senderName参数值超过允许的最大长度
403发送方地址不存在senderMail未对应该账户的发送方配置
400回复地址不合法replyTo未通过邮箱格式校验
400请填写邮件内容content和templateName都未填写
403未找到对应名称的邮件模板templateName参数值未查询到对应的邮件模板
403点数不足该账户的邮件点数不足