线索查询
收藏接口说明
由于线索落入有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_timeString
示例：2024-04-01 00:00:30
查询截止时间，格式：yyyy-MM-dd hh:mm:ss， 时间跨度上限：365
life_account_idList
跟进子账户，不是门店id
展开子属性
pageInt32
示例：1
页数 默认值: 1，page*page_size上限：10000
page_sizeInt32
示例：100
页面大小 上限：100
start_timeString
示例：2024-01-01 00:00:30
查询起始时间，格式：yyyy-MM-dd hh:mm:ss，最早时间限制 "2022-09-01 00:00:00"
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/open_api/crm/clue/query/?account_id=1234&end_time=2024-04-25 11:39:37&page=1&page_size=100&start_time=2024-03-25 11:44:37 --header 'access-token: 0801121846735352506a356a6' \ --header 'content-type: application/json' \
响应参数
Body展开全部子属性
dataStruct
拉取的线索数据
展开子属性
extraStruct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "clue_data": [ { "advertiser_name": "xxx", "clue_owner_name": "xxx", "leads_page": 1, "address": "xxx", "flow_type": 1, "tool_id": "xxx", "clue_type": 2, "county_name": "xxx", "follow_life_account_id": "123456", "tags": [ "xxx", "yyy" ], "city_name": "xxx", "remark_dict": "{\"您的意向\":\"xxx\"}", "action_type": 0, "age": 0, "clue_id": "123456", "create_time_detail": "2024-04-21 12:00:00", "follow_life_account_type": 20, "modify_time": "2024-04-21 12:00:00", "product_name": "xxx", "province_name": "xxx", "system_tags": [ "xxx", "yyy" ], "allocation_status": 1, "content_id": "xxx", "follow_life_account_name": "xxx", "follow_state_name": 1, "promotion_name": "xxx", "remark": "xxx", "req_id": "xxx", "telephone": "xxxx", "advertiser_id": "123456", "name": "未命名", "order_id": 12345, "effective_state": 0, "gender": 0, "promotion_id": 12345, "root_life_account_id": "123456", "staff_douyin_id": "xxx", "staff_nickname": "xxx", "author_douyin_id": "xxx", "author_nickname": "xxx", "author_role": "商家", "follow_poi_id": "1234", "order_status": "交易成功" } ], "page": { "page_number": 1, "page_size": 100, "page_total": 1, "total": 2 }, "error_code": 0, "description": "success" }, "extra": { "error_code": 0, "description": "success", "sub_error_code": 0, "sub_description": "", "logid": "202405171211253981D55A8AE118A249E0", "now": 1715919086 } }
切换单列布局错误码
| 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 | 以实际错误信息为准 |
