# 获取草稿列表

调试工具

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

接口英文名:draft_batchget

新增草稿之后,可用本接口获取草稿列表信息。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用

# 第三方调用

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

  • 该接口所属的权限集 id 为:11、100

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

# 2. 请求参数

# 查询参数 Query String parameters

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

# 请求体 Request Payload

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

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
total_countnumber草稿素材的总数
item_countnumber本次调用获取的素材的数量
itemobjarray素材列表

# Res.item(Array) Object Payload

素材列表

参数名类型说明
media_idstring图文消息的id
contentobject图文消息内容
update_timenumber图文消息更新时间

# Res.item(Array).content Object Payload

图文消息内容

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

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

图文内容列表

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

# Res.item(Array).content.news_item.image_info Object Payload

图片消息里的图片相关信息,图片数量最多为20张,首张图片即为封面图

参数名类型说明
image_listobjarray图片列表

# Res.item(Array).content.news_item.image_info.image_listObject Payload

图片列表

参数名类型说明
image_media_idstring图片消息里的图片素材id(必须是永久MediaID)

# Res.item(Array).content.news_item.product_info Object Payload

商品信息

参数名类型说明
footer_product_infoobject文末插入商品相关信息

文末插入商品相关信息

参数名类型说明
product_keystring商品key

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

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

返回示例

{
    "total_count":TOTAL_COUNT,
    "item_count":ITEM_COUNT,
    "item":[
        {
            "media_id":MEDIA_ID,
            "content": {
                "news_item" : [
                    {
                        "article_type":"news",
                        "title":TITLE,
                        "author":AUTHOR,
                        "digest":DIGEST,
                        "content":CONTENT,
                        "content_source_url":CONTENT_SOURCE_URL,
                        "thumb_media_id":THUMB_MEDIA_ID,
                        "need_open_comment":0,
                        "only_fans_can_comment":0,
                        "url":URL
                    },
                    {
                        "article_type":"newspic",
                        "title":TITLE,
                        "content":CONTENT,
                        "thumb_media_id":THUMB_MEDIA_ID,
                        "need_open_comment":0,
                        "only_fans_can_comment":0,
                        "image_info":{
                            "image_list":[
                                {
                                    "image_media_id":IMAGE_MEDIA_ID
                                }
                            ]
                        },
                        "product_info": {
                            "footer_product_info": {
                                "product_key":PRODUCT_KEY
                            }
                        },
                        "url":URL
                    }
                ]
            },
            "update_time": UPDATE_TIME
        }
    ]
}

# 6. 错误码

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

错误码错误描述解决方案
0成功ok是指从不正常变成正常 in a normal state是指本来就正常

# 7. 适用范围

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