# 获取留资request_id列表详情
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getleadsrequestid
通过该接口可获取留资request_id列表详情。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/leads/get_leads_request_id?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:143
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| leads_component_id | string | 是 | 100234056 | 用于查询某个留资组件的直播列表对应的request_id列表信息 |
| last_buffer | string | 否 | EB4YAg | 顺序翻页,传入上次请求返回的last_buffer, 会从上次返回的结果往后翻一页 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| item | objarray | 直播功能 |
| last_buffer | string | 本次翻页的上下文,用于顺序翻页请求 |
| continue_flag | boolean | 是否还有留资信息 |
# Res.item(Array) Object Payload
直播功能
| 参数名 | 类型 | 说明 |
|---|---|---|
| request_id | string | 某一场直播对应的留资信息请求id |
| live_start_time | number | 直播开始时间 |
| live_description | string | 直播描述 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"leads_component_id": "100234056",
"last_buffer": "EB4YAg"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"item": [
{
"request_id": "18881222222",
"live_start_time": 1668676968,
"live_description": "xxx的直播"
}
],
"last_buffer": "EB4YAg=",
"continue_flag": true
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -2 | 请求的参数错误 | |
| 1 | 请求的信息不存在 | |
| 48001 | 接口权限未开启,需前往视频号助手- 开放能力-开放场景 打开开关 | |
| 100000 | 没有权限访问 |
# 7. 适用范围
本接口支持「视频号助手」账号类型调用。其他账号类型如无特殊说明,均不可调用。