线索查询
接口说明
由于线索落入有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/?end_time=7scakvdbe1&life_account_id=[2ZGOQzjDI1]&page_size=3087519934957464071&account_id=b4qUF6QP6z&page=7698719364228415029&start_time=rcLQLriveT' \ --header 'x-mock-uid: yTQDKZLlFT' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
拉取的线索数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "clue_data": [ { "search_bid_word": "BA6Lw4nREW", "follow_life_account_type": 2918028574354674700, "gender": 3260644392301236700, "advertiser_name": "1v2kcfjWWq", "ad_id": 4108453303465042400, "author_nickname": "haR7JfRKcG", "source_craftsman_douyin_id": "mfuJICOOGD", "business": "ahgRY2MFDJ", "tool_id": "NRyMGp6jcZ", "convert_status": 112563276448778430, "create_time_detail": "1upi0xZIxo", "author_douyin_id": "YKXL0LowZJ", "author_role": "nZYz0V4A8X", "ad_type": 2591842802007853600, "tel_addr": "TCcMKxt3qM", "follow_life_account_id": "3YdCzuXAMf", "is_private_clue": 9061939764419868000, "order_status": "mEq9tQJCNN", "effective_state": 3054083595340470000, "clue_owner_name": "PjhE93xKLj", "flow_type": 3987807195136471600, "clue_type": 3291954630934838300, "ext_info": "0idaEiiCVg", "modify_time": "RWf0kEKkO2", "tags": [ "CVQLPCUkrw" ], "promotion_id": 4781795073872558000, "leads_page": 943757950101209600, "product_id": "2Vce3Cy9D8", "intention_life_account_name": "zhlUQkuTVH", "order_id": 932413511720872100, "follow_life_account_name": "e2faQ3ZqwF", "clue_intention": "Mnp2MAl1RU", "staff_nickname": "EMqyqN3tZA", "source_craftsman_nickname": "gsMAiMGR1l", "action_type": 8343313480448207000, "auto_city_name": "GU8D5EFNp5", "city_name": "6O5o5wJ5fW", "system_tags": [ "dv7voTe847" ], "qcpx_ticket_status": 7510698789685614000, "title_id": 6087721729158492000, "address": "texrQBkNyr", "province_name": "KsMfpFVEAX", "follow_state_name": 4441185048944479000, "country_name": "JgCmKFv5WJ", "follow_poi_id": "mlCQDCxlop", "promotion_name": "qJZHIxiRBW", "age": 8378737996968018000, "telephone": "OXgEM21MqY", "poi_name": "yOyBQ2DNas", "advertiser_id": "KSlT1N1hMB", "intention_poi_id": "6M0W9x4adO", "qcpx_ticket_info": "vGFDwsZm7D", "video_id": 8728394245329073000, "content_id": "Fb6HpJxgHz", "staff_commerce_nickname": "gbUpCX95Y1", "flow_entrance": 2250204495511249000, "auto_province_name": "LEIZNgTsMY", "product_name": "xlYCw4H3ZP", "product_type": 39307801518378780, "name": "GvVWTb1C1G", "remark_dict": "doypr4gkD3", "staff_douyin_id": "3RhBX0ZFhG", "root_life_account_id": "wP33KRZr7L", "county_name": "76RAHFuGcR", "clue_id": "I6j5tiQym3", "weixin": "nNS2OsaJJr", "image_id": 6834400534658103000, "allocation_status": 7141509552508099000, "req_id": "4OMbsVlBjV", "remark": "5z1AEFyQ4v" } ], "page": { "page_total": 83110176800957650, "total": 4275826319213665300, "page_size": 7546627025849766000, "page_number": 2514754729875974700 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260512152632533E3985D26CD5B925D1", "now": 1778570795 } }
错误码
| 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 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000001 | 以实际错误信息为准 |
