OneBound Tool 接口说明


公共参数:

请求地址: https://api.onebound.cn/tool/

HTTP请求方式:GET (参数内容比较长的可以使用POST)

公共请求参数: tool=[接口名称]

公共响应参数:

请求参数:
名称 类型 是否必须 示例值 描述
tpl string email模板
tpl_name string 已经存在的email模板名称,参考mail_tpl - 邮件模板
data json email变量(JSON格式),单次发送邮件可用,示例:
{"title":"welcome!"}
cfg json email配置(JSON格式),示例:
{
    "protocol":"smtp",
    "smtp_server":"smtp.ym.163.com",
    "smtp_account":"noreply@onebound.cn",
    "smtp_password":"123456",
    "smtp_port":"25",
    "smtp_auth":"1",
    "smtp_ssl":"0",
    "from_user":"noreply@onebound.cn",
    "from_name":"Steven",
    "reply_to":"lxq73061@qq.com"
  }
cfg_name string 已经存在的email配置名称,参考mail_cfg - 邮件配置
to string 收件人邮箱
key string KEY
api_key string KEY
subject string 邮件标题
message string 邮件正文
reply_to string 回复到
from_name string 发送人姓名
xsmtpapi json 扩展字段,批量发送邮件时使用. 详见 X-SMTPAPI http://www.sendcloud.net/doc/guide/rule/#x-smtpapi
示例:
{
    "to": ["d@163.com",    "i@163.com"],
    "sub": {
        "%content%": ["nihao0", "nihao1"]
    },
  }
    注意:

这里的 to 会覆盖收件人参数 to
这里的 to 的收件人个数不能超过100
sub 是一个关联数组. 它的 key 是「变量」, value 是「替换值数组」.

用法解释: 每一个「变量」对应一个「替换值数组」, 在做邮件内容替换时, 每一个「收件人」按其在「收件人数组」中出现的位置使用「替换值数组」中相应位置的值来替换「变量」的值.

参见如下示例:

# 邮件内容
亲爱的%name%:

    您好! 您本月在爱发信的消费金额为: %money% 元.

#---------------------------------------------------

# X-SMTPAPI
{
    "to": ["ben@ifaxin.com", "joe@ifaxin.com"],
    "sub":
    {
        "%name%": ["Ben", "Joe"],
        "%money%":[288, 497]
    }
}

#---------------------------------------------------

# ben@ifaxin.com 收到的邮件:
亲爱的Ben:

    您好! 您本月在爱发信的消费金额为: 288 元.

#---------------------------------------------------

# joe@ifaxin.com 收到的邮件:
亲爱的Joe:

    您好! 您本月在爱发信的消费金额为: 497 元.
响应参数:
名称 类型 示例值 描述

请求示例:(单个)?tool=mail&tpl=&tpl_name=test_tpl&data=%7B%22title%22%3A%22welcome%21%22%7D&cfg=&cfg_name=test_cfg&to=lxq73061@qq.com&api_key=test_api_key&subject=队列测试邮件%title%&message=&reply_to=&from_name=Steven

[查看测试(单个)]

请求示例:(批量)?tool=mail&tpl=&tpl_name=test_tpl&data=&cfg=&cfg_name=test_cfg&to=&api_key=test_api_key&subject=&message=&reply_to=&from_name=&xsmtpapi=%7B%22to%22%3A%5B%22lxq73061%40163.com%22%2C%22583964941%40qq.com%22%2C%22619509336%40qq.com%22%5D%2C%22sub%22%3A%7B%22%25title%25%22%3A%5B%22nihao0%22%2C%22nihao1%22%2C%22nihao3%22%5D%7D%7D

[查看测试(批量)]

Powered by:万邦 www.onebound.cn All Rights Reserved. QQ:583964941