Fecify-邮件模版-详细
邮件模版-详情
接口信息
- 接口地址:
{your-site-url}/api/skill/notice/email-info
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/admin
- 请求方式:
GET
- Content-Type:
application/json
- 说明: 根据邮件模版 ID 获取完整详情,包括模版 HTML 内容和支持的 Liquid 语法变量列表。
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数
| 参数 |
类型 |
必填 |
说明 |
id |
Number |
是 |
邮件模版 ID(Query 参数),从 邮件模版-列表 获取 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/notice/email-info?id=2507' \
--header 'skill-access-token: {your-skill-access-token}' \
--header 'Content-Type: application/json'
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"email": {
"id": 2507,
"shop_id": 0,
"status": 1,
"lang_code": "default",
"type": 3,
"category": 1,
"subject": "Activate your merchant account",
"body_html": "<table id=\"content_table\" ...>...</table>",
"note": "商家注册账号,通过邮件发送激活账户的链接",
"created_at": "2024-07-07 21:55:10",
"updated_at": "2024-07-07 21:55:10"
},
"liquid_variables": [
"",
"",
"",
"",
"",
"",
"",
"",
""
]
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
返回数据,包含 email 和 liquid_variables |
data.email 子字段
| 字段 |
类型 |
说明 |
id |
Number |
邮件模版唯一 ID |
shop_id |
Number |
店铺 ID,0 表示全局模版 |
status |
Number |
邮件模版状态:1 = 开启,2 = 关闭 |
lang_code |
String |
语言简码,default 表示默认语言 |
type |
Number |
邮件类型 ID,对应 邮件类型列表 中的 type |
category |
Number |
邮件分类 ID,对应 邮件分类列表 中的 type |
subject |
String |
邮件模版标题 |
body_html |
String |
邮件模版 HTML 内容,内含 Liquid 模板语法变量 |
note |
String |
邮件使用场景描述 |
created_at |
String |
创建时间,格式 YYYY-MM-DD HH:mm:ss |
updated_at |
String |
最后更新时间,格式 YYYY-MM-DD HH:mm:ss |
data.liquid_variables
| 类型 |
说明 |
| Array |
该模版支持的 Liquid 语法变量列表,如 、,可在 body_html 中使用 |
注意事项
id 通过 邮件模版-列表 获取。
body_html 为完整的 HTML 邮件内容,包含内联样式和 Liquid 变量占位符,修改后通过 邮件模版-保存 提交。
liquid_variables 列出了该模版可用的所有变量,编辑时请勿使用列表之外的变量。