WeChat-Media-Platform-V2-API

获取公众号关联文章/Get WeChat MP Related Articles

Changed on

[中文]

用途:

  • 传文章 URL,返回文章底部「关联 / 相关文章」。未开启该功能的文章返回空列表。
  • 价格:0.01$/次
  • ⏱️ 由于微信服务器原因,本接口响应较慢,请将客户端请求超时(timeout)设置为 30 秒;timeout 设置过小会造成已扣费但收不到响应的情况。

参数:

  • url: 公众号文章链接(长 / 短链均可)。示例 https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw(该文未开启关联文章,返回空)
  • raw: 可选,默认 True。True=完整原始响应;False=精简投影。

返回:

  • 关联文章列表

响应结构与 JSON Path:

raw=false(精简投影):

  • data 为拍平后的三字段:
    • $.data.ret: 返回码(0 正常)
    • $.data.count: 关联文章条数
    • $.data.articles[]: 关联文章列表(命中任一来源列表的合并;空文章为 [])

raw=true(原始):

  • data 为完整原始响应:
    • $.data.article_size: 关联文章数量(对应精简模式 count)
    • $.data.list[]: 关联文章原始列表(对应精简模式 articles)
    • $.data.base_resp.ret: 返回码(对应精简模式 ret);base_resp.exportkey_token: 导出 token
    • $.data.empty_scene: 空结果场景码;$.data.show_rec_reason: 是否展示推荐理由;$.data.report_info: 上报信息(JSON 串)

[English]

Purpose:

  • Pass an article URL to get the "related articles" at the bottom of the article. Articles without this feature return an empty list.
  • Price: $0.01 per request
  • ⏱️ Due to WeChat server latency, this endpoint responds slowly; please set your client request timeout to 30 seconds — a timeout that is too small may result in being billed without receiving the response.

Parameters:

  • url: WeChat MP article URL (long or short form). E.g. https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw (this article has related articles disabled, returns empty)
  • raw: Optional, default True. True=full raw response; False=simplified projection.

Return:

  • Related article list

Response structure & JSON Path:

raw=false (simplified projection):

  • data is flattened into three fields:
    • $.data.ret: return code (0 = OK)
    • $.data.count: number of related articles
    • $.data.articles[]: related article list (merged from whichever source list hits; [] when empty)

raw=true (raw):

  • data is the full raw response:
    • $.data.article_size: number of related articles (corresponds to count in simplified mode)
    • $.data.list[]: raw related article list (corresponds to articles in simplified mode)
    • $.data.base_resp.ret: return code (corresponds to ret in simplified mode); base_resp.exportkey_token: export token
    • $.data.empty_scene: empty-result scene code; $.data.show_rec_reason: whether to show recommendation reason; $.data.report_info: report info (JSON string)
post/api/v1/wechat_mp/v2/fetch_related_articles

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

urlstring required

公众号文章链接(https://mp.weixin.qq.com/s/… 或带 __biz 的长链)/WeChat MP article URL (https://mp.weixin.qq.com/s/… or long URL with __biz)

rawboolean

True=原始响应;False=精简解析结构/True=raw response; False=simplified parsed structure

Example request

{
  "url": "https://mp.weixin.qq.com/s/TSNQKkRpN1qbKsT7BvzqIw"
}

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes