营销邮件发送

概述

营销发送 API 让您管理营销邮件发送任务的完整生命周期,从创建、安排到获取、取消和删除。所有端点都需要通过 ApiKey 或 OAuth 请求头进行认证。 基础 URL: https://api.effilink.co 认证方式: 在请求header中添加ApiKey来进行认证

创建发送任务

string

/v5/campaign/mail/sends

创建一个新的营销邮件发送任务。任务可以立即保存而不发送,也可以安排在未来发送,或立即发出。

请求参数

string

必填

发送任务名称。最大 200 字节。必须在您的团队内唯一。

string

必填

已验证的发件人邮箱地址。必须是您 EffiLink 账户中已完成验证的地址。

string

在”发件人”字段中向收件人显示的名称。

string

邮件主题。支持个性化标签(例如 {{firstName}})。

string

邮件的 HTML 正文内容。支持个性化标签。

string

定时发送时间,采用 ISO 8601 UTC 格式(例如 2025-06-01T10:00:00Z)。省略则立即发送。

boolean

设置为 true 将任务保存为草稿而不发送。当 true 时,sendListNames 不是必填项。默认为 false。

array[string]

目标联系人列表名称数组。除非 onlySave 为 true,否则必填。

["Newsletter Subscribers", "VIP Customers"]

array[string]

排除的联系人列表名称数组。这些列表中的收件人将被排除在发送之外。

string

回复邮箱地址。

object

随邮件附带的单个文件附件。

显示 attachment 属性

string

必填

文件名,包含扩展名(例如 report.pdf)。

string

必填

文件的 Base64 编码内容。

string

邮件的语言代码。控制本地化渲染。可接受值：zh-cn（简体中文）, en（英文）, ja（日文）, ko（韩文）, de（德文）, tt（俄文）, es（西班牙文）, zh-tw（繁体中文）, ar（阿拉伯文）, pt-br（葡萄牙文-巴西）, id（印尼文）, vi（越南文）, th（泰文）, fr（法文）

string

将此发送任务与指定的营销活动关联。

string

将此发送任务与指定的订阅关联。

string

将此发送任务与项目关联。如果项目不存在,将自动创建。

string

用于编写邮件的编辑器类型。默认为 DRAG。

值	描述
`DRAG`	拖放式可视化编辑器(默认)
`CLASSIC`	HTML 代码编辑器

string

创建人用户名。请在页面查看并获取。

boolean

设置为 true 以沙箱模式运行。邮件会被处理但不实际投递。

响应

int

HTTP 风格的状态代码。成功时为 200。

string

人类可读的状态消息。成功时为空字符串。

long

新创建的发送任务的内部数字 ID。

string

发送任务的全局唯一标识符(GUID)。

错误代码

代码	消息	原因
`400`	Missing required parameter	请求中缺少必填字段
`400`	mailName too long	`mailName` 超过 200 字节
`400`	Invalid sendDate	`sendDate` 不是有效的 ISO 8601 UTC 格式
`400`	Missing attachment data	`attachment` 对象不完整(缺少 `fileName` 或 `fileData`)
`400`	Missing send lists	`sendListNames` 为空且 `onlySave` 不为 `true`
`403`	Send list not found	`sendListNames` 中的一个或多个名称不存在
`403`	Exclusion list not found	`repelListNames` 中的一个或多个名称不存在
`500`	Task creation failed	发生内部服务器错误

请求示例

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/sends \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter",
    "senderMail": "newsletter@yourdomain.com",
    "senderName": "Your Company",
    "subject": "本月新动态",
    "content": "<p>您好 {{name}},</p><p>以下是本月的重点内容...</p>",
    "sendListNames": ["Newsletter Subscribers"],
    "repelListNames": ["Unsubscribed"],
    "sendDate": "2025-06-01T10:00:00Z"
  }'

响应示例

{
  "code": 200,
  "message": "",
  "id": 1120,
  "guid": "915cb709ac96418495fcf4f666f15c0d"
}

取消发送任务

string

/v5/campaign/mail/cancel

