邮件营销活动列表

更新时间：2023-06-03 09:00

营销活动是您在EffiLink，通过列表形式发送电子邮件的方式。

可以建立、删除、检索邮件营销活动任务，此邮件任务是基于联系组的数据来组装邮件内容的，可以立即发送，也可以定时在未来发送。

身份验证

验证方式看这里。

建立发送任务

POST /v5/campaign/mail/sends

向指定的单个或多个联系组的人群发送指定的内容，调用此方法前请确保已经把人群数据导入到对应的联系组中。

请求参数

名称	类型	必填	描述	示例值
mailName	string	是	邮件任务名称	发送任务01
subject	string	是	邮件主题	欢迎邮件
content	string	是	邮件内容	欢迎邮件_邮件内容
senderName	string	是	发送方名称	亿业科技
senderMail	string	是	发送方邮箱	norply@market.domain.com
sendDate	string	否	发送时间。不填时为立即发送。使用UTC时间按照ISO8601标准，格式为YYYY-MM-DDThh:mm:ssZ。	如，北京时间2023年1月10日20点0分0秒表示为2023-01-10T12:00:00Z。
sendListNames	array[string]	是	发送组名称列表	["发送组01","发送组02"]
repelListNames	array[string]	否	排斥组名称列表	["排斥组01"]
replyTo	string	否	回复地址	reply@market.domain.com
attachment	object	否	邮件附件。仅支持一个文件
attachment.fileName	string	是	邮件附件的文件名	附件文件01.txt
attachment.fileData	string	是	邮件附件的文件内容，为用base64编码后的字符串	MTIzNDU2
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"mailName": "发送任务01",
	"subject": "欢迎邮件",
	"content": "欢迎邮件_邮件内容",
	"senderName": "亿业科技",
	"senderMail": "norply@market.domain.com",
	"sendDate": "2023-03-10T12:00:00Z",
	"sendListNames": [
		"发送组01",
		"发送组02"
	],
	"repelListNames": [
		"排斥组01"
	],
	"replyTo": "reply@market.domain.com",
	"attachment": {
		"fileName": "附件文件01.txt",
		"fileData": "MTIzNDU2"
	}
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

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

取消任务

POST /v5/campaign/mail/cancel

根据名字取消指定的定时邮件任务，已过了发送时间的任务不能取消

请求参数

名称	类型	必填	描述	示例值
mailName	string	是	邮件任务名称	邮件任务01
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"mailName": "邮件任务01"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

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

检索任务

POST /v5/campaign/mail/get

根据任务名字、邮件主题、发送方等查询邮件任务。

请求参数

名称	类型	必填	描述	示例值
mailName	string	否	该邮件任务名称相关的邮件任务	发送任务01
subject	string	否	该邮件主题相关的邮件任务	欢迎邮件
senderMail	string	否	该发送方邮箱相关的邮件任务	norply@market.domain.com
type	string	否	该邮件任务类型相关的邮件任务	取值范围：WorkFlow、MailList、ABTest。工作流（WorkFlow），普通邮件任务（MailList），AB测试邮件任务（ABTest）
pageSize	int	否	每页行数。默认值为10	10
pageIndex	int	否	当前页数。默认值为1	1

请求示例

{
	"mailName": "发送任务01",
	"subject": "欢迎邮件",
	"senderMail": "norply@market.domain.com",
	"type": "MailList",
	"pageSize": 10,
	"pageIndex": 1
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容
mailList	array[object]	相关联系组数据
mailList.mailName	string	邮件任务名称
mailList.subject	string	邮件主题
mailList.mailContent	string	邮件内容
mailList.senderName	string	发送方名称
mailList.senderMail	string	发送方邮箱
mailList.replyTo	string	回复地址
mailList.rcptEmails	array[string]	联系人邮箱列表
mailList.repelEmails	array[string]	排斥联系人邮箱列表
mailList.rcptListNames	array[string]	联系组名称列表
mailList.repelListNames	array[string]	排斥组名称列表
mailList.sendByDateTime	date	邮件任务发送时间
mailList.taskType	string	邮件任务类型。值范围：工作流（WorkFlow），普通邮件任务（MailList），AB测试邮件任务（ABTest）
mailList.mailStatus	int	邮件任务状态。值范围：草稿（-1）、发送中（1）、发送完成（2）、发送失败（4）
totalRecords	int	相关邮件任务的总数量

返回示例

{
	"code": 200,
	"message": "",
	"mailList": [
		{
			"mailName": "发送任务01",
			"subject": "欢迎邮件",
			"mailContent": "欢迎邮件_邮件内容",
			"senderName": "亿业科技",
			"senderMail": "norply@market.domain.com",
			"replyTo": "reply@market.domain.com",
			"rcptEmails": [
				"zhangsan@easeye.com.cn"
			],
			"repelEmails": [
				"lisi@easeye.com.cn"
			],
			"rcptListNames": [
				"发送组01"
			],
			"repelListNames": [
				"黑名单01"
			],
			"sendByDateTime": "2023-10-30 08:15:54.921",
			"taskType": "MailList",
			"mailStatus": 1
		}
	],
	"totalRecords": 1
}

删除任务

POST /v5/campaign/mail/delete

请求参数

名称	类型	必填	描述	示例值
mailName	string	是	邮件任务名称	邮件任务01
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"mailName": "邮件任务01"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

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