视频号合集列表 API
用视频号 finder username 拉合集,返回合集 ID、标题、封面和作品数。
用视频号的 finder username 拉取该号的合集。channel_id 形如 v2_…@finder。每条返回合集 topic_id、标题、简介、封面和作品数。
要合集里的视频时,把 topic_id 交给合集作品。
请求地址 POST https://www.xmedi.cn/api/v1/wechat/channels/collections。调用成功才扣费,参数错误、平台侧失败或超时不扣费。
成功响应的 meta 含数据血缘,说明见 鉴权与计费。
适用场景
- 栏目:先列出一个号有哪些合集。
- 计数:用 feed_count 看哪个合集更长,再决定拉取。
- 跳转:只把 topic_id 传给合集作品,不要传标题。
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
channel_id |
string | 是 | 视频号 finder username(v2_…@finder)。必填。 |
返回 data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
has_more | boolean | 是否还有下一页。为 false 时停止翻页。 |
items | array<object> | 合集列表。每条含 topic_id、title、description、cover_url、feed_count。 |
page | number | 页码,从 1 起。只认游标的接口里它是回显,改它不会换页。 |
page_size | number | 本页条数。平台不按请求条数返回时,以实际条数为准。 |
total | number | 总条数。平台没给总数时为 0,以 items 为准。 |
调用示例
curl -X POST https://www.xmedi.cn/api/v1/wechat/channels/collections \
-H "X-XMEDI-Key: xm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"channel_id":"v2_060000231003b20faec8c6e4811dc1d4c602ee30b0771bbcf220c67926bb76ab7702ac335a53@finder"}'
返回示例
以下为 data 的字段结构示意,实际取值以调用结果为准。
{
"has_more": false,
"items": [
{
"cover_url": "https://example.com/cover.jpg",
"description": "示例简介",
"feed_count": 8,
"title": "示例合集",
"topic_id": "col1"
}
],
"page": 1,
"page_size": 20,
"total": 1
}
注意事项
- channel_id 是 finder username,不是视频号昵称。昵称要先换成这个 ID。
- 没有合集时成功返回空列表,仍会计费。
常见错误码
| code | error_code | 含义与处理 |
|---|---|---|
| 40001 | VALIDATION_ERROR | 参数校验失败,按返回提示修改请求,不扣费 |
| 40100 | UNAUTHORIZED | API Key 缺失、错误或已吊销,到控制台检查 Key |
| 40200 | INSUFFICIENT_BALANCE | 余额不足,充值后重试 |
| 42900 | RATE_LIMITED | 超过每分钟 60 次上限,稍后重试 |
| 50000 | INTERNAL_ERROR | 服务异常,可稍后重试,不扣费 |
| 50300 | NOT_AVAILABLE | 接口暂不可用,不扣费 |
常见问题
- channel_id 从哪来?
- 视频号账号资料或既有作品上的 finder username,形如 v2_ 开头、以 @finder 结尾。
- 能直接给出每个视频吗?
- 不能。本接口只到合集。视频用合集作品,入参是 topic_id。
- 调用失败会扣费吗?
- 只有调用成功才扣费。参数错误、对象不存在或取数失败不扣费。
相关接口
需要接入这个接口?
免费注册
注册后创建 API Key,或留下联系方式获取方案