线索查询
接口说明
由于线索落入有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
open_idString
接口需要用户授权,必传;否则不传
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/open_api/crm/clue/query/?open_id=LO9rDwjipR&life_account_id=[xdHUVYKlf4]&page_size=3293466204805742901&end_time=O9OnJKZReH&account_id=yNDSSOQFqK&page=8671664443350477982&start_time=rigSFyqVFk' \ --header 'x-mock-uid: 45Hk0syOjY' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
拉取的线索数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "clue_data": [ { "staff_douyin_id": "sXWepqZcJX", "business": "56vNzMatPw", "video_id": 4772544826027829000, "advertiser_name": "fpIu7fIocZ", "auto_city_name": "yokMvLIszk", "product_type": 5927733511427729000, "qcpx_ticket_info": "eoFcHKlEmV", "effective_state": 6924678835142930000, "advertiser_id": "7wUGqhp7yj", "weixin": "JjbTDNq2Gd", "content_id": "GXhYcXDwmt", "intention_poi_id": "ma4YiTrhj6", "staff_nickname": "AFrBOHzhJE", "poi_name": "XLxeRYH74g", "follow_life_account_id": "Y1Wyld447c", "product_id": "KVdiw3TxfE", "tool_id": "FXpiG4tL1C", "flow_type": 2661520506690052600, "follow_life_account_type": 7651079981395208000, "author_douyin_id": "r2EhyxzuWP", "order_id": 3275720461808633000, "follow_life_account_name": "jKPrzGESxG", "leads_page": 3707764513890078000, "tags": [ "9glRLms82E" ], "ad_type": 568839008190675400, "action_type": 1188023166681277200, "tel_addr": "ZKkJGJipUY", "system_tags": [ "RMgllDKqgl" ], "qcpx_ticket_status": 4048057774844963000, "follow_poi_id": "WPkFfokdVi", "req_id": "lwaG1eaFKU", "country_name": "SonbyWbcx3", "county_name": "lzR78S0UnB", "clue_type": 5488523771681063000, "staff_commerce_nickname": "aurEqEXu22", "promotion_id": 5437154310199075000, "clue_id": "eBRIsRLpcG", "is_private_clue": 4391282179947762000, "name": "O2P2Alqngh", "intention_life_account_name": "5Ea2D3dL81", "search_bid_word": "i5wxBCNfG2", "root_life_account_id": "uXbav2g93p", "product_name": "VgrPAUWMBN", "follow_state_name": 2502666050064604700, "auto_province_name": "054hgrBDxk", "order_status": "v8n8hvuo88", "allocation_status": 7135338511596609000, "create_time_detail": "ylR6wd3igD", "author_nickname": "5nP3a1MCyU", "clue_intention": "xPDXtDiLht", "title_id": 5954189752277610000, "promotion_name": "gJpfbaoPhg", "remark_dict": "17tkfKXg96", "ext_info": "dTNosn6UvG", "flow_entrance": 4731491085321434000, "province_name": "euwnizsM5E", "city_name": "qUIUmT0wem", "image_id": 2753049322159581000, "telephone": "YhcsBz75oF", "remark": "92cIAYq1Zz", "modify_time": "qfheRuvVbJ", "address": "cgSDBRQbSD", "convert_status": 7070961002102389000, "author_role": "btlK6qUptE", "gender": 2476638931240046600, "ad_id": 3755285824120974300, "source_craftsman_nickname": "ubC0epWLTs", "age": 1623477945108758300, "clue_owner_name": "tE1UCoupPN", "source_craftsman_douyin_id": "zhfFoQNm5N" } ], "page": { "total": 4273134718981979000, "page_size": 7757434570217385000, "page_number": 4285674424947991000, "page_total": 6575685822598258000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202512051602289710C506365CA23C8030", "now": 1764921751 } }
错误码
| 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 | 请求太过频繁,请稍后再试 |
