Webhooks文档

1. 介绍

  • Webhook是一种消息订阅异步接口实现方式,它能够将用户订阅消息数据及时的传输到用户指定的位置(URL):将用户在灵动营销平台上发给用户会员的邮件发送状态,会员打开邮件,会员点击邮件里面链接,更新会员信息等行为事件信息数据及时的传回用户自己的业务系统。

  • 例如有下面使用场景:
    • 1.用户系统调用灵动平台邮件发送接口;
    • 2.灵动平台处理邮件投递后,将投递结果推送给用户系统(Webhook订阅地址);
    • 3.用户系统接收推送结果后,向请求方(灵动平台)同步返回“200”确认处接收结果处理正常。

2. Webhook推送消息实体说明

  • 名称 意义 数据类型 长度 备注
    delivered 投递通知消息(未来将废弃) Json Array    
    opens 打开通知消息 Json Array    
    clicks 点击通知消息 Json Array    
    id 数据主键 Long   系统链接主键为负数,用以区分普通链接
    campaign 邮件名称 String 100  
    email 邮件地址 String 100  
    uid 标识 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    
    updateTime 投递完成时间(未来将废弃) Timestamp    
    outTime 数据生成时间(未来将废弃) Timestamp    
    id 标识 Long   (接口
    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  

3. Webhook推送消息实体示例:

  • //备注:下面示例数据在已经做了混淆:)
    {
        "delivered": [
            {
                "id": 2201602002317593, 
                "campaign": "大麦网温馨提示:您关注的演出内容有更新", 
                "email": "hg007@example.com", 
                "status": "bounce:hard", 
                "dsn": "Action: failed | Status: 5.1.2 (bad destination system: no such domain)", 
                "updated": "2014-02-20 18:08:05", 
                "createdAt": "2014-02-20 18:08:04", 
                "scheduleId": 17436, 
                "messageId": 12399, 
                "contactId": 19016004
            }, 
            {
                "id": 22201606019253710, 
                "campaign": "大麦网温馨提示:您关注的演出内容有更新", 
                "uid": "GFpCmAhnXpPoXqXLH2BY", 
                "email": " xiaorong@example.com ", 
                "status": "success", 
                "dsn": "smtp;250 ok: Message 1758717523 accepted", 
                "updated": "2014-06-27 15:03:04", 
                "createdAt": "2014-06-27 15:02:20", 
                "scheduleId": 121830, 
                "messageId": 162084, 
                "contactId": 43001513
            }
        ], 
        "clicks": [
            {
                "id": 22201603016582230, 
                "campaign": "大麦网温馨提示:您关注的演出内容有更新", 
                "subject": "大麦网温馨提示:您关注的演出内容有更新", 
                "uid": "GFpCmAhnXpPoXqXLH2BY", 
                "email": "someone@example.com", 
                "ip": "119.255.75.126", 
                "location": "中国/河北/廊坊", 
                "longitude": 116.7139, 
                "latitude": 39.5292, 
                "device": "", 
                "platform": "Windows 7", 
                "client": "Chrome", 
                "url": "http://item.damai.cn/78982.html", 
                "createdAt": "2014-02-20 18:08:05"
            }, 
            {
                "id": 22201603026582230, 
                "campaign": "大麦网温馨提示:您关注的演出内容有更新", 
                "subject": "大麦网温馨提示:您关注的演出内容有更新", 
                "uid": "GFpCmAhnXpPoXqXLH2BY", 
                "email": "someone@example.com", 
                "ip": "119.255.75.126", 
                "location": "中国/河北/廊坊", 
                "longitude": 116.7139, 
                "latitude": 39.5292, 
                "device": "", 
                "platform": "Windows 7", 
                "client": "Chrome", 
                "url": "#退订", 
                "createdAt": "2014-02-20 18:08:05"
            }
        ], 
        "opens": [
            {
                "id": 222016111000001234, 
                "subject": "大麦网温馨提示:您关注的演出内容有更新", 
                "uid": "GFpCmAhnXpPoXqXLH2BY", 
                "email": "someone@example.com", 
                "ip": "119.255.75.126", 
                "location": "中国/河北/廊坊", 
                "longitude": 116.7139, 
                "latitude": 39.5292, 
                "device": "", 
                "platform": "Windows 7", 
                "client": "Chrome", 
                "createdAt": "2014-02-20 18:08:05"
            }
        ]
    }
平台介绍
关于我们 | 联系我们 | 行业应用 | 专业术语 | 资源中心 | 隐私声明
版权所有 Copyright 2006-2017 北京灵动创新信息技术有限公司 - 京ICP备09804239号