Web API文档

目录 1 公司账户信息接口(Rest API) 2 联系人接口(Rest API) 3 邮件接口(Rest API) 4 群发营销邮件接口(Rest API) 5 触发交易邮件接口(Rest API) 6 报表接口(Rest API) 7 综合示例 8 SDK

1. 入口

• 地址：services.unimarketing.org
• 端口：80/443

2. 公司账户信息接口(Rest API)

• 2.1	账户信息查询	GET	/account
  2.2	账号状态验证	POST	/account

3. 联系人接口(Rest API)

• 字段属性说明

• 3.1	创建联系人列表	POST	/list
  3.2	更新联人列表	POST	/list/{listId}?field=(delete|update|add)
  3.3	查询联系人列表	GET	/list?q=***&start-index=1&max-results=10
  3.4	删除联系人列表	DELETE	/list/{listId}	(new_2011-08-04)
  3.5	获取联系人列表信	GET	/list/{listId}
  3.6	添加多笔联系人	POST	/contact
  3.7	更新联系人信息	POST	/contact/{contactID}	(update_2011-07-13)
  3.8	批量删除联系人	POST	/contact/delete
  3.9	删除联系人	DELETE	/contact/{contactID}
  3.10	查询联系人信息	GET	/contact	(update_2011-07-13)
  3.11	获取联系人信	GET	/contact/{contact-id}
  3.12	创建导入任务	POST	/contactimport
  3.13	导入联系人	POST	/contactimport/import/{importId}
  3.14	修改导入任务	POST	/contactimport/{importID}
  3.15	执行导入任务	POST	/contactimport/{importID}
  3.16	查询导入任务	GET	/contactimport/{importID}

4. 邮件接口(Rest API)

• 4.1	创建邮件分类	POST	/folder
  4.2	更新邮件分类	PUT/POST	/folder/update
  4.3	删除邮件分类	PUT/POST	/folder/delete
  4.4	查询邮件分类	GET	/folder?q=***&start-index=1&max-results=10
  4.5	创建邮件	POST	/message
  4.6	更新邮件	POST	/message/{messageID}
  4.7	删除邮件	DELETE	/message/{messageID}
  4.8	查询邮件列表	GET	/message?q=***&start-index=1&max-results=10
  4.9	预览邮件	GET	/message/{messageID}?preview

5. 群发营销邮件接口(Rest API)

• 字段属性说明

• 5.1	创建发送任务	POST	/schedule/create
  5.2	更改发送任务	POST	/schedule/{scheduleID}
  5.3	取消发送任	PUT	/schedule/{scheduleID}?cancel
  5.4	查询发送任务列表	POST	/schedule/query?start-index=1&max-results=10	(update_2011-07-13)
  5.5	查询发送任务信息	GET	/schedule/{scheduleid}	(update_2012-11-22)

6. 触发交易邮件接口(Rest API)

• 字段属性说明

• 6.1	创建交易邮件模板	POST	/message
  6.2	创建交易类邮件计划	POST	/schedule	(update_2011-07-13)
  6.3	触发交易邮	POST	/schedule/trigger	(update_2012-12-21)
  6.4	触发交易邮件(简化接口)	POST	/message/send	(update_2012-12-21)
  6.5	触发交易邮件	POST	/schedule	(update_2012-11-29)旧接口，不推荐使用
  6.6	查询交易邮件报	POST	/report/details/{taskId}?q={domains}	(new_2011-07-13)

7. 报表接口(Rest API)

• 字段属性说明

• 7.1	查询发送任务:汇总报表	GET	/report/{scheduleID}?type=summary
  7.2	查询发送任务:打开、链接点击汇总报表	GET	/report/{scheduleID}?type=urls
  7.3	查询发送任务:打开,链接点击明细报表	GET	/details/{scheduleID}?event={eventName}
  7.4	查询发送任务:联系人送达明细报表	GET	/report/{scheduleID}?type=contact&status={statusName}
  7.5	查询联系人:汇总报表	GET	/report/contact/summary?start-date=...
  7.6	查询联系人:报表明细	POST	/report/contact/detail?start-date=...

• 注：此接口仅仅支持群发邮件的报表数据，如需要触发邮件报表数据请使用Webhooks接口获取报表明细数据进行统计

8. 综合示例

• 8.1 示例1 (创建联系人列表=>添加联系人=>创建邮件分类=>创建邮件=>创建发送任务|系统邮件=>根据发送计划ID，取得报表数据)
• 8.2 示例2 (查询联系人列表=>查询邮件=>创建发送任务|系统邮件)
• 8.3 示例3 (查询联系人列表=>创建导入任务=>导入联系人)

9. SDK

• 1. JAVA SDK 下载
  • 1.1 JAVA SDK 主要提供 OAuth 授权DEMO 和 一个客户端工具类
  • 1.2 JAVA SDK 提供所有API 客户端测试DEMO
• 2. PHP SDK 下载
  • 1.1 PHP SDK 主要提供一个客户端工具类
  • 1.2 PHP SDK 提供所有API 客户端测试DEMO
• 3. .NET SDK 下载
  • 1.1 .Net SDK 主要提供一个客户端工具类
  • 1.2 .Net SDK 提供所有API 客户端测试DEMO