# 获取留资组件Id列表详情

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

接口英文名:getleadscomponentid

通过该接口可获取留资组件ld列表详情。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
last_bufferstring顺序翻页,传入上次请求返回的last_buffer, 会从上次返回的结果往后翻一页

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
itemobjarray留资组件
last_bufferstring本次翻页的上下文,用于顺序翻页请求
continue_flagboolean是否还有留资组件Id

# Res.item(Array) Object Payload

留资组件

参数名类型说明
leads_component_idstring留资组件id
leads_descriptionstring留资组件标题
statusnumber留资组件状态码,枚举值详情请参考下文

# 4. 注意事项

status留资组件状态码

状态码 状态类型
1 未提交
2 提交等待结果
3 未通过审核
4 审核通过
5 已删除

# 5. 代码示例

请求示例

{
    "last_buffer": "EB4YAg"
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "item": [
        {
            "leads_component_id": "18881222222",
            "leads_description": "xxx的直播",
            "status": 4
        }
    ],
    "last_buffer": "EB4YAg=",
    "continue_flag": true
}

# 6. 错误码

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

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

# 7. 适用范围

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