视频号
取消
中文
中文
EN
取消
  • 介绍

    • # 按时间获取留资信息详情

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

    接口英文名：getleadsinfobycomponentid

    通过该接口可按时间获取留资信息详情。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/channels/leads/get_leads_info_by_component_id?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：143

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    leads_component_idstring是用于查询某个留资组件某段时间内收集的留资信息
    start_timenumber否开始时间
    end_timenumber否结束时间
    last_bufferstring否顺序翻页，传入上次请求返回的last_buffer, 会从上次返回的结果往后翻一页
    versionnumber是接口版本号

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    user_dataarray用户留资信息列表
    last_bufferstring本次翻页的上下文，用于顺序翻页请求
    continue_flagboolean是否还有留资信息

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {
    "leads_component_id": "100234056999000000",
    "start_time": 0,
    "end_time": 1668676968,
    "last_buffer": "EB4YAg",
    "version": 1
}

    返回示例

    {
    "errcode": 0,
    "errmsg": "ok",
    "user_data": [
        {
            "anchor_nickname": "xxx",
            "live_start_time": 1684218352,
            "leads_data": [
                {
                    "title": "姓名",
                    "value": "小明"
                },
                {
                    "title": "手机号",
                    "value": "11111111111"
                }   
            ]
        }
    ],
    "last_buffer": "EB4YAg=",
    "continue_flag": true
}

    # 6. 错误码

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

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

    # 7. 适用范围

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