接口说明

由于线索落入有6分钟左右的延迟，最近6分钟的线索可能会缺失，建议end_time比当前时间早10分钟。

线索查询接口仅支持查询近2年的线索数据

enc_telephone 和telephone字段都是用户的联系方式，只是加密方法不同，需要使用的解密方法也不同。enc_telephone 需要使用解密接口解密，telephone 需要使用本地解密方法解密

基本信息

名称	描述
HTTP URL	https://open.douyin.com/goodlife/v1/open_api/crm/clue/query/
HTTP Method	GET
Scope	life.crm.clue.query
权限要求	只支持自研商家需要申请权限，路径：抖音开放平台-开发者平台>控制台>应用详情>解决方案需要商家授权，路径：抖音来客>店铺管理>服务应用授权

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

固定值"application/json"

Rpc-Transit-Life-AccountString

来客商户根账户ID

x-mock-uidString

Query

account_id必填String

示例：123456

来客品牌账户

end_time必填String

示例：2024-04-01 00:00:30

查询截止时间，格式：yyyy-MM-dd hh:mm:ss，时间跨度上限：365

page必填Int32

示例：1

页数默认值: 1，page*page_size上限：10000

page_size必填Int32

示例：100

页面大小上限：100

start_time必填String

示例：2024-01-01 00:00:30

查询起始时间，格式：yyyy-MM-dd hh:mm:ss，最早时间限制 "2022-09-01 00:00:00"

life_account_idArray<String>

跟进子账户，不是门店id

open_idString

接口需要用户授权，必传；否则不传

请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/open_api/crm/clue/query/?life_account_id=[8vz3zqSzlf]&end_time=QxljR0r7X5&account_id=mWzhZWBjWK&page=3685779415580825&page_size=1388749573366238567&start_time=Cv7kM411qD&open_id=pdZy4NJdeL' \
--header 'x-mock-uid: mz5x32Vt9J' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \

响应参数

Body展开全部子属性

extra必填Struct

扩展信息

展开子属性

dataStruct

拉取的线索数据

展开子属性

响应示例
正常响应示例异常响应示例
{
  "data": {
    "clue_data": [
      {
        "action_type": 2098287396607924700,
        "ad_id": 1789547176467886600,
        "ad_type": 8251214161848760000,
        "address": "3QFzymKMqh",
        "advertiser_id": "7FmUqgOD7m",
        "advertiser_name": "PYymVPHJvK",
        "age": 8430691412813472000,
        "allocation_status": 3398053577143627300,
        "author_douyin_id": "28FEuveXDF",
        "author_nickname": "QdmjlFToxV",
        "author_role": "8SCW6MM3q4",
        "auto_city_name": "skv5bwIMTS",
        "auto_province_name": "7WV3mcB9mA",
        "business": "QkLYBDJ0rm",
        "city_name": "w0Iuem7hFD",
        "clue_id": "om3zfDaPat",
        "clue_intention": "mmZLZltoDb",
        "clue_owner_name": "MLokPdsBR2",
        "clue_type": 3350082745312694000,
        "component_event_type_tags": [
          5451137235802596000
        ],
        "content_id": "82Qvqj6ff7",
        "convert_status": 9124873628919551000,
        "country_name": "G7kdHyTLv7",
        "county_name": "ldqs1S0Wgb",
        "create_time_detail": "T4q9SJbu2u",
        "deal_sub_amount": "v18WVa6f20",
        "effective_state": 2202475944299838500,
        "enc_telephone": "jJHHuGcIVq",
        "ext_info": "BsuGo1c125",
        "flow_entrance": 4128947993546876400,
        "flow_type": 6833797169923933000,
        "follow_life_account_id": "2QgOEMgnnH",
        "follow_life_account_name": "9Y6IlRkzMZ",
        "follow_life_account_type": 7755152287935843000,
        "follow_poi_id": "2n6RxQq8Xw",
        "follow_state_name": 204261700080001760,
        "gender": 5690320827974580000,
        "image_id": 8345363110666870000,
        "intention_life_account_name": "rW2fHXKGbt",
        "intention_poi_id": "M9njtOYU7s",
        "is_private_clue": 5297311482108332000,
        "leads_page": 1740186316471593500,
        "modify_time": "l7zq1Tol9C",
        "name": "Qw8X30gIXQ",
        "order_id": 4038078862275655000,
        "order_status": "LiQwGXRiJu",
        "product_id": "35s0atdTn7",
        "product_name": "8I1ESEfsY7",
        "product_type": 9034583896120049000,
        "promotion_id": 6616280993151343000,
        "promotion_name": "TinsJIpOUt",
        "province_name": "Idr7X7Zd9N",
        "qcpx_ticket_info": "gkReshJ9AA",
        "qcpx_ticket_status": 111812386530833650,
        "remark": "4UUqLSxjzB",
        "remark_dict": "TT45K5Qp16",
        "req_id": "RbDnIviw5M",
        "root_life_account_id": "KUgPJyOvvo",
        "search_bid_word": "MHOZqGXfxB",
        "source_craftsman_douyin_id": "Te87IT9YmF",
        "source_craftsman_nickname": "w0XK2nMm3f",
        "staff_commerce_nickname": "IlILuTadnU",
        "staff_douyin_id": "HXRX04egfI",
        "staff_nickname": "XfXnDOJqIa",
        "system_tags": [
          "L178kLn42Y"
        ],
        "tags": [
          "vJ3BTpYY8R"
        ],
        "tel_addr": "SFfBWtI71m",
        "telephone": "CY9ybhdHkQ",
        "title_id": 5877495721034792000,
        "tool_id": "zMfzi3bXv6",
        "video_id": 4637220671731382000,
        "weixin": "UiqgnquzZS"
      }
    ],
    "page": {
      "page_number": 6932637558236047000,
      "page_size": 2907929884836421000,
      "page_total": 4454307398090930000,
      "total": 1260736211488782000
    }
  },
  "extra": {
    "description": "6fjrwRZLFj",
    "error_code": 3057741096449330700,
    "logid": "PtqYksph9m",
    "now": 3880977288194064000,
    "sub_description": "TodZi9nAic",
    "sub_error_code": 6738558617974030000
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试，长时间无解请向平台反馈
200	2119003	请求太过频繁，请稍后再试	请求被频控，请稍后再试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	45002001	参数非法	按文档规则修改参数
200	45002002	网络异常	重试，长时间无解请向平台反馈
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理
200	3000001	以实际错误信息为准
200	5000001	服务器打瞌睡了，请稍后再试。

线索查询在线调试

接口说明

基本信息

请求参数

响应参数

错误码

线索查询