外部线索数据导入
全部接口

所属权限	ads_management,ads_insights,account_management,audience_management,user_actions
请求地址	leads/add
请求方法	POST
Content-Type	application/json

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考，代码案例参考。

参数名称	参数类型
access_token	授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节
timestamp	当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。 MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳 MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59
nonce	随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性

参数名称

参数类型

access_token

授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节

timestamp

当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59

nonce

随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	广告主账号 id，直客账号或子客账号
match_type	enum	线索匹配类型，不填认为是 NONE，[枚举详情] 可选值：{ NONE, CONTACT, CLICKID }
leads_info_list*	struct[]	导入的线索信息列表数组最小长度 1，最大长度 50
outer_leads_id	string	作为线索管理平台的线索与客户侧 CRM 系统的线索关联的唯一标识
leads_id	integer	线索 id match_type=LEADSID 时必填
leads_tel	string	手机号，match_type=CONTACT 时 leads_tel、leads_qq、leads_wechat 至少填写一个，match_type=NONE 或者 CLICKID 时 leads_user_id、leads_tel、leads_qq、leads_wechat 至少填写一个字段长度最小 1 字节，长度最大 32 字节
leads_qq	integer	QQ 号，大于等于 1 小于 2^63。match_type=CONTACT 时 leads_tel、leads_qq、leads_wechat 至少填写一个，match_type=NONE 或者 CLICKID 时 leads_user_id、leads_tel、leads_qq、leads_wechat 至少填写一个
leads_wechat	string	微信号，match_type=CONTACT 时 leads_tel、leads_qq、leads_wechat 至少填写一个，match_type=NONE 或者 CLICKID 时 leads_user_id、leads_tel、leads_qq、leads_wechat 至少填写一个字段长度最小 1 字节，长度最大 64 字节
click_id	string	点击 id，用于线索归因，也可填写曝光 id（trace_id） match_type=CLICKID 时必填字段长度最小 1 字节，长度最大 64 字节
leads_type*	enum	线索类型，[枚举详情] 可选值：{ LEADS_TYPE_FORM, LEADS_TYPE_ONLINE_CONSULT, LEADS_TYPE_MAKE_PHONE_CALL, LEADS_TYPE_PHONE, LEADS_TYPE_PROMOTION_COUPON, LEADS_TYPE_INTELLIGENT_TOOL, LEADS_TYPE_LOTTERY, LEADS_TYPE_LANDING_PAGE_CLICK, LEADS_TYPE_ONE_CLICK_AUTHORIZE, LEADS_TYPE_PAGE_SCAN_CODE, LEADS_TYPE_PROMOTION_FOLLOW }
leads_user_id	string	线索用户 id，match_type=NONE 或者 CLICKID 时 leads_user_id、leads_tel、leads_qq、leads_wechat 至少填写一个字段长度最小 1 字节，长度最大 64 字节
leads_user_type	enum	线索用户类型，线索用户 id 有值时必填，[枚举详情] 可选值：{ USER_TYPE_QQ, USER_TYPE_QQ_MD5, USER_TYPE_TEL, USER_TYPE_TEL_MD5, USER_TYPE_IDFA, USER_TYPE_IDFA_MD5, USER_TYPE_IMEI, USER_TYPE_IMEI_MD5, USER_TYPE_GDT_OPENID, USER_TYPE_MAC_ADDRESS, USER_TYPE_MAC_ADDRESS_MD5, USER_TYPE_OAID, USER_TYPE_OAID_MD5, USER_TYPE_WX_OPENID, USER_TYPE_WX_UNIONID, USER_TYPE_OTHERS }
leads_user_wechat_appid	string	线索用户的微信 AppId，（微信公众号/小程序/小游戏的开发者 id）。leads_user_type 为 USER_TYPE_WX_OPENID/USER_TYPE_WX_UNIONID 时此字段必填字段长度最小 1 字节，长度最大 64 字节
leads_action_time	string	线索生成时间，格式：yyyy-MM-dd HH:mm:ss 字段长度最小 0 字节，长度最大 32 字节
leads_name	string	姓名字段长度最小 0 字节，长度最大 128 字节
leads_gender	enum	性别，[枚举详情] 可选值：{ GENDER_TYPE_UNKNOWN, GENDER_TYPE_FEMALE, GENDER_TYPE_MALE }
leads_email	string	邮箱字段长度最小 0 字节，长度最大 64 字节
leads_area	string	所在地字段长度最小 0 字节，长度最大 128 字节
bundle	string	其他线索信息，K-V 键值对, 字符串对字符串的 json 串，key 不能重复字段长度最小 0 字节，长度最大 1024 字节
memo	string	备注字段长度最小 1 字节，长度最大 128 字节
leads_age	string	年龄字段长度最小 0 字节，长度最大 32 字节
leads_id_number	string	身份证字段长度最小 1 字节，长度最大 24 字节
leads_nationality	string	国籍字段长度最小 1 字节，长度最大 32 字节
leads_address	string	详细地址字段长度最小 1 字节，长度最大 128 字节
leads_company	string	公司字段长度最小 1 字节，长度最大 128 字节
leads_profession	string	职业字段长度最小 1 字节，长度最大 16 字节
leads_working_years	string	工作年限字段长度最小 1 字节，长度最大 8 字节
leads_page_id	string	落地页 id 字段长度最小 1 字节，长度最大 256 字节
leads_page_name	string	落地页名称字段长度最小 1 字节，长度最大 256 字节
leads_page_url	string	落地页链接字段长度最小 1 字节，长度最大 2096 字节
leads_convert_type	string	线索状态，枚举列表：{ LEADS_CONVERT_STATUS_DEPRECATED, LEADS_CONVERT_STATUS_POTENTIAL_CUSTOMER, LEADS_CONVERT_STATUS_HIGH_INTENTION_CUSTOMER, LEADS_CONVERT_STATUS_TRANS_COMPLETED }
leads_ineffect_reason	string	无效原因，枚举列表：{ LEADS_INEFFECT_REASON_EMPTY, LEADS_INEFFECT_REASON_IDENTITY_MISMATCHED, LEADS_INEFFECT_REASON_REGION_MISMATCHED, LEADS_INEFFECT_REASON_DATA_DUPLICATION, LEADS_INEFFECT_REASON_TEL_NOT_CONNECTED, LEADS_INEFFECT_REASON_NO_INTENTION, LEADS_INEFFECT_REASON_UNKNOWN }
outer_leads_convert_type	string	外部线索状态，自定义取值字段长度最小 1 字节，长度最大 64 字节
outer_leads_ineffect_reason	string	外部无效原因，外部线索状态为无效时填写字段长度最小 1 字节，长度最大 32 字节
customized_tags	struct[]	自定义标签集合数组最小长度 1，最大长度 50
tag_group_name	string	回传的标签组名称，必须与所回传的标签是对应关系，否则可能出现错误字段长度最小 0 字节，长度最大 32 字节
tag_name_list	string[]	标签集合数组最大长度 100

