邮件模版管理

开发者利用模板，可以方便的为不同用户批量发送相似内容。

通过 API 可以对邮件模板进行查询，添加，删除，修改操作。

查询 ( 批量查询 )

返回邮件模板的基本信息

URL

https://email.api.engagelab.cc/v1/templates

          https://email.api.engagelab.cc/v1/templates

此代码块在浮窗中显示

HTTP 请求方式

GET

GET

此代码块在浮窗中显示

请求 Header

Header	类型	必须	说明
Authorization	string	true	Basic base64(api_user:api_key)

Query 参数

参数	类型	必须	说明
offset	int	否	查询起始位置，取值区间 [0-]，默认为 0。
limit	int	否	查询个数，取值区间 [0-100]，默认为 100。
name	string	否	邮件模板名称。模糊查询。
template_invoke_name	string	否	邮件模板调用名称。精确查询。
template_type	int	否	邮件模板类型： 0（触发）、1（批量）。

请求示例

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

此代码块在浮窗中显示

响应说明

字段	说明
template_id	模板 ID
name	邮件模板名称
template_invoke_name	邮件模板调用名称
template_type	模板类型
html	模板内容
preview_text	模板摘要
subject	模板主题
create_time	邮件模板创建时间
update_time	邮件模板创建时间

响应示例

Response-success

HTTP Status: 200

{ "result": [{ "template_id": 82522, "name": "dffddf", "template_invoke_name": "dffdfd", "template_type": 1, "html": "<p>123445</p>", "subject": "fdfdfd😅🙂🙂🙂🙂", "preview_text": "", "create_time": "2022-11-10T15:47:05+0800", "update_time": "2022-11-10T15:47:05+0800" }] , "count":10, "total":20 }

          {
    "result":  [{
                "template_id": 82522,
                "name": "dffddf",
                "template_invoke_name": "dffdfd",
                "template_type": 1,
                "html": "<p>123445</p>",
                "subject": "fdfdfd😅🙂🙂🙂🙂",
                "preview_text": "",
                "create_time": "2022-11-10T15:47:05+0800", 
                "update_time": "2022-11-10T15:47:05+0800"
            }]
     ,
     "count":10,
     "total":20
}

此代码块在浮窗中显示

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

          {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

此代码块在浮窗中显示

查询

返回单个邮件模板的详细信息

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

          https://email.api.engagelab.cc/v1/templates/{template_id}

此代码块在浮窗中显示

HTTP 请求方式

GET

GET

此代码块在浮窗中显示

请求 Header

Header	类型	必须	说明
Authorization	string	true	Basic base64(api_user:api_key)

请求示例

curl -X GET -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'

          curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

此代码块在浮窗中显示

响应说明

字段	说明
template_id	模板 ID
name	邮件模板名称
template_invoke_name	邮件模板调用名称
template_type	模板类型
html	模板内容
preview_text	邮件摘要
subject	模板标题
create_time	邮件模板创建时间
update_time	邮件模板创建时间

响应示例

Response-success

HTTP Status: 200

{ "result":{ "template_id": 76707, "name": "libo01s", "template_invoke_name": "libo01d", "template_type": 0, "html": "The is first email", "subject": "happyaaa", "preview_text": "", "create_time": "2019-07-22T11:52:45+0800", "update_time": "2019-08-01T11:29:19+0800" } }

          {
     "result":{
            "template_id": 76707,
            "name": "libo01s",
            "template_invoke_name": "libo01d",
            "template_type": 0,
            "html": "The is first email",
            "subject": "happyaaa",
            "preview_text": "",
            "create_time": "2019-07-22T11:52:45+0800",
            "update_time": "2019-08-01T11:29:19+0800"
        }
}

此代码块在浮窗中显示

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

          {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

此代码块在浮窗中显示

添加

URL

https://email.api.engagelab.cc/v1/templates

          https://email.api.engagelab.cc/v1/templates

此代码块在浮窗中显示

Content-Type:

Content-Type: application/json;charset=utf-8

          Content-Type: application/json;charset=utf-8

此代码块在浮窗中显示

HTTP 请求方式

POST

          POST

此代码块在浮窗中显示

请求 Headers

Header	类型	必须	说明
Authorization	string	true	Basic base64(api_user:api_key)

Body 参数

参数	类型	必须	说明
name	string	是	邮件模板名称。最长 32 字符。
template_invoke_name	string	是	邮件模板调用名称。4~64 字符。
template_type	int	是	邮件模板类型：0（触发）, 1（批量）。
html	string	是	html 格式内容
subject	string	是	模板标题。最长 255 字符，支持 emoji。
preview_text	string	否	模板摘要。最长 255 字符。

注意：

html 内容中可以使用变量。

发送时邮件总大小不得超过 70MB。

请求示例

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "template_type": 0, "html": "xxx", "subject": "sususubej"}' 'https://email.api.engagelab.cc/v1/templates'

          curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "template_type": 0, "html": "xxx", "subject": "sususubej"}'
     'https://email.api.engagelab.cc/v1/templates'

