# 获取已发布的消息列表

调试工具

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

接口英文名:freepublish_batchget

本接口用于获取已成功发布的消息列表

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/freepublish/batchget?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

参数名类型必填示例说明
offsetnumber0从全部素材的该偏移位置开始返回,0表示从第一个素材返回
countnumber10返回素材的数量,取值在1到20之间
no_contentnumber01 表示不返回content字段,0表示正常返回,默认为0

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
total_countnumber成功发布素材的总数
item_countnumber本次调用获取的素材的数量
itemobjarray图文消息条目列表

# Res.item(Array) Object Payload

图文消息条目列表

参数名类型说明
article_idstring成功发布的图文消息id
contentobject图文消息内容
update_timenumber图文消息更新时间

# Res.item(Array).content Object Payload

图文消息内容

参数名类型说明
news_itemobjarray图文内容列表

# Res.item(Array).content.news_itemObject Payload

图文内容列表

参数名类型说明
titlestring标题
authorstring作者
digeststring图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。如果本字段为没有填写,则默认抓取正文前54个字。
contentstring图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS,涉及图片url必须来源 "上传图文消息内的图片获取URL"接口获取。外部图片url将被过滤。 图片消息则仅支持纯文本和部分特殊功能标签如商品,商品个数不可超过50个
content_source_urlstring图文消息的原文地址,即点击“阅读原文”后的URL
thumb_media_idstring图文消息的封面图片素材id(必须是永久MediaID)
thumb_urlstring图文消息的封面图片URL
need_open_commentnumber是否打开评论,0不打开(默认),1打开
only_fans_can_commentnumber是否粉丝才可评论,0所有人可评论(默认),1粉丝才可评论
urlstring草稿的临时链接
is_deletedboolean该图文是否被删除

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "offset": 0,
  "count": 10,
  "no_content": 0
}

返回示例

{
  "total_count": 100,
  "item_count": 10,
  "item": [
    {
      "article_id": "ARTICLE_ID_1",
      "content": {
        "news_item": [
          {
            "title": "示例标题",
            "author": "作者名",
            "digest": "摘要内容",
            "content": "HTML内容",
            "content_source_url": "https://example.com/source",
            "thumb_media_id": "MEDIA_ID_123",
            "show_cover_pic": 1,
            "need_open_comment": 0,
            "only_fans_can_comment": 0,
            "url": "https://example.com/article",
            "is_deleted": false
          }
        ]
      },
      "update_time": 1627891234
    }
  ]
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
0okok是指从不正常变成正常 in a normal state是指本来就正常
48001api unauthorizedapi 功能未授权,请确认公众号/服务号已获得该接口,可以在「公众平台官网 - 开发者中心页」中查看接口权限

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
  • ✔:该账号可调用此接口
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;