使用说明

接口暂时不支持 BM 角色调用。
POST 请求，Content-Type: application/json。
bundle 为 string 到 string 的 map json 串，key 不能重复。
线索导入如果发生失败，会返回失败的外部线索 id 的列表。
若根据 match_type 和其他信息能够匹配到腾讯广告线索平台已沉淀的线索则更新，匹配不到则新增。
match_type=NONE 或者 CLICKID 时 leads_user_id、leads_tel、leads_qq、leads_wechat 至少填写一个。
match_type=CONTACT 时 leads_tel、leads_qq、leads_wechat 至少填写一个。

请求示例


curl 'https://api.e.qq.com/v3.0/leads/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": "<ACCOUNT_ID>",
    "leads_info_list": [
        {
            "click_id": "1234567",
            "customized_tags": [
                {
                    "tag_name_list": []
                }
            ]
        }
    ]
}'

应答字段

名称	类型	描述
fail_outer_lead_id_list	struct[]	返回失败的信息列表
index	integer	线索在请求参数中的索引，当请求参数中包含 N 条数据时，每条数据的索引即为 0 ～ N-1
outer_leads_id	string	外部线索 id，当请求参数中包含 N 条数据时，每条数据的索引即为 0 ～ N-1
detailed_err_code	integer	具体错误码，通常是 1000 至 3000 之间的数字
detailed_err_msg	string	，如线索已存在，不能重复导入
success_lead_id_list	struct[]	返回成功的线索列表
index	integer	线索在请求参数中的索引，当请求参数中包含 N 条数据时，每条数据的索引即为 0 ～ N-1
outer_leads_id	string	外部线索 id，当请求参数中包含 N 条数据时，每条数据的索引即为 0 ～ N-1
leads_id	integer	线索 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "fail_outer_lead_id_list": [],
        "success_lead_id_list": []
    }
}

可视化调试工具

问题仍未解决？

请前往腾讯广告反馈中心在线提交问题，我们的人工客服将为你服务

首页

接口文档

业务专题

开发者工具

最新动态

腾讯广告

外部线索数据导入
全部接口

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

首页

接口文档

业务专题

开发者工具

最新动态

腾讯广告

外部线索数据导入 全部接口

全局参数

请求参数

请求示例

应答字段

应答示例

可视化调试工具

外部线索数据导入
全部接口