Skip to main content
在深入具体功能之前,先了解 EffiLink 平台背后的核心概念会很有帮助。本页介绍您在每次集成中都会遇到的基础构件。

API 端点

所有 EffiLink API 请求都发送至:
每个请求都必须使用 HTTPS,并包含 Content-Type: application/json 以及认证请求头。详见认证

已验证发件人

已验证发件人 是您在 EffiLink 上注册并证明所有权的邮件地址或域名。您无法通过未注册的地址发送邮件。验证过程包括在您的域名上设置 DNS 记录(SPF、DKIM、DMARC)。 发件人分为两种类型:
  • 营销类(type 1):用于营销/新闻通讯邮件
  • 事务性(type 2):用于触发式、系统生成的邮件

联系人与联系人列表

联系人 是通过邮件地址或手机号标识的单个收件人。联系人可以携带自定义属性(例如姓名、公司、生日)。 联系人列表(也称为 list 或 group)是一组具名的联系人集合。发送营销活动时,您可以指定一个或多个联系人列表作为目标。列表还可用作排除组(repel list),以过滤不希望送达的收件人。

营销任务(发送任务)

营销任务(或称发送任务)是营销邮件或短信活动的工作单元。创建营销任务时,需要指定:
  • 发件人地址与名称
  • 邮件主题与内容(或模板)
  • 目标联系人列表
  • 计划发送时间(或立即发送)
营销任务可被查询、取消(如为计划任务)和删除。

模板

模板 是保存在您 EffiLink 账户中的可复用 HTML 邮件设计。模板中可包含 {{tagName}} 格式的个性化标签,在发送时被替换为实际值。您可以通过 API 或 EffiLink 控制台管理模板。

个性化标签

个性化标签让您可以在邮件主题和正文中注入动态内容。在内容或模板中使用 {{tagName}} 格式,然后在 API 请求的 params 字段中提供对应的值。

沙箱模式

沙箱模式 让您可以在不发送真实邮件或短信、不消耗额度、不影响线上数据的前提下测试 API 调用。在请求体中传入 "sandboxMode": true,API 会校验请求并返回相同结构的响应,但实际不会发出任何消息。详见沙箱模式

Webhooks

Webhooks 是 EffiLink 在邮件事件发生时(例如投递、打开、点击、退信、退订)向您的端点发送的 HTTP 回调。您可以在 EffiLink 控制台或通过 Webhook 配置 API 设置 webhook URL。

API 版本

本文档涵盖 API v5,是当前推荐使用的版本。所有 v5 端点的基础路径为 /v5/。如果您现有集成使用的是更早版本,建议迁移至 v5 以获得最新功能与最佳性能。