线索查询
接口说明
由于线索落入有6分钟左右的延迟,最近6分钟的线索可能会缺失,建议end_time比当前时间早10分钟。
基本信息
名称 | 描述 |
---|---|
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
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
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/open_api/crm/clue/query/?life_account_id=[kR1iC44bsz]&end_time=x79CKPJtER&page=1474050609357129334&account_id=BuELvWue2X&open_id=Hhl7mlxShw&page_size=6841698712017651792&start_time=UwPXPuft6N' \ --header 'x-mock-uid: weHYACpQch' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
拉取的线索数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250617164433F7B309A4FEDF4F9E1CBC", "now": 1750149873 }, "data": { "clue_data": [ { "clue_owner_name": "FWC6F3btcB", "intention_life_account_name": "fLTFaxdc7L", "tags": [ "dzrDCRrKiy" ], "follow_life_account_name": "dpntVkpxBB", "province_name": "1pS2KgCYfE", "system_tags": [ "vewdadbyAB" ], "title_id": 6243402524173720000, "product_type": 2545227987188267500, "product_name": "pAQ9UQKRov", "author_douyin_id": "wXvDjbtoWo", "staff_nickname": "JrKLDoTTEP", "ad_id": 5556311668863673000, "allocation_status": 5406692783099012000, "telephone": "HeWxCyrKqf", "staff_douyin_id": "enOGdkSuCF", "remark_dict": "GARg70Psqz", "req_id": "ZTlRJvrLsa", "follow_poi_id": "nuKnz2YT7A", "follow_life_account_type": 5957864924329133000, "tel_addr": "9tBGk3msVp", "action_type": 9147713851963284000, "effective_state": 3722062451235234300, "clue_id": "NazWZmxhVY", "age": 4054002657250640400, "is_private_clue": 8553455747233352000, "advertiser_id": "wbzkfmsthh", "flow_type": 8996045506141600000, "auto_city_name": "c9ntpJUbSy", "business": "1jUxweilg7", "order_id": 8594968683805902000, "author_nickname": "8miLWjoAog", "weixin": "WFCEGw5oev", "convert_status": 3958848938128996000, "image_id": 8471461964910499000, "clue_type": 3191090694515353000, "county_name": "0MKP86LCla", "gender": 5611784557283640000, "create_time_detail": "D5OVzjB6nL", "name": "9ObEor0DrV", "auto_province_name": "9XJkf2filu", "modify_time": "C6tdxy0d7V", "video_id": 8522749571762612000, "product_id": "UGk8wDAc4U", "city_name": "P1DxzuGdZC", "source_craftsman_nickname": "0miw86yZoq", "root_life_account_id": "rxoiMAy147", "leads_page": 2268632072964045000, "source_craftsman_douyin_id": "7Sqj8HlSpZ", "ad_type": 1054452010545365600, "poi_name": "PDp5efBO2Y", "follow_state_name": 5860773183678862000, "follow_life_account_id": "c2WsAHMxb9", "order_status": "YYgii3Fbiq", "intention_poi_id": "9J7KUBo3Hr", "address": "B9tiiSyv7B", "advertiser_name": "fe8BaVtZHy", "promotion_id": 2689824489927403500, "promotion_name": "guTdtlUghy", "tool_id": "YNguwb73Q9", "author_role": "fW3G9WKtxg", "staff_commerce_nickname": "Ya0z3MSSwb", "flow_entrance": 9196783273752796000, "content_id": "xcCheB9Shv", "remark": "oZ3ljaW2Am" } ], "page": { "page_number": 4486281694238576600, "page_total": 747804356628407900, "total": 4470849667854425000, "page_size": 8414519751799527000 }, "error_code": 0, "description": "" } }
错误码
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 | 请求太过频繁,请稍后再试 |