模板相关
获取模板列表
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=list-tpl
HTTP请求方式
GET
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| tpl_id | int | 否 | 模板 id,如果存在,则只获取该 id 值的模板信息。否则获取全部模板信息 |
API 返回的结果是 XML 格式, 示例如下:
<?xml version="1.0" encoding="UTF-8"?>
<template_list>
<template>
<id>模板ID</id>
<name>模板名称</name>
<subject>
<id>模板主题一 id</id>
<name>模板主题 1</name>
</subject>
<subject>
<id>模板主题二 id</id>
<name>模板主题 2></name>
</subject>
<content>模板内容</content>
<content_type>模板类型</content_type>
<attachments>附件信息<
attachment>
<atta_id>附件 id</atta_id>
<atta_name>附件文件名</atta_name>
</attachment>
</attachments>
<created>创建时间</created>
<updated>更新时间</updated>
</template>
<template>
...
</template>
...
</template_list>
添加模板
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=add-tpl
HTTP请求方式
POST
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| name | string | 是 | 模板名称 |
| subject | string | 是 | 邮件主题, 多个模板主题请以|隔开;如:主题一|主题二 |
| content | string | 是 | 邮件内容 |
| text_content | string | 否 | 纯文本内容,html 邮件内容无法显示时,显示纯文本内容 |
| encoding | string | 否 | 邮件编码,取值:base64/quoted-printable, 默认base64 |
| file | file | 否 | 邮件附件,file类型,Input 标签中 name 属性的值为‘file’ ,如果是上传多个文件,那么name属性值为'file[]' |
说明: 成功返回新建模板的 id 值
修改模板
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=edit-tpl
HTTP请求方式
POST
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| tpl_id | int | 是 | 模板ID |
| name | string | 否 | 模板名称 |
| subject | string | 否 | 邮件主题, 多个模板主题请以|隔开;如:主题一|主题二 |
| content | string | 否 | 邮件内容 |
| text_content | string | 否 | 纯文本内容,html 邮件内容无法显示时,显示纯文本内容 |
| encoding | string | 否 | 邮件编码,取值:base64/quoted-printable, 默认base64 |
备注:
1.tpl_id 参数必须,name、subject、content 三个参数必须至少有一个。
2.前四个参数均可以通过 post 或者 get 方式上传
API 返回的结果是 XML 格式, 示例如下:
<?xml version="1.0" encoding="UTF-8"?>
<result>
<status>执行结果标识符</status>
<data>添加成功返回的分类ID</data>
</result>
执行结果标识符说明:
- "add_maillist_error":添加联系人分类时发生错误
- "add_describe_error":添加联系人分类描述信息时发生错误
- "success":添加联系人分类成功
删除模板
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=del-tpl
HTTP请求方式
GET
POST参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| tpl_id | int | 是 | 模板ID |
上传模板附件
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=tpl-attachment-add
HTTP请求方式
POST
参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| tpl_id | int | 是 | 模板ID |
| file | file | 是 | 邮件附件,file类型,Input 标签中 name 属性的值为‘file’ ,如果是上传多个文件,那么name属性值为'file[]' |
删除模板附件
URL
http://www.bestedm.net/mm-ms/apinew/template.php?do=tpl-attachment-del
HTTP请求方式
POST
POST参数说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| tpl_id | int | 是 | 模板ID |
| attachment_id | string | 是 | 附件ID, 默认为‘all’,表示删除模板中所有附件 |