取消已安排的发送任务。仅可取消 sendDate 在未来(即尚未发出)的任务。

请求参数

string

必填

要取消的发送任务名称。

boolean

设置为 true 以取消在沙箱模式下创建的任务。

响应

int

成功时为 200。

string

人类可读的状态消息。成功时为空字符串。

请求示例

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/cancel \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter"
  }'

获取发送任务

string

/v5/campaign/mail/get

获取分页的营销发送任务列表,可选过滤条件。包含完整任务详情和发送统计。

请求参数

string

按名称包含此值的任务过滤结果。

string

按主题包含此值的任务过滤结果。

string

按从此邮箱地址发送的任务过滤结果。

string

按任务类型过滤。可接受值:MailList、ABTest。

string

该guid相关的邮件任务。

boolean

设置为 true 返回您账户中所有团队的任务。默认为 false(仅当前团队)。

array[int]

按任务状态过滤结果。可接受值:-1(草稿)、1(发送中)、2(发送完成)、4(发送失败)。省略以返回所有状态。

[-1, 2]

int

每页结果数。默认为 10。

int

页码(从 1 开始)。默认为 1。

响应

int

成功时为 200。

string

人类可读的状态消息。

int

符合过滤条件的任务总数。

array[object]

发送任务对象数组。

显示 mailList[] 属性

string

发送任务名称。

string

邮件主题。

string

HTML 正文内容。

string

发件人显示名称。

string

发件人邮箱地址。

string

回复邮箱地址。

array[string]

单独的收件人邮箱地址(如适用)。

array[string]

单独排除的邮箱地址(如适用)。

array[string]

目标联系人列表名称。

array[string]

排除的联系人列表名称。

int

定时或实际发送时间,以毫秒为单位的 Unix 时间戳(例如 1761199614000)。

string

任务类型:MailList 或 ABTest。

int

任务当前状态。可能值:-1(草稿)、1(发送中)、2(发送完成)、4(发送失败)。

string

任务的全局唯一标识符。

string

拥有此任务的团队。

string

与任务关联的语言代码。

string

关联的营销活动名称。

string

关联的订阅名称。

string

关联的项目代码。

string

审核任务的审阅人姓名(如适用)。

string

邮件任务摘要。

boolean

邮件任务是否进行智检。

int

AB测试任务的测试期限（单位：小时）。仅在邮件任务类型为AB测试时返回。

object

任务的投递和互动统计。

显示 mailStats 属性

int

发送邮件总数。

int

确认投递的邮件数。

int

唯一打开次数。

int

唯一链接点击次数。

int

硬退信数(永久投递失败)。

int

软退信数(临时投递失败)。

int

被过滤而未发送的联系人数。

int

此次发送触发的退订数。

请求示例

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "pageSize": 10,
    "pageIndex": 1
  }'

删除发送任务

string

/v5/campaign/mail/delete

按名称永久删除营销发送任务。

请求参数

string

必填

要删除的发送任务名称。

boolean

设置为 true 以删除在沙箱模式下创建的任务。

响应

int

成功时为 200。

string

人类可读的状态消息。成功时为空字符串。

请求示例

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/delete \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter"
  }'

事务性邮件

营销邮件

短信

联系人与名单

Webhooks

身份验证

营销邮件发送

概述

创建发送任务

请求参数

响应

错误代码

请求示例

响应示例

取消发送任务

请求参数

响应

请求示例

获取发送任务

请求参数

响应

请求示例

删除发送任务

请求参数

响应

请求示例

​概述

​创建发送任务

​请求参数

​响应

​错误代码

​请求示例

​响应示例

​取消发送任务

​请求参数

​响应

​请求示例

​获取发送任务

​请求参数

​响应

​请求示例

​删除发送任务

​请求参数

​响应

​请求示例

概述

创建发送任务

请求参数

响应

错误代码

请求示例

响应示例

取消发送任务

请求参数

响应

请求示例

获取发送任务

请求参数

响应

请求示例

删除发送任务

请求参数

响应

请求示例