# 获取账号收集的留资数量

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：getfinderliveleadsdata

通过该接口可获取账号收集的留资数量

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/finderlive/get_finder_live_leads_data?access_token=ACCESS_TOKEN

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：160
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
start_time	number	是	查询范围的开始时间（与用户留资时间对比）
end_time	number	是	查询范围的结束时间（与用户留资时间对比）
source_type	number	否	来源类型，枚举值详情请参考下文

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息
item	objarray	留资详情

# Res.item(Array) `Object Payload`

留资详情

参数名	类型	说明
component_type	number	组件类型，枚举值详情请参考下文
traffic_type	number	流量来源，枚举值详情请参考下文
leads_count	number	留资条数

# 4. 注意事项

该接口只统计2023.9.13号起的数据，所以start_time应大于等于1694534400

source_type来源类型

枚举值	描述
0	直播

component_type组件类型

枚举值	描述
0	表单
1	企微名片
2	企微客服

traffic_type流量来源

枚举值	描述
0	自然流量
1	广告流量

# 5. 代码示例

请求示例

{
    "start_time": 1694142436,
    "end_time": 1694228836,
    "source_type": 0
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "item": [
        {
            "component_type": 0,
            "traffic_type": 0,
            "leads_count": 1000
        },
        {
            "component_type": 0,
            "traffic_type": 1,
            "leads_count": 1000
        },
        {
            "component_type": 1,
            "traffic_type": 0,
            "leads_count": 1000
        },
        {
            "component_type": 1,
            "traffic_type": 1,
            "leads_count": 1000
        },
        {
            "component_type": 2,
            "traffic_type": 0,
            "leads_count": 1000
        },
        {
            "component_type": 2,
            "traffic_type": 1,
            "leads_count": 1000
        }
    ]
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述
-2	请求的参数错误
1	请求的信息不存在
48001	接口权限未开启，需前往视频号助手- 开放能力-开放场景打开开关
100000	没有权限访问

# 7. 适用范围

本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明，均不可调用。