绑定的视频号 API
用公众号原始 ID(gh_ 开头)查询它绑定的视频号,每条返回视频号 ID 和昵称。
查询一个公众号绑定了哪些视频号。必填公众号原始 ID gh_id(gh_ 开头)。返回列表,每条是视频号 ID 和昵称。
没有绑定视频号时列表为空。拿到视频号 ID 后,再解析账号或拉作品。
请求地址 POST https://www.xmedi.cn/api/v1/wechat/accounts/channels。调用成功才扣费,参数错误、平台侧失败或超时不扣费。
成功响应的 meta 含数据血缘,说明见 鉴权与计费。
适用场景
- 矩阵:从公众号名单找出对应的视频号。
- 建档:把 gh_id 和视频号 ID 做成对照表。
- 排查:确认某个公众号是否还绑着视频号。
请求参数
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
account_id |
string | 否 | 公众号原始 ID(gh_ 开头);不支持 __biz / 微信号 / 名称 |
gh_id |
string | 否 | 必填。公众号原始 ID,以 gh_ 开头。不是微信号,也不是 biz。 |
返回 data 字段
| 字段 | 类型 | 说明 |
|---|---|---|
items | array<object> | 绑定的视频号。每条含 channel_id 和 nickname。没有绑定时为空数组。 |
调用示例
curl -X POST https://www.xmedi.cn/api/v1/wechat/accounts/channels \
-H "X-XMEDI-Key: xm_live_xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"gh_id":"gh_363b924965e9"}'
返回示例
以下为 data 的字段结构示意,实际取值以调用结果为准。
{
"items": [
{
"channel_id": "sphEXAMPLE",
"nickname": "示例视频号"
}
]
}
注意事项
- gh_id 可用「按名称搜号(含 gh)」获取。
- 本接口不返回视频号作品。
常见错误码
| code | error_code | 含义与处理 |
|---|---|---|
| 40001 | VALIDATION_ERROR | 参数校验失败,按返回提示修改请求,不扣费 |
| 40100 | UNAUTHORIZED | API Key 缺失、错误或已吊销,到控制台检查 Key |
| 40200 | INSUFFICIENT_BALANCE | 余额不足,充值后重试 |
| 42900 | RATE_LIMITED | 超过每分钟 30 次上限,稍后重试 |
| 50000 | INTERNAL_ERROR | 服务异常,可稍后重试,不扣费 |
| 50300 | NOT_AVAILABLE | 接口暂不可用,不扣费 |
常见问题
- 能用公众号名称查吗?
- 不能。必须是 gh_ 开头的原始 ID。
- channel_id 和作品 ID 一样吗?
- 不一样。channel_id 是视频号账号。作品 ID 来自作品列表或分享短链解析。
- 调用失败会扣费吗?
- gh_id 格式不对不扣费。成功但没有绑定视频号,按成功调用计费。
相关接口
需要接入这个接口?
免费注册
注册后创建 API Key,或留下联系方式获取方案