抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • 生活服务商家应用 OpenAPI SDK 总览
  • 接入前准备
  • API接口
  • 通用接口
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 到综团购解决方案
  • 到综团购预约解决方案
  • 综合到店提货解决方案
  • 线索管理解决方案
  • 丽人/汽车/家居家电交易上翻解决方案
  • 买单收银
  • 国补报销
  • 上翻激励归因
  • 订单归因查询
  • 线索归因查询
  • 能力
  • 历史版本文档(不推荐)
  • 接口说明

    1. 服务商/商家通过接口查询线索上翻激励流量效果详情,支持两种查询方式:
      1. 根据线索 ID 查询对应上翻激励流量效果详情,入参:线索 IDs(查询数量限制最大50个)、商户 id;
      2. 根据商户 ID查询指定时间内该商户下的上翻激励流量效果详情,入参:商户 ID、线索创建起始时间、线索创建结束时间;
    2. 只支持查询2024-11-01至前一天的数据
    3. 线索ID和线索创建起始时间、线索创建结束时间必须传一个
      1. 方式一:一批线索ID
      2. 方式二:线索创建起始时间、线索创建结束时间,线索创建结束时间减去线索创建开始时间不能超过31天
    4. 查询指定时间的时候,必须分页(page_num和page_size参数)
    5. 如果两种方式的参数都传,会优先选择方式一进行查询

    使用限制

    SLA:支持的最大QPS:100;PCT99承诺值:1000ms;

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/goodlife/v1/homed/trade/cluesource/query/
    HTTP Method
    POST
    Scope
    life.capacity.homed.trade.cluesource.query
    权限要求
    • 开发者需要申请权限:家装线索行业化信息
      • 开放平台路径:抖音开放平台 > 控制台 > 应用详情 > 解决方案
      • 商家授权路径:抖音来客 > 店铺管理 > 第三方应用授权

    请求参数

    请求头
    access-token必填String
    示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
    content-type必填String
    固定值"application/json"
    Rpc-Transit-Life-AccountString

    来客商户根账户ID

    Body
    account_id必填String
    商户id
    clue_end_timeInt64
    线索创建结束时间(秒时间戳,线索创建起止时间必须同时传入)
    clue_idsArray<String>

    抖音生活服务一批线索ID

    校验:数量最大50个

    clue_start_timeInt64
    线索创建起始时间 (秒时间戳,线索创建起止时间必须同时传入)
    page_numInt32
    第几页(首页传1)
    page_sizeInt32
    页大小,取值范围1~100
    请求示例
    curl --location --request POST 'https://open.douyin.com/goodlife/v1/homed/trade/cluesource/query/' \ --header 'access-token: 0801121846735352506a356a6' \ --header 'content-type: application/json' \ --data '{"account_id":"WfaCm8qFf9","clue_ids":["nRkUHSW7Fv"],"clue_start_time":870986922799003749,"clue_end_time":341839857821584595,"page_num":3408327141025441426,"page_size":6199235483180464621}'

    响应参数

    Body展开全部子属性
    extra必填Struct
    扩展信息
    展开子属性
    dataStruct

    -

    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202505281556015AF9F2949C08B4949661", "now": 1748418968 }, "data": { "clues": [ { "video_incentive_traffic": 1577832994469026800, "live_incentive_traffic": 6446798877885875000, "clue_id": "A5seYAeWNW" } ], "page": { "total": 6755286130586883000, "page_num": 6185273864268803000, "page_size": 8585839843949423000 }, "search_after": { "all_cursor": [ [ "wWPkuafGUO" ] ], "size": 3685757838675784000, "cursor": [ "dP52VkCPzT" ] }, "error_code": 0, "description": "" } }
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2002100001
    未知错误
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100004
    系统繁忙,此时请开发者稍候再试
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100005
    参数不合法
    更换参数
    2002119001
    参数不合法
    更换参数
    2002119002
    系统繁忙,请稍候再试
    重试
    2002119003
    请求太过频繁,请稍后再试
    重试
    2002119005
    应用未获商家授权
    联系合作商家在商家后台发起授权,并在服务商后台同意授权
    2002119010
    接口已下线
    接口已下线
    2002190002
    access_token无效
    调用接口重新生成access_token
    2002190004
    应用未获得该能力, 请去https://open.douyin.com/申请
    应用申请接口权限
    2002190008
    access_token过期,请刷新或重新授权
    规范token刷新机制,检查是否有测试环境在同步刷新token
    2003000001
    根据实际业务错误返回
    对照接口文档规范参数并重试
    2005000001
    根据实际业务错误返回
    联系抖音处理
    2005000001
    系统错误,请重试
    多次重试失败请联系抖音处理
    2003000001
    以实际错误信息为准
    详见错误描述信息
    2005000001
    系统错误,请重试
    多次重试失败请联系抖音处理