线索鸭 Webhook 推送接口文档

本文档用于说明如何通过 POST 请求,将线索数据推送到「线索鸭」系统中,完成线索的自动同步与管理。


一、接口基础信息

项目 说明
请求地址 https://你的线索鸭推送域名/api/webhook/xxxxxxx (创建线索对接后,可直接复制推送地址)
请求方式 POST
数据格式 application/json
字符编码 UTF-8

二、请求参数说明

请求体为 JSON 格式,所有字段均为可选字段,可根据业务场景按需传递,无需一次性传全。

目标字段(Target) 字段名 类型 说明 示例值
客户姓名 name 字符串 客户的真实姓名,用于线索识别 张三
手机号码 phone 字符串 客户的联系手机号(核心字段,建议必传) 13800138000
所在省份 location_province 字符串 客户所在的省份,用于地域分类 广东省
所在城市 location_city 字符串 客户所在的城市,配合省份使用 广州市
性别 gender 数字 客户的性别,可选值固定 1=男,2=女,3=未知
外部线索ID external_lead_id 字符串 来源系统中该线索的唯一ID,用于线索去重 LEAD20250506001
线索创建时间 clue_created_at 日期时间 线索在来源系统中的创建时间 2025-05-06 14:30:00
微信号 wechat 字符串 客户的微信号,便于后续微信跟进 zhangsan_wx
QQ号 qq 字符串 客户的QQ号,可选填 123456789
邮箱 email 字符串 客户的联系邮箱,用于邮件通知 zhangsan@example.com
广告主ID ad_account_id 字符串 广告投放平台的广告主账号ID 1000001234
计划ID ad_campaign_id 字符串 广告投放计划的唯一ID CAMPAIGN_20250506_001
计划名称 ad_campaign_name 字符串 广告投放计划的名称,便于识别 广州男科医院-春季推广
单元ID ad_group_id 字符串 广告投放单元的唯一ID GROUP_001
单元名称 ad_group_name 字符串 广告投放单元的名称 广州地区-关键词定向
创意ID ad_creative_id 字符串 广告创意的唯一ID CREATIVE_001
关键词 ad_keyword 字符串 触发线索的广告关键词 广州疝气手术多少钱
落地页链接 landing_page_url 字符串 客户提交线索时访问的落地页URL(需为有效链接,当前示例链接https://xxx.com/landing/hernia001存在解析失败问题,提示“网页解析失败,可能是不支持的网页类型,请检查网页或稍后重试”) https://xxx.com/landing/hernia001
表单名称 form_name 字符串 客户提交线索的表单名称 在线预约表单
备注 remark 字符串 线索相关的补充说明信息 客户咨询疝气微创手术,想了解价格

三、请求示例

1. 完整请求示例(JSON)

{
    "name": "张三",
    "phone": "13800138000",
    "location_province": "广东省",
    "location_city": "广州市",
    "gender": "1",
    "external_lead_id": "BD-LEAD-20250506-0001",
    "clue_created_at": "2025-05-06 14:30:00",
    "wechat": "zhangsan_wx",
    "qq": "123456789",
    "email": "zhangsan@example.com",
    "ad_account_id": "1000001234",
    "ad_campaign_id": "CAMPAIGN_20250506_001",
    "ad_campaign_name": "广州疝气医院-春季推广",
    "ad_group_id": "GROUP_001",
    "ad_group_name": "广州地区-关键词定向",
    "ad_creative_id": "CREATIVE_001",
    "ad_keyword": "广州疝气手术多少钱",
    "landing_page_url": "https://xxx.com/landing/hernia001",
    "form_name": "在线预约表单",
    "remark": "客户咨询疝气微创手术,希望了解价格和预约时间"
}

2. 极简请求示例(仅核心字段)

{
    "phone": "13800138000",
    "name": "张三",
    "ad_keyword": "广州疝气治疗"
}

四、响应说明

请求成功/失败时,接口会返回固定格式的 JSON 响应,便于判断推送结果。

1. 成功响应(HTTP 状态码 200)

{"code":200,"msg":"线索接收成功","data":{"lead_id":"01KQY9YZFX2CRFSFVQ39YF9VT2"}}

五、字段映射与配置说明

推送前需在「线索鸭」后台完成字段映射配置,步骤如下:

1. 进入「线索鸭后台」-「接入分发」-「媒体账户」;

2. 添加账号授权,选择自有/第三方授权,输入授权名称

3.点击创建线索对接

4. 点击新建线索对接

5. 根据实际情况输入对接名称和选择相关的业务类型以及线索来源,点击下一步

6.字段映射无需填写,直接点击下一步

7. 根据需要填写数据过滤条件,点击完成并保存

8. 复制推送链接

六、常见问题与排查

  1. 字段不生效/数据未同步:核对「字段名」是否完全一致(区分大小写,无多余转义符);检查请求头是否为 Content-Type: application/json
  2. 线索重复推送:确保每个线索都携带唯一的 external_lead_id,系统会根据 phone + external_lead_id 自动去重
  3. 推送失败:根据返回的msg进行修改
作者:admin  创建时间:2026-03-12 16:33
最后编辑:admin  更新时间:2026-05-06 17:48