此代码块在浮窗中显示

响应说明

字段	说明
template_id	模板 ID
name	邮件模板名称
template_invoke_name	邮件模板调用名称
template_type	模板类型
preview_text	邮件摘要
html	模板 html 格式内容
subject	模板标题
create_time	邮件模板创建时间
update_time	邮件模板修改时间

响应示例

Response-success

HTTP Status: 200

{ "result": { "template_id": 82525, "name": "zhongg", "template_invoke_name": "gjtest122", "template_type": 0, "html": "This first template for apiv3", "subject": "xxxxxxx", "preview_text": "", "create_time": "2022-11-14T15:31:17+0800", "update_time": "" } }

          {
    "result": {
            "template_id": 82525,
            "name": "zhongg",
            "template_invoke_name": "gjtest122",
            "template_type": 0,
            "html": "This first template for apiv3",
            "subject": "xxxxxxx",
            "preview_text": "",
            "create_time": "2022-11-14T15:31:17+0800",
            "update_time": ""
    }
}

此代码块在浮窗中显示

Response-error

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

          {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

此代码块在浮窗中显示

删除

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

          https://email.api.engagelab.cc/v1/templates/{template_id}

此代码块在浮窗中显示

HTTP 请求方式

DELETE

          DELETE

此代码块在浮窗中显示

请求 Headers

Header	类型	必须	说明
Authorization	string	true	Basic base64(api_user:api_key)

请求示例

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'

          curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

此代码块在浮窗中显示

响应说明

参数	说明
count	成功删除的邮件模板个数

响应示例

Response-success

HTTP Status: 200

{ "count": 1 }

           { "count": 1 }

此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }

          { 
    "code": 30000,
    "message": "Authentication failed."
}

此代码块在浮窗中显示

修改

用于修改模板的名称，内容，主题，模板类型。

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

          https://email.api.engagelab.cc/v1/templates/{template_id}

此代码块在浮窗中显示

Content-Type:

Content-Type: application/json;charset=utf-8

          Content-Type: application/json;charset=utf-8

此代码块在浮窗中显示

HTTP 请求方式

PUT

PUT

此代码块在浮窗中显示

请求 Headers

Header	类型	必须	说明
Authorization	string	true	Basic base64(api_user:api_key)

Body 参数

参数	类型	必须	说明
name	string	否	邮件模板名称。最长 32 字符。
template_invoke_name	string	否	邮件模板调用名称。4~64 字符。
template_type	int	否	邮件模板类型：0（触发）, 1（批量）。
html	string	否	html 格式内容
subject	string	否	模板标题。最长 255 字符，支持 emoji。
preview_text	string	否	邮件摘要。最长 255 字符。

注意：

html 内容中可以使用变量。

发送时邮件总大小不得超过 70MB。

请求示例

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"template_invoke_name": "myCustomTemplate"}' 'https://email.api.engagelab.cc/v1/templates/11111111'

          curl -X PUT -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"template_invoke_name": "myCustomTemplate"}'
     'https://email.api.engagelab.cc/v1/templates/11111111'

此代码块在浮窗中显示

响应说明

参数	说明
count	成功修改的模板数量

响应示例

Response-success

HTTP Status: 200

{ "count": 1 }

           { 
 "count": 1 
 }

此代码块在浮窗中显示

Response-error

HTTP Status :401

{ "code": 30000, "message": "Authentication failed." }

          { 
    "code": 30000,
    "message": "Authentication failed."
}

此代码块在浮窗中显示