Email

Scope	说明	访问资源
read_email	获取邮件模版列表、获取邮件统计信息等	Email
write_email	创建/发送邮件等	Email

GET /api/open/v1/email/template

请求样例

curl --location --request GET 'http://openapi.quickcep.com/api/open/v1/email/template' \ --header 'X-QuickCEP-Access-Token: xxx'

参数

无

返回值示例

{
    "code": 200,
    "message": null,
    "data": [
        {
            "id": 1487018566738124801,
            "name": "模板名称",
            "createTime": "2022-01-28 19:03:48",
            "customParameters":[]
        }
    ]
}

返回值名称	类型	说明
code	Number	正常200
message	String	接口返回信息
data	Array	返回业务数据

data数组中的数据结构

返回值名称	类型	说明
id	string	模板id
name	string	模板名称
customParameters	Array	自定义参数，字符串数组
createTime	String	创建时间

POST /api/open/v1/email/send

Content-Type: application/json

请求样例

curl --location --request POST 'http://openapi.quickcep.com/api/open/v1/email/send' \ --header 'X-QuickCEP-Access-Token: xxx \ --header 'Content-Type: application/json' \ --data-raw '{ "from": "976121867@qq.com", "to": "jiachang_ljc@163.com", "subject": "我是邮件标题", "contentType": "text/html", "html": "我是邮件内容", "isDealySend": "false" }'

参数

参数名称	是否必填	类型	说明
from	是	String	发送人，配置到QuickCEP后台的EDM邮箱别名
batchId	否	String	批次ID，不传则默认生成
fromName	否	String	发件人名称
to	是	String	收件人地址，多个地址使用英文 `;` 隔开。（目前最多支持五百）
subject	是	String	邮件标题
contentSummary	否	String	邮件摘要
contentType	是	String	邮件格式：text/plain、text/html
html	否	String	邮件内容，邮件格式 text/html
plain	否	String	邮件内容，邮件格式为 text/plain
cc	否	String	抄送地址。多个地址使用英文 `;` 隔开。
isBatchSend	否	Boolean	是否批次发送，默认`false`，如果参数是`true`,会根据收件人拆成多个email发送。
isDealySend	否	Boolean	是否延迟发送，默认`false`。
dealySendTime	否	String	延迟发送时间，格式：yyyy-MM-dd HH:mm:ss
dealySendTimezone	否	String	比如：America/Los_Angeles
verify	否	Boolean	是否以验证码渠道实时发送，默认为 false

返回值

返回值名称	类型	说明
code	Number	正常200
message	String	接口返回信息
data	object	返回业务数据

POST /api/open/v1/email/sendByTemplate

Content-Type: application/json

请求样例

curl --location --request POST 'http://openapi.quickcep.com/api/open/v1/email/sendByTemplate' \ --header 'X-QuickCEP-Access-Token: xxx' \ --header 'Content-Type: application/json' \ --data-raw '{ "from":"976121867@qq.com", "to":"jiachang_ljc@163.com", "subject":"我是邮件主题", "contentType":"text/html", "html":"我是邮件内容", "templateId":"746420515568091136", "templateParam":"key1=value1&key2=value2", "isDealySend":"false" } '

参数

参数名称	是否必填	类型	说明
from	是	String	发送人，配置到QuickCEP后台的EDM邮箱别名
fromName	否	String	发件人名称
to	是	String	收件人地址，多个地址使用英文 `;` 隔开。
Subject	是	String	邮件标题
contentSummary	否	String	邮件摘要
contentType	是	String	邮件格式：text/plain、text/html
cc	否	String	抄送地址。多个地址使用英文 `;` 隔开
templateId	是	String	模板id
customArgs	否	String	Key / value对, 格式： `key1=value1&key2=value2`
isBatchSend	否	Boolean	是否批次发送，默认`false`，如果参数是`true`,会根据收件人拆成多个email发送。
isDealySend	否	Boolean	是否延迟发送，默认`false`。
dealySendTime	否	String	延迟发送时间，格式：yyyy-MM-dd HH:mm:ss
dealySendTimezone	否	String	延迟发送时区，比如：America/Los_Angeles

