Webhooks文档
EDM-API接入
Webhooks文档
2023-02-26 15:47
-
Webhook是一种消息订阅异步接口实现方式，它能够将用户订阅消息数据及时的传输到用户指定的位置（URL）：将用户在灵动营销平台上发给用户会员的邮件发送状态，会员打开邮件，会员点击邮件里面链接，更新会员信息等行为事件信息数据及时的传回用户自己的业务系统。
- 例如有下面使用场景：
- 1.用户系统调用灵动平台邮件发送接口；
- 2.灵动平台处理邮件投递后，将投递结果推送给用户系统（Webhook订阅地址）；
- 3.用户系统接收推送结果后，向请求方（灵动平台）同步返回“200”确认处接收结果处理正常。
2. Webhook推送消息实体说明
-
名称 意义 数据类型 长度 备注 delivered 投递通知消息（未来将废弃） Json Array opens 打开通知消息 Json Array clicks 点击通知消息 Json Array unsubscriptions 退订通知消息 Json Array complaints 投诉通知消息 Json Array source 消息来源 String 10 值 意义 esp 用户通过ESP（EDM服务平台）退订投诉链接提交的申请 isp 用户在邮箱Web端，点击退订按钮，或点击这是垃圾邮件按钮，由ISP通知给ESP content 投诉内容 String 100 id 数据主键 Long 系统链接主键为负数，用以区分普通链接 campaign 邮件名称 String 100 email 邮件地址 String 100 uid 标识 String 100 mid 邮件消息标识，可从调用发送接口返回值中获取，和投递通知消息中的id一致 String 100 status 送达状态 String 32 值 意义 success 已发送 bounce:bad-mailbox 无效地址 bounce:soft 软弹回 bounce:hard 硬弹回 dsn 发送错误原因 String 200 updatedAt 投递完成时间 Timestamp 1970 1 1 00:00:00 GMT 1970 1 1 00:00:00 GMT 之前的毫秒数 createdAt 数据生成时间 Timestamp trackingId 用户自定义文本标识 String 60 灵动平台在处理完投递后，可以通过Webbook传回的消息中获取该数据。当一次调用发送多封邮件时，请用逗号分割。 trackingData 用户自定义文本数据 String 1000 灵动平台在处理完投递后，可以通过Webbook传回消息中，获取该数据，数据中双引号会被转移义 updateTime 投递完成时间（未来将废弃） Timestamp outTime 数据生成时间（未来将废弃） Timestamp id 标识 Long 投递通知消息中的id与发送接口中返回值和其它消息中mid一致，能够来追逐单封邮件打开，点击，投诉等用户行为 contactId 标识 Long 联系人标识 scheduleId 标识 Long 发送计划标识 messageId 标识 Long 消息（邮件）模板标识 ip 地址 String 32 IPV4 location 国家地区／省／市 String 100 longitude 经度 Double latitude 纬度 Double device 客户端设备 String 100 platform 客户端操作系统 String 100 client 客户端软件 String 100 url 用户点击的链接 String 500 - 系统链接#开头，如:
-
- #退订
- #投诉
- #网页版本
- #用户中心
- #推荐好友
- #注册 #确认
subject 邮件主题 String 200