DMD RESTful API调用指南

Dmartech售后客服 发表于 2021年07月08日 12:03 最后修改于 2021年07月08日 14:58

RESTful API接口文档地址可参见:

https://training-cn.webpower.asia/admin/api/swagger/

image.png

以上接口文档包含所有接口的参数说明,以下重点介绍发送邮件所要用到的接口。


邮件平台创建完活动后,在活动下面发送邮件,发送邮件流程主要是以下4步,按照此调用相应的接口,接口调用流程如下。

1) 创建联系人组;

2) 上传联系人到指定的联系人组;

3) 创建邮件素材;

4) 发送邮件

以下假设活动已创建,如何创建活动请参见https://webpower.kf5.com/posts/view/82330/

调用RESTful api的账号密码信息需要到管理—>rest authorization下创建,创建方法如下图。

image.png


根据发送场景不同,接口调用流程如下:

01     大批量发送场景/营销邮件发送

    1)  创建联系人组,

        o   POST/{campaignId}/group

    2) 导入联系人到指定组,以下接口之一

        o   POST/{campaignId}/contacts/import

        o   POST/{campaignId}/contacts (每次调用上传不多于1000人)

    3) 创建邮件

        o   POST/{campaignId}/mailing

    4) 发送邮件

        o   /{campaignId}/mailing/{id}/send

02     单条发送场景/系统通知类邮件发送

RESTful接口单条发送场景跟SOAP API略有不同,可以不用将联系人添加到联系人组,直接针对联系人ID发送,具体流程如下:

    1) 创建联系人

        o   POST/{campaignId}/contact 该接口上传联系人不需要指定联系人组。

    2) 创建邮件

        o   POST/{campaignId}/mailing

    3) 发送邮件给单个联系人

        o   POST/{campaignId}/mailing/{id}/sendSingle

 

平台还提供了以下三个接口均支持将上传联系人到平台或联系人组发送邮件两个步骤一个接口完成

        o   POST/{campaignId}/contacts/import

            §  该接口可以只完成上传功能,也可以完成上传和发送功能,取决于是否传入邮件id参数。

    image.png

        o   POST/{campaignId}/contacts/send

            §   该接口可以添加不多于1000人并发送,如果发送量较大,不建议使用此接口,需要频繁调用此接口,效率较低

            §  该接口中的groupid参数可以不填,不填会导致添加的联系人不属于任何组,建议填写groupid

        o   POST/{campaignId}/contact/sendSingleMail

            §  该接口上传联系人不需要指定联系人组,因此使用该接口发送,不需要创建联系人组,创建邮件后调用该接口即可

    使用上述这三个接口邮件发送流程可以简化为创建联系人组,创建邮件,上传联系人并发送三步。

03     简化版批量营销类发送场景

1) 创建联系人组

    o   POST/{campaignId}/group

2) 创建邮件

    o   POST/{campaignId}/mailing

3) 上传联系人并发送

    o  POST  /{campaignId}/contacts/import

    o  POST /{campaignId}/contacts/send

04     简化版单条系统类发送场景

1) 创建联系人组

    o  POST/{campaignId}/group

2) 创建邮件

    o   POST/{campaignId}/mailing

3) 上传联系人并发送

    o   POST/{campaignId}/contacts/send (该接口可以添加不多于1000人并发送)

    o   POST/{campaignId}/contact/sendSingleMail(使用该接口不需要联系人添加到联系人组,可以省略第一步)

请注意:邮件平台下每个活动下有预置的订阅组,可以将联系人上传到该组,上传到该组则不需要调用创建联系人组步骤。如果由于业务需要多个联系人组,建议调用接口创建新的联系人组。

 

 

05     邮件发送后获取邮件报告的接口

1) 获取邮件打开点击数据

    o   GET/{campaignId}/mailing/{id}/response

2) 获取邮件弹回数据

    o   GET/{campaignId}/bounces

3) 获取邮件统计报告数据

    o   GET/{campaignId}/mailing/{id}/statsSummary

 


DMD RESTful接口根据平台的数据资源对接口做了分组,如下表,常用的发送邮件需要的接口已黄色高亮。

image.png


{{Webpower 客服团队 customerservice@webpowerchina.com}}
回复
您需要登录后才可以回复

在线咨询