邮件速递超人开放API

使用邮件速递超人提供的开放API接口,你可以将本软件轻松整合到你自己的系统中,用自己的业务逻辑来驱动本软件工作,甚至搭建强有力的后端EDM服务。你可以在 系统设置-》高级选项 中看到相关选项,默认主机名:127.0.0.1(本机) 端口号 8060,如果你把软件部署在一台有公网IP的服务器上,则可以将主机名设置为服务器的公网IP,这样其他人就都可以调用你的服务了,而不仅限于本机。记得设置好后,需要重启本软件方能生效! 

 

邮件速递超人开放API

 

接口规范文档

 

  • 请求方法: GET/POST
  • 数据格式: JSON
  • 数据编码: GBK (中文需做 URL编码)
  • 监听端口: 8060(可自定义)

 

接口1:测试

测试接口连通性

  • 请求地址:http://127.0.0.1:8060/test
  • 请求方法:GET
  • 查询字串:空
  • 返回数据:

{

“ret”: 200,

“msg”: “OK”

}

 

接口2:批量发送邮件

一次性提交多个收件人进行批量发送,使用软件中设置好的邮件模板进行发送

  • 请求地址:http://127.0.0.1:8060/send
  • 请求方法:POST
  • 请求数据:
[

{“email”:”邮址1″,”def1″:”宏1″,”def2″:”宏2″,”def3″:”宏3″,”def4″:”宏4″,”def5″:”宏5″},

{“email”:”邮址2″,”def1″:”宏1″,”def2″:”宏2″,”def3″:”宏3″,”def4″:”宏4″,”def5″:”宏5″},

{“email”:”邮址2″,”def1″:”宏1″,”def2″:”宏2″,”def3″:”宏3″,”def4″:”宏4″,”def5″:”宏5″},

……

]

  • 返回数据:

{

“ret”: 200,

“msg”: “OK”,

“data”:{

“received”:1,

“parsed”:1,

“filtered”:0

“email_id”:[

//第一位数字为提交时的序号,下划线后面的是软件生成的唯一标识(GUID),用于后续查询发送结果

“0_55d6019c-6eac-4238-8535-c3b3c2c20c16”,

“1_4837012b-54b5-48f8-a204-98bce9059b38”,

“2_afcb12f8-fdbe-425b-9e85-321127d38014”,

……

]

}

}

 

接口3:单封发送邮件

推送通知邮件,可指定标题和内容,使用此接口将忽略软件中已经设置好的邮件模板

  • 请求地址:http://127.0.0.1:8060/push
  • 请求方法:POST
  • 请求数据:

{

“email”: “邮址”,

“def1”: “宏1”,

“def2”: “宏2”,

“def3”: “宏3”,

“def4”: “宏4”,

“def5”: “宏5”,

“subject”: “邮件标题”,   //base64

“content”: “邮件内容”   //base64

}

  • 返回数据:

{

“ret”: 200,

“msg”: “OK”,

“data”:{“email_id”:”55d6019c-6eac-4238-8535-c3b3c2c20c16″}

}

 

接口4:查询发送结果

通过接口返回的GUID批量查询邮件发送结果

  • 请求地址:http://127.0.0.1:8060/query
  • 请求方法:POST
  • 请求数据:
[

“55d6019c-6eac-4238-8535-c3b3c2c20c16”,

“4837012b-54b5-48f8-a204-98bce9059b38”,

“afcb12f8-fdbe-425b-9e85-321127d38014”,

……

]

  • 返回数据:

{

“ret”: 200,

“msg”: “OK”,

“data”:{

“result”:[

“55d6019c-6eac-4238-8535-c3b3c2c20c16_2|发送成功”,         //GUID_状态码|错误信息

“4837012b-54b5-48f8-a204-98bce9059b38_3|发送失败:网络请求超时”,

“afcb12f8-fdbe-425b-9e85-321127d38014_4|发送失败:用户名密码错”,

]

}

}

 

接口5:停止发送

终止邮件发送任务

  • 请求地址:http://127.0.0.1:8060/stop
  • 请求方法:GET
  • 查询字串:空
  • 返回数据:

{

“ret”: 200,

“msg”: “OK”

}

 

接口6:统计

获取软件界面上的统计数据

  • 请求地址:http://127.0.0.1:8060/status
  • 请求方法:GET
  • 查询字串:空
  • 返回数据:

{

“ret”: 200,

“msg”: “OK”

“data”:{

“succ”:1,  //成功

“fail”:1,    //失败

“succ_total”:10,    //总成功

“fail_total”:10     //总失败

}

}