获取测试线索

您可以使用本接口获取测试线索。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。 xtable |变化内容{30%}|v1.2{35%}|v1.3{35%}| |---|---|---| |接口路径|/v1.2/pages/leads/mock/get/|/v1.3/page/lead/mock/get/| |请求参数类型 |`advertiser_id`: number<br>`library_id `: number<br>`page_id`: number|`advertiser_id`: string<br>`library_id `: string<br>`page_id`: string| |返回参数类型|`lead_id`: number<br>`page_id`: number<br>`campaign_id`: number<br>`adgroup_id`: number<br>`ad_id`: number<br>`create_time`: number|`lead_id`:string<br>`page_id`: string<br>`campaign_id`: string<br>`adgroup_id`: string<br>`ad_id`: string<br>`create_time`: datetime|

请求

地址 https://business-api.tiktok.com/open_api/v1.3/page/lead/mock/get/

方法 GET

Header

|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。  |

参数

|字段|类型|描述|
|---|---|---|
| lead_source | string | 线索来源。<br><br>枚举值：<ul><li>`INSTANT_FORM`：通过即时表单生成的线索。</li><li>`DIRECT_MESSAGE`：通过绑定的企业号的私信生成的线索。</li></ul><br>默认值：`INSTANT_FORM`。 |
|advertiser_id {+条件必填}|string|测试线索在广告账户中创建时，本字段必填。<br><br>广告账户 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>：若您传入本字段，您需要有该广告账户的管理员权限。若想获取您有管理员权限的广告账户列表，可使用 [/bc/asset/get/](1739432717798401.html)。将 `asset_type` 设置为 `ADVERTISER`，并挑选返回的 `advertiser_role` 为 `ADMIN` 的广告账户。</p> |
|library_id {+条件必填}|string|测试线索在商务中心中的表单库中创建时，本字段必填。<br><br>表单库 ID。<br><br>若想获取某一商务中心中的表单库列表，可使用 [/page/library/get/](https://ads.tiktok.com/marketing_api/docs?id=1740029915327489)。|
|page_id {+条件必填}|string| <ul><li>当 `lead_source` 为 `INSTANT_FORM` 或未传入时必填。</li><li>当 `lead_source` 为 `DIRECT_MESSAGE` 时不支持本字段。</li></ul><br>即时表单的页面 ID。<br><br>若想获取即时表单列表，可使用 [/page/get/](1820826387779586.html) 并将 `business_type` 设置为 `LEAD_GEN`。|

示例

(code curl http)
curl --get -H "Access-Token:xxx" \
--data-urlencode "advertiser_id=ADVERTISER_ID" \
--data-urlencode "page_id=PAGE_ID" \
https://ads.tiktok.com/open_api/v1.3/page/lead/mock/get/
(/code)

返回

|字段|类型|描述|
|---|---|---|
|code |number|返回码。完整返回码列表及描述，可[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。  |
|message |string|返回信息。更多信息可见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。  |
|data |object|返回数据。  |
#|lead_data|object| 线索内容。 |
#|meta_data|object| 线索元信息。 |
##| lead_source | string | 线索来源。<br><br>枚举值：<ul><li>`INSTANT_FORM`：通过即时表单生成的线索。</li><li>`DIRECT_MESSAGE`：通过绑定的企业号的私信生成的线索。</li></ul> |
##|lead_id|string| 线索 ID。 |
##|page_id|string| 仅当 `lead_source` 为 `INSTANT_FORM` 时返回本字段。<br><br>即时表单的页面 ID。 |
##|campaign_id|string| 推广系列 ID。 |
##|campaign_name|string| 推广系列名称。|
##|adgroup_id|string| 广告组 ID。 |
##|adgroup_name|string| 广告组名称。 |
##|ad_id|string| 广告 ID。 |
##|ad_name|string| 广告名称。 |
##|create_time|datetime| 创建时间，UNIX 时间戳 。|
|request_id |string|请求的日志id，唯一标识一个请求。  |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code":0,
    "message":"OK",
    "request_id":"202208010308080102450041491221C41E",
    "data":{
        "meta_data":{
            "create_time":1659323289,
            "campaign_id":1679105346952197,
            "campaign_name":"test lead: dummy data for campaign name",
            "adgroup_id":1679105346954261,
            "adgroup_name":"test lead: dummy data for ad group name",
            "lead_id":7126711421177430274,
            "ad_id":1679105346954262,
            "ad_name":"test lead: dummy data for ad name",
            "page_id":6873052183063953666
        },
        "lead_data":{
            "name":"Jane Doe",
            "phone_number":"8001000000",
            "Availability":"test lead: dummy data for Availability"
        }
    }
}
(/code);