批量发送个性化事务邮件

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

如果您想发送一批事务邮件，这些邮件使用相同的模板，但每封邮件都有个性化的动态内容。您不需要为每封邮件调用一次API接口，可以在一次请求中最多传递最多100套个性化内容。EffiLink 接口将把模板与个性化内容组装成邮件投递出去。

身份验证

验证方式看这里。

建立发送任务

POST /v5/transactional/mail/sends_customised

请求参数

名称类型必填描述示例值
subjectstring是邮件主题欢迎邮件
contentstring是邮件内容。邮件内容中使用个性化标签的话，要注意标签的格式为：{{params.xxx}}
templateNamestring是邮件模板名称。和content参数二选一使用，都有值时，优先采用模板值。
paramsobject否邮件内容个性化标签值。按邮件内容中是否存在标签，来对应使用
senderMailstring是发送方邮箱norply@market.domain.com
senderNamestring否发送方名称，最大200 byte亿业科技
replyTostring否回复地址reply@market.domain.com
sendDatestring否发送时间。不填时为立即发送。使用UTC时间按照ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ。如，北京时间2023年1月10日20点0分0秒表示为2023-01-10T12:00:00Z。
messageVersionsarray[object]是邮件个性化发送配置，可再以多个版本来划分个性化内容和对应收件人范围
messageVersions.toarray[object]是该版本对应的邮件收件人
messageVersions.to.emailstring是收件人邮箱zhangsan@easeye.com.cn
messageVersions.to.namestring否收件人名称，最大100 byte张三
messageVersions.subjectstring否该版本的邮件主题，优先级更高
messageVersions.contentstring否该版本的邮件内容，逻辑和全局参数类似，但优先级更高
messageVersions.templateNamestring否该版本的邮件模板名称，逻辑和全局参数类似，但优先级更高，高于content
messageVersions.paramsobject否该版本的邮件内容个性化标签值。与基础params使用类似，并且与基础params中标签相同时，此版本中的标签值优先级更高
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": "<!DOCTYPE html><html><body>全局邮件内容：<p>{{params.paragraphText}}</p></body></html>",
	"params": {
		"paragraphText": "段落部分的个性化文本"
	},
	"senderMail": "norply@market.domain.com",
	"senderName": "亿业科技",
	"replyTo": "reply@market.domain.com",
	"sendDate": "2023-03-10T12:00:00Z",
	"messageVersions": [
		{
			"to": [
				{
					"email": "zhangsan@easeye.com.cn",
					"name": "张三"
				}
			]
		},
		{
			"to": [
				{
					"email": "lisi@easeye.com.cn",
					"name": "李四"
				},
				{
					"email": "wangwu@easeye.com.cn",
					"name": "王五"
				}
			],
			"subject": "欢迎邮件_新版本",
			"templateName": "邮件模板_新版本",
			"params": {
				"paragraphText": "段落部分的个性化文本_版本1"
			}
		}
	],
	"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请填写收件人未填写messageVersions中的to参数值
400messageVersions中的收件人未填写未填写messageVersions中的to中的email参数值
400未找到messageVersions中对应名称的邮件模板messageVersions中的templateName参数值未查询到对应的邮件模板
400发送方名称超长senderName参数值超过允许的最大长度
403发送方地址不存在senderMail未对应该账户的发送方配置
400回复地址不合法replyTo未通过邮箱格式校验
400请填写邮件内容content和templateName都未填写
403未找到对应名称的邮件模板templateName参数值未查询到对应的邮件模板
403点数不足该账户的邮件点数不足