线索查询
接口说明
由于线索落入有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_idArray<String>
跟进子账户,不是门店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/?life_account_id=[CQzFAScv1g]&page=7255477104827504569&page_size=4989812264690215792&account_id=CqyrvkW4jd&start_time=C2N2Vq5IL2&end_time=cXVAX5hssC' \ --header 'x-mock-uid: WCM1E2QiyX' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
拉取的线索数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "clue_data": [ { "follow_life_account_type": 474246007436516160, "action_type": 886084928281826800, "staff_nickname": "YSBOBOamhS", "req_id": "c24WVzUlgw", "author_role": "pDIbdJNmcH", "modify_time": "nfIS3Kg8hW", "advertiser_name": "Ex3o6MBalb", "tel_addr": "5jwpXyGgKW", "clue_owner_name": "axvkFXUayh", "name": "hbkfsG7ecS", "follow_poi_id": "4Arxz6yeDZ", "video_id": 3727440829229235000, "flow_entrance": 2873943988503745000, "telephone": "kQoXCsB1G6", "age": 7168116165968954000, "product_name": "CehE778wUg", "flow_type": 3113957487260403700, "follow_life_account_name": "oTllOWnljD", "staff_douyin_id": "awg9QjQ1To", "promotion_name": "peIWFEE11N", "province_name": "bFy4SyEseU", "advertiser_id": "zLa5C5fDEe", "order_id": 4812557799575435000, "create_time_detail": "hpRtzeCSXz", "remark_dict": "kR64R6rUiB", "root_life_account_id": "yOeX60pE8v", "clue_type": 5308984326439249000, "county_name": "gWgoo2XZnU", "ad_id": 8188623404852700000, "follow_life_account_id": "JybWK3qdLl", "weixin": "211GgOGd1r", "image_id": 4738908423497116000, "auto_province_name": "wZEWGtKqvS", "address": "WtLTM7mfH0", "promotion_id": 8767265748207135000, "intention_poi_id": "IbLGTFrIzB", "title_id": 1748765248673870300, "system_tags": [ "cH7AlLLxaT" ], "effective_state": 4445908767375533600, "content_id": "pJlmJKSjS9", "tags": [ "jU0eMHfECb" ], "staff_commerce_nickname": "9FxU7KR1uT", "intention_life_account_name": "ja6NdiC36q", "is_private_clue": 5220225771383423000, "follow_state_name": 4649225960520998000, "gender": 8452771956946892000, "city_name": "Tzx3gnYvJh", "author_nickname": "PDS0cz5Sv1", "clue_id": "vVP13gJxQQ", "auto_city_name": "AKHI6j3ZND", "remark": "zJbOKLmNyM", "leads_page": 1319492196887509200, "product_id": "kqlKa13Ijb", "author_douyin_id": "XkKbkC4A3d", "tool_id": "rv5d13JIFP", "source_craftsman_douyin_id": "kECUKZbRmq", "order_status": "TeQr0nAEnn", "source_craftsman_nickname": "mu40AYpKzW", "allocation_status": 2992970052259655000, "product_type": 8618805693918957000, "poi_name": "bxIMAxQ62O" } ], "page": { "total": 9053288658539681000, "page_size": 1176477317226036500, "page_number": 2712102438846204000, "page_total": 9010780994297243000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250516113437329982A8D5DBA82AC2C8", "now": 1747366477 } }
错误码
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 | 请求太过频繁,请稍后再试 |