返回值

返回值名称	类型	说明
code	Number	正常200
message	String	接口返回信息
data	Object	返回业务数据

POST /api/open/v1/email/batchSend

Content-Type: application/json

请求样例

curl --location --request POST 'http://openapi.quickcep.com/api/open/v1/email/batchSend' \ --header 'X-QuickCEP-Access-Token: xxx' \ --header 'Content-Type: application/json' \ --data-raw '[{ "from":"{发件人邮箱}", "to":"{收件人邮箱}", "subject":"{邮件标题}", "contentType":"text/html", "isDealySend":false, "templateId":"{freeMarker模版ID}", "jsonParam":"{\"goodsList\":[{\"name\":\"张三丰\",\"age\":\"78\",\"sex\":\"男\"},{\"name\":\"张无忌\",\"age\":\"18\",\"sex\":\"男\"},{\"name\":\"周芷若\",\"age\":\"19\",\"sex\":\"女\"}]}" }] '

参数说明

参数名称	是否必填	类型	说明
from	是	String	发送人，配置到QuickCEP后台的EDM邮箱别名
fromName	否	String	发件人名称
to	是	String	收件人地址，多个地址使用英文 `;` 隔开。
Subject	是	String	邮件标题
contentSummary	否	String	邮件摘要
contentType	是	String	邮件格式：text/plain、text/html
cc	否	String	抄送地址。多个地址使用英文 `;` 隔开
templateId	是	String	模板id
customArgs	否	String	Key / value对, 格式： `key1=value1&key2=value2`
isDealySend	否	Boolean	是否延迟发送，默认`false`。
dealySendTime	否	String	延迟发送时间，格式：yyyy-MM-dd HH:mm:ss
dealySendTimezone	否	String	延迟发送时区，比如：America/Los_Angeles
jsonParam	否	String	自定义传参填充内容，格式为转义后的键值对数组，可参考示例，需要在模板中配置对应的freemarker组件内容

1.QuickCEP 为客户提供了一些邮件事件, 客户可以选择关注某些事件

2.当某事件发生, 就会触发 QuickCEP向客户设置的 URL 发送数据 ( POST )

3.QuickCEP推送的数据类型："Content-Type: application/json "

4.客户收到数据, 解析出事件和数据, 你需要在 3s 内返回HTTP Status Code 200, 否则, QuickCEP将会重发该条消息。

事件	触发条件
请求（email/request）	邮件请求成功
发送（email/deliver）	邮件发送成功
打开（email/open）	用户打开邮件
点击（email/click）	用户点击链接
取消订阅(email/unsubscribe)	用户取消订阅邮件

1.如果遇到 URL 访问错误或超时, QuickCEP最多会重试 6 次。每次重试的时间间隔最快为 3min, 10min, 30min, 1h, 6h, 12h。即在消息丢失前, 你有足够的时间来修复接口URL。

2.如果超过重试次数，QuickCEP将会把消息丢弃。

3.每次事件处理, 数据解析, 你需要在 3s 内返回HTTP Code 200, 否则, QuickCEP将会重发该条消息。

header	说明	事例
X-QuickCEP-Topic	webhook事件枚举	email/create
X-QuickCEP-API-Version	API 版本	V1
X-QuickCEP-Webhook-Id	webhook唯一id，用于幂等性校验。	b54557e4-bdd9-4b37-8a5f-bf7d70bcd043

参数名称	类型	说明
message	String	消息内容
mailTaskid	String	发送email任务Id
emails	Array	发送邮件列表

2024-06-17

Email

1.1.1 QuickCEP Scope列表

1.1.2 查询EDM模板

1.1.3 普通发送Email

1.1.4 通过模板发送Email

1.1.5 通过模板发送Email数组

1.1.6 Email Webhook

Webhook机制

推送事件

重试机制

Header

参数说明

